Microsoft Azure certificates(thumbprintAlgorithm={thumbprintAlgorithm},thumbprint={thumbprint}) API

openapi: 3.2.0
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector certificates(thumbprintAlgorithm={thumbprintAlgorithm},thumbprint={thumbprint}) Certificates(thumbprint Algorithm={thumbprint Algorithm},thumbprint={thumbprint}) API
tags:
- name: certificates(thumbprintAlgorithm={thumbprintAlgorithm},thumbprint={thumbprint})
paths:
  /certificates(thumbprintAlgorithm={thumbprintAlgorithm},thumbprint={thumbprint}):
    get:
      operationId: microsoftAzureBatchGetcertificate
      description: Gets information about the specified Certificate.
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: timeOut
        in: query
        description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
        required: false
        schema:
          type: integer
          format: int32
          default: 30
      - name: client-request-id
        in: header
        description: 'The caller-generated request identity, in the form of a GUID with no decoration

          such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.'
        required: false
        x-ms-client-name: clientRequestId
        schema:
          type: string
      - name: return-client-request-id
        in: header
        description: Whether the server should return the client-request-id in the response.
        required: false
        x-ms-client-name: returnClientRequestId
        schema:
          type: boolean
          default: false
      - name: ocp-date
        in: header
        description: 'The time the request was issued. Client libraries typically set this to the

          current system clock time; set it explicitly if you are calling the REST API

          directly.'
        required: false
        x-ms-client-name: ocpdate
        schema:
          type: string
          format: date-time-rfc7231
      - name: thumbprintAlgorithm
        in: path
        description: The algorithm used to derive the thumbprint parameter. This must be sha1.
        required: true
        schema:
          type: string
      - name: thumbprint
        in: path
        description: The thumbprint of the Certificate to get.
        required: true
        schema:
          type: string
      - name: $select
        in: query
        description: An OData $select clause.
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: The request has succeeded.
          headers:
            ETag:
              description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.
              schema:
                type: string
            Last-Modified:
              description: The time at which the resource was last modified.
              schema:
                type: string
                format: date-time-rfc7231
            client-request-id:
              description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.
              schema:
                type: string
            request-id:
              description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchCertificate'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchError'
      deprecated: true
      x-ms-examples:
        Certificate get:
          $ref: ./examples/CertificateGet.json
      summary: Microsoft Azure Get Certificates Thumbprintalgorithm Thumbprintalgorithm,thumbprint Thumbprint
      tags:
      - certificates(thumbprintAlgorithm={thumbprintAlgorithm},thumbprint={thumbprint})
    delete:
      operationId: microsoftAzureBatchDeletecertificate
      summary: Microsoft Azure Deletes A Certificate From The Specified Account
      description: You cannot delete a Certificate if a resource (Pool or Compute Node) is using<br>it. Before you can delete a Certificate, you must therefore make sure that the<br>Certificate is not associated with any existing Pools, the Certificate is not<br>installed on any Nodes (even if you remove a Certificate from a Pool, it is not<br>removed from existing Compute Nodes in that Pool until they restart), and no<br>running Tasks depend on the Certificate. If you try to delete a Certificate<br>that is in use, the deletion fails. The Certificate status changes to<br>deleteFailed. You can use Cancel Delete Certificate to set the status back to<br>active if you decide that you want to continue using the Certificate.
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: timeOut
        in: query
        description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
        required: false
        schema:
          type: integer
          format: int32
          default: 30
      - name: client-request-id
        in: header
        description: 'The caller-generated request identity, in the form of a GUID with no decoration

          such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.'
        required: false
        x-ms-client-name: clientRequestId
        schema:
          type: string
      - name: return-client-request-id
        in: header
        description: Whether the server should return the client-request-id in the response.
        required: false
        x-ms-client-name: returnClientRequestId
        schema:
          type: boolean
          default: false
      - name: ocp-date
        in: header
        description: 'The time the request was issued. Client libraries typically set this to the

          current system clock time; set it explicitly if you are calling the REST API

          directly.'
        required: false
        x-ms-client-name: ocpdate
        schema:
          type: string
          format: date-time-rfc7231
      - name: thumbprintAlgorithm
        in: path
        description: The algorithm used to derive the thumbprint parameter. This must be sha1.
        required: true
        schema:
          type: string
      - name: thumbprint
        in: path
        description: The thumbprint of the Certificate to be deleted.
        required: true
        schema:
          type: string
      responses:
        '202':
          description: The request has been accepted for processing, but processing has not yet completed.
          headers:
            ETag:
              description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.
              schema:
                type: string
            Last-Modified:
              description: The time at which the resource was last modified.
              schema:
                type: string
                format: date-time-rfc7231
            client-request-id:
              description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.
              schema:
                type: string
            request-id:
              description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.
              schema:
                type: string
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchError'
      deprecated: true
      x-ms-examples:
        Certificate delete:
          $ref: ./examples/CertificateDelete.json
      tags:
      - certificates(thumbprintAlgorithm={thumbprintAlgorithm},thumbprint={thumbprint})
  /certificates(thumbprintAlgorithm={thumbprintAlgorithm},thumbprint={thumbprint})/canceldelete:
    post:
      operationId: microsoftAzureBatchCancelcertificatedeletion
      summary: Microsoft Azure Cancels A Failed Deletion Of A Certificate From The Specified Account
      description: If you try to delete a Certificate that is being used by a Pool or Compute<br>Node, the status of the Certificate changes to deleteFailed. If you decide that<br>you want to continue using the Certificate, you can use this operation to set<br>the status of the Certificate back to active. If you intend to delete the<br>Certificate, you do not need to run this operation after the deletion failed.<br>You must make sure that the Certificate is not being used by any resources, and<br>then you can try again to delete the Certificate.
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: timeOut
        in: query
        description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
        required: false
        schema:
          type: integer
          format: int32
          default: 30
      - name: client-request-id
        in: header
        description: 'The caller-generated request identity, in the form of a GUID with no decoration

          such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.'
        required: false
        x-ms-client-name: clientRequestId
        schema:
          type: string
      - name: return-client-request-id
        in: header
        description: Whether the server should return the client-request-id in the response.
        required: false
        x-ms-client-name: returnClientRequestId
        schema:
          type: boolean
          default: false
      - name: ocp-date
        in: header
        description: 'The time the request was issued. Client libraries typically set this to the

          current system clock time; set it explicitly if you are calling the REST API

          directly.'
        required: false
        x-ms-client-name: ocpdate
        schema:
          type: string
          format: date-time-rfc7231
      - name: thumbprintAlgorithm
        in: path
        description: The algorithm used to derive the thumbprint parameter. This must be sha1.
        required: true
        schema:
          type: string
      - name: thumbprint
        in: path
        description: The thumbprint of the Certificate being deleted.
        required: true
        schema:
          type: string
      responses:
        '204':
          description: 'There is no content to send for this request, but the headers may be useful. '
          headers:
            DataServiceId:
              description: The OData ID of the resource to which the request applied.
              schema:
                type: string
            ETag:
              description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.
              schema:
                type: string
            Last-Modified:
              description: The time at which the resource was last modified.
              schema:
                type: string
                format: date-time-rfc7231
            client-request-id:
              description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.
              schema:
                type: string
            request-id:
              description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.
              schema:
                type: string
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchError'
      deprecated: true
      x-ms-examples:
        Certificate cancel delete:
          $ref: ./examples/CertificateCancelDelete.json
      tags:
      - certificates(thumbprintAlgorithm={thumbprintAlgorithm},thumbprint={thumbprint})
components:
  schemas:
    BatchCertificateFormat:
      type: string
      description: BatchCertificateFormat enums
      enum:
      - pfx
      - cer
      x-ms-enum:
        name: BatchCertificateFormat
        modelAsString: true
        values:
        - name: Pfx
          value: pfx
          description: The Certificate is a PFX (PKCS#12) formatted Certificate or Certificate chain.
        - name: Cer
          value: cer
          description: The Certificate is a base64-encoded X.509 Certificate.
    BatchErrorMessage:
      type: object
      description: An error message received in an Azure Batch error response.
      properties:
        lang:
          type: string
          description: The language code of the error message.
        value:
          type: string
          description: The text of the message.
    NameValuePair:
      type: object
      description: Represents a name-value pair.
      properties:
        name:
          type: string
          description: The name in the name-value pair.
        value:
          type: string
          description: The value in the name-value pair.
    BatchCertificateState:
      type: string
      description: BatchCertificateState enums
      enum:
      - active
      - deleting
      - deletefailed
      x-ms-enum:
        name: BatchCertificateState
        modelAsString: true
        values:
        - name: Active
          value: active
          description: The Certificate is available for use in Pools.
        - name: Deleting
          value: deleting
          description: The user has requested that the Certificate be deleted, but the delete operation has not yet completed. You may not reference the Certificate when creating or updating Pools.
        - name: DeleteFailed
          value: deletefailed
          description: The user requested that the Certificate be deleted, but there are Pools that still have references to the Certificate, or it is still installed on one or more Nodes. (The latter can occur if the Certificate has been removed from the Pool, but the Compute Node has not yet restarted. Compute Nodes refresh their Certificates only when they restart.) You may use the cancel Certificate delete operation to cancel the delete, or the delete Certificate operation to retry the delete.
    DeleteBatchCertificateError:
      type: object
      description: An error encountered by the Batch service when deleting a Certificate.
      properties:
        code:
          type: string
          description: An identifier for the Certificate deletion error. Codes are invariant and are intended to be consumed programmatically.
        message:
          type: string
          description: A message describing the Certificate deletion error, intended to be suitable for display in a user interface.
        values:
          type: array
          description: A list of additional error details related to the Certificate deletion error. This list includes details such as the active Pools and Compute Nodes referencing this Certificate. However, if a large number of resources reference the Certificate, the list contains only about the first hundred.
          items:
            $ref: '#/components/schemas/NameValuePair'
          x-ms-identifiers: []
    BatchErrorDetail:
      type: object
      description: An item of additional information included in an Azure Batch error response.
      properties:
        key:
          type: string
          description: An identifier specifying the meaning of the Value property.
        value:
          type: string
          description: The additional information included with the error response.
    BatchCertificate:
      type: object
      description: 'A Certificate that can be installed on Compute Nodes and can be used to

        authenticate operations on the machine.'
      properties:
        thumbprint:
          type: string
          description: The X.509 thumbprint of the Certificate. This is a sequence of up to 40 hex digits (it may include spaces but these are removed).
        thumbprintAlgorithm:
          type: string
          description: The algorithm used to derive the thumbprint. This must be sha1.
        url:
          type: string
          description: The URL of the Certificate.
          readOnly: true
        state:
          $ref: '#/components/schemas/BatchCertificateState'
          description: The state of the Certificate.
          readOnly: true
        stateTransitionTime:
          type: string
          format: date-time
          description: The time at which the Certificate entered its current state.
          readOnly: true
        previousState:
          $ref: '#/components/schemas/BatchCertificateState'
          description: The previous state of the Certificate. This property is not set if the Certificate is in its initial active state.
          readOnly: true
        previousStateTransitionTime:
          type: string
          format: date-time
          description: The time at which the Certificate entered its previous state. This property is not set if the Certificate is in its initial Active state.
          readOnly: true
        publicData:
          type: string
          description: The public part of the Certificate as a base-64 encoded .cer file.
          readOnly: true
        deleteCertificateError:
          $ref: '#/components/schemas/DeleteBatchCertificateError'
          description: The error that occurred on the last attempt to delete this Certificate. This property is set only if the Certificate is in the DeleteFailed state.
          readOnly: true
        data:
          type: string
          description: The base64-encoded contents of the Certificate. The maximum size is 10KB.
          x-ms-mutability:
          - create
        certificateFormat:
          $ref: '#/components/schemas/BatchCertificateFormat'
          description: The format of the Certificate data.
          x-ms-mutability:
          - create
        password:
          type: string
          description: The password to access the Certificate's private key. This must be omitted if the Certificate format is cer.
          x-ms-mutability:
          - create
      required:
      - thumbprint
      - thumbprintAlgorithm
      - data
    BatchError:
      type: object
      description: An error response received from the Azure Batch service.
      properties:
        code:
          type: string
          description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
        message:
          $ref: '#/components/schemas/BatchErrorMessage'
          description: A message describing the error, intended to be suitable for display in a user interface.
        values:
          type: array
          description: A collection of key-value pairs containing additional details about the error.
          items:
            $ref: '#/components/schemas/BatchErrorDetail'
          x-ms-identifiers: []
      required:
      - code
  parameters:
    Azure.Core.Foundations.ApiVersionParameter:
      name: api-version
      in: query
      description: The API version to use for this operation.
      required: true
      x-ms-parameter-location: method
      x-ms-client-name: apiVersion
      schema:
        type: string
        minLength: 1
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/components/parameters/Endpoint'