Microsoft Azure Certificates API

openapi: 3.2.0
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Certificates API
tags:
- name: Certificates
paths:
  /certificates:
    get:
      operationId: microsoftAzureBatchListcertificates
      summary: Microsoft Azure Lists All Of The Certificates That Have Been Added To The Specified Account
      description: Lists all of the Certificates that have been added to the specified Account.
      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: maxresults
        in: query
        description: 'The maximum number of items to return in the response. A maximum of 1000

          applications can be returned.'
        required: false
        schema:
          type: integer
          format: int32
          default: 1000
          maximum: 1000
          minimum: 1
      - name: $filter
        in: query
        description: 'An OData $filter clause. For more information on constructing this filter, see

          https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-certificates.'
        required: false
        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/BatchCertificateListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchError'
      deprecated: true
      x-ms-examples:
        Certificate list:
          $ref: ./examples/CertificateList.json
      x-ms-pageable:
        nextLinkName: odata.nextLink
      tags:
      - Certificates
    post:
      operationId: microsoftAzureBatchCreatecertificate
      summary: Microsoft Azure Creates A Certificate To The Specified Account
      description: Creates a Certificate to the specified Account.
      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
      responses:
        '201':
          description: The request has succeeded and a new resource has been created as a result.
          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 create:
          $ref: ./examples/CertificateCreate.json
      tags:
      - Certificates
      requestBody:
        content:
          application/json; odata=minimalmetadata:
            schema:
              $ref: '#/components/schemas/BatchCertificate'
        description: The Certificate to be created.
        required: true
  /certificates/{certificate-name}/create:
    post:
      operationId: Certificates_Create
      summary: Microsoft Azure Create a Certificate
      description: Creates a new certificate. If this is the first version, the certificate resource is created. This operation requires the certificates/create permission.
      tags:
      - Certificates
      parameters:
      - name: certificate-name
        in: path
        required: true
        description: The name of the certificate.
        schema:
          type: string
          pattern: ^[0-9a-zA-Z-]+$
        example: example_value
      - $ref: '#/components/parameters/ApiVersionParameter'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CertificateCreateParameters'
            examples:
              CertificatesCreateRequestExample:
                summary: Default Certificates_Create request
                x-microcks-default: true
                value:
                  policy:
                    id: abc123
                    key_props:
                      exportable: true
                      kty: RSA
                      key_size: 10
                      reuse_key: true
                      crv: P-256
                    secret_props:
                      contentType: example_value
                    x509_props:
                      subject: example_value
                      sans: {}
                      ekus: {}
                      key_usage: {}
                      validity_months: 10
                    issuer:
                      name: Example Title
                      cty: example_value
                    lifetime_actions:
                    - {}
                  attributes:
                    enabled: true
                    nbf: 10
                    exp: 10
                    created: 10
                    updated: 10
                    recoveryLevel: example_value
                    recoverableDays: 10
                  tags: example_value
      responses:
        '202':
          description: Accepted. The certificate create operation is pending.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CertificateOperation'
              examples:
                CertificatesCreate202Example:
                  summary: Default Certificates_Create 202 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    issuer:
                      name: Example Title
                    csr: example_value
                    cancellation_requested: true
                    status: example_value
                    status_details: example_value
                    error:
                      code: example_value
                      message: example_value
                    target: example_value
                    request_id: '500123'
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KeyVaultError'
              examples:
                CertificatesCreatedefaultExample:
                  summary: Default Certificates_Create default response
                  x-microcks-default: true
                  value:
                    error:
                      code: example_value
                      message: example_value
                      innererror:
                        code: example_value
                        innererror: example_value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/certificates
  : get:
      operationId: microsoftAzureCertificatesListbycatalog
      tags:
      - Certificates
      description: List Certificate resources by Catalog
      parameters:
      - $ref: '#/components/parameters/CustomFilterQueryParameter'
      - $ref: '#/components/parameters/CustomTopQueryParameter'
      - $ref: '#/components/parameters/CustomSkipQueryParameter'
      - $ref: '#/components/parameters/CustomMaxPageSizeQueryParameter'
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - name: catalogName
        in: path
        description: Name of catalog
        required: true
        schema:
          type: string
          pattern: ^[A-Za-z0-9_-]{1,50}$
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CertificateListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Certificates_ListByCatalog:
          $ref: ./examples/GetCertificates.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azuresphere Catalogs Catalogname Certificates
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/certificates/{serialNumber}
  : get:
      operationId: microsoftAzureCertificatesGet
      tags:
      - Certificates
      description: Get a Certificate
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - name: catalogName
        in: path
        description: Name of catalog
        required: true
        schema:
          type: string
          pattern: ^[A-Za-z0-9_-]{1,50}$
      - name: serialNumber
        in: path
        description: Serial number of the certificate. Use '.default' to get current active certificate.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Certificate'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Certificates_Get:
          $ref: ./examples/GetCertificate.json
      summary: Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azuresphere Catalogs Catalogname Certificates Serialnumber
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/certificates/{serialNumber}/retrieveCertChain
  : post:
      operationId: microsoftAzureCertificatesRetrievecertchain
      tags:
      - Certificates
      description: Retrieves cert chain.
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - name: catalogName
        in: path
        description: Name of catalog
        required: true
        schema:
          type: string
          pattern: ^[A-Za-z0-9_-]{1,50}$
      - name: serialNumber
        in: path
        description: Serial number of the certificate. Use '.default' to get current active certificate.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CertificateChainResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Certificates_RetrieveCertChain:
          $ref: ./examples/PostRetrieveCatalogCertChain.json
      summary: Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azuresphere Catalogs Catalogname Certificates Serialnumber Retrievecertchain
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/certificates/{serialNumber}/retrieveProofOfPossessionNonce
  : post:
      operationId: microsoftAzureCertificatesRetrieveproofofpossessionnonce
      tags:
      - Certificates
      description: Gets the proof of possession nonce.
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - name: catalogName
        in: path
        description: Name of catalog
        required: true
        schema:
          type: string
          pattern: ^[A-Za-z0-9_-]{1,50}$
      - name: serialNumber
        in: path
        description: Serial number of the certificate. Use '.default' to get current active certificate.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProofOfPossessionNonceResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Certificates_RetrieveProofOfPossessionNonce:
          $ref: ./examples/PostRetrieveProofOfPossessionNonce.json
      summary: Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azuresphere Catalogs Catalogname Certificates Serialnumber Retrieveproofofpossessionnonce
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProofOfPossessionNonceRequest'
        description: 'Proof of possession nonce request body '
        required: true
  /certificates(thumbprintAlgorithm={thumbprintAlgorithm},thumbprint={thumbprint})/canceldelete:
    post:
      tags:
      - Certificates
      operationId: microsoftAzureCertificateCanceldeletion
      x-ms-examples:
        Certificate cancel delete:
          $ref: ./examples/CertificateCancelDelete.json
      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 Node, the status of the Certificate changes to deleteFailed. If you decide that you want to continue using the Certificate, you can use this operation to set the status of the Certificate back to active. If you intend to delete the Certificate, you do not need to run this operation after the deletion failed. You must make sure that the Certificate is not being used by any resources, and then you can try again to delete the Certificate.
      x-ms-request-id: request-id
      parameters:
      - name: thumbprintAlgorithm
        in: path
        required: true
        description: The algorithm used to derive the thumbprint parameter. This must be sha1.
        schema:
          type: string
      - name: thumbprint
        in: path
        required: true
        description: The thumbprint of the Certificate being deleted.
        schema:
          type: string
      - name: timeout
        in: query
        required: false
        description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
        x-ms-parameter-grouping:
          postfix: Options
        schema:
          type: integer
          format: int32
          default: 30
      - name: client-request-id
        in: header
        required: false
        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.
        x-ms-parameter-grouping:
          postfix: Options
        x-ms-client-request-id: true
        schema:
          type: string
          format: uuid
      - name: return-client-request-id
        in: header
        required: false
        description: Whether the server should return the client-request-id in the response.
        x-ms-parameter-grouping:
          postfix: Options
        schema:
          type: boolean
          default: false
      - name: ocp-date
        in: header
        required: false
        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.
        x-ms-parameter-grouping:
          postfix: Options
        schema:
          type: string
          format: date-time-rfc1123
      - $ref: '#/components/parameters/ApiVersionParameter_2'
      responses:
        '204':
          headers:
            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
                format: uuid
            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
                format: uuid
            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-rfc1123
            DataServiceId:
              description: The OData ID of the resource to which the request applied.
              schema:
                type: string
          description: The request to the Batch service was successful.
        default:
          description: The error from the Batch service.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchError_2'
  /certificates(thumbprintAlgorithm={thumbprintAlgorithm},thumbprint={thumbprint}):
    delete:
      tags:
      - Certificates
      operationId: microsoftAzureCertificateDelete
      x-ms-examples:
        Certificate delete:
          $ref: ./examples/CertificateDelete.json
      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 it. Before you can delete a Certificate, you must therefore make sure that the Certificate is not associated with any existing Pools, the Certificate is not installed on any Nodes (even if you remove a Certificate from a Pool, it is not removed from existing Compute Nodes in that Pool until they restart), and no running Tasks depend on the Certificate. If you try to delete a Certificate that is in use, the deletion fails. The Certificate status changes to deleteFailed. You can use Cancel Delete Certificate to set the status back to active if you decide that you want to continue using the Certificate.
      x-ms-request-id: request-id
      parameters:
      - name: thumbprintAlgorithm
        in: path
        required: true
        description: The algorithm used to derive the thumbprint parameter. This must be sha1.
        schema:
          type: string
      - name: thumbprint
        in: path
        required: true
        description: The thumbprint of the Certificate to be deleted.
        schema:
          type: string
      - name: timeout
        in: query
        required: false
        description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
        x-ms-parameter-grouping:
          postfix: Options
        schema:
          type: integer
          format: int32
          default: 30
      - name: client-request-id
        in: header
        required: false
        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.
        x-ms-parameter-grouping:
          postfix: Options
        x-ms-client-request-id: true
        schema:
          type: string
          format: uuid
      - name: return-client-request-id
        in: header
        required: false
        description: Whether the server should return the client-request-id in the response.
        x-ms-parameter-grouping:
          postfix: Options
        schema:
          type: boolean
          default: false
      - name: ocp-date
        in: header
        required: false
        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.
        x-ms-parameter-grouping:
          postfix: Options
        schema:
          type: string
          format: date-time-rfc1123
      - $ref: '#/components/parameters/ApiVersionParameter_2'
      responses:
        '202':
          headers:
            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
                format: uuid
            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
                format: uuid
            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-rfc1123
          description: The request to the Batch service was successful.
        default:
          description: The error from the Batch service.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchError_2'
    get:
      tags:
      - Certificates
      operationId: microsoftAzureCertificateGet
      x-ms-examples:
        Certificate get:
          $ref: ./examples/CertificateGet.json
      description: Gets information about the specified Certificate.
      x-ms-request-id: request-id
      parameters:
      - name: thumbprintAlgorithm
        in: path
        required: true
        description: The algorithm used to derive the thumbprint parameter. This must be sha1.
        schema:
          type: string
      - name: thumbprint
        in: path
        required: true
        description: The thumbprint of the Certificate to get.
        schema:
          type: string
      - name: $select
        in: query
        required: false
        description: An OData $select clause.
        x-ms-parameter-grouping:
          postfix: Options
        schema:
          type: string
      - name: timeout
        in: query
        required: false
        description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
        x-ms-parameter-grouping:
          postfix: Options
        schema:
          type: integer
          format: int32
          default: 30
      - name: client-request-id
        in: header
        required: false
        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.
        x-ms-parameter-grouping:
          postfix: Options
        x-ms-client-request-id: true
        schema:
          type: string
          format: uuid
      - name: return-client-request-id
        in: header
        required: false
        description: Whether the server should return the client-request-id in the response.
        x-ms-parameter-grouping:
          postfix: Options
        schema:
          type: boolean
          default: false
      - name: ocp-date
        in: header
        required: false
        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.
        x-ms-parameter-grouping:
          postfix: Options
        schema:
          type: string
          format: date-time-rfc1123
      - $ref: '#/components/parameters/ApiVersionParameter_2'
      responses:
        '200':
          headers:
            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
                format: uuid
            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

# --- truncated at 32 KB (96 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/microsoft-azure-certificates-api-openapi.yml