Microsoft Azure Keys API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Keys API
schemes:
- https
tags:
- name: Keys
paths:
  /keys:
    get:
      tags:
      - Keys
      summary: Microsoft Azure Gets A List Of Keys
      operationId: microsoftAzureGetkeys
      consumes: []
      produces:
      - application/vnd.microsoft.appconfig.keyset+json
      - application/problem+json
      parameters:
      - name: name
        in: query
        description: A filter for the name of the returned keys.
        type: string
      - $ref: '#/parameters/SyncTokens'
      - $ref: '#/parameters/ApiVersion'
      - name: After
        in: query
        description: Instructs the server to return elements that appear after the element referred to by the specified token.
        type: string
      - name: Accept-Datetime
        in: header
        description: Requests the server to respond with the state of the resource at the specified time.
        type: string
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KeyListResult'
          headers:
            Sync-Token:
              description: Enables real-time consistency between requests by providing the returned value in the next request made to the server.
              type: string
        default:
          description: Error response describing why the operation failed
          schema:
            $ref: '#/definitions/Error'
      x-ms-examples:
        GetKeys:
          $ref: ./examples/GetKeys.json
      x-ms-pageable:
        itemName: items
        nextLinkName: '@nextLink'
      description: Needs a more full description created.
    head:
      tags:
      - Keys
      summary: Microsoft Azure Requests The Headers And Status Of The Given Resource
      operationId: microsoftAzureCheckkeys
      consumes: []
      produces: []
      parameters:
      - name: name
        in: query
        description: A filter for the name of the returned keys.
        type: string
      - $ref: '#/parameters/SyncTokens'
      - $ref: '#/parameters/ApiVersion'
      - name: After
        in: query
        description: Instructs the server to return elements that appear after the element referred to by the specified token.
        type: string
      - name: Accept-Datetime
        in: header
        description: Requests the server to respond with the state of the resource at the specified time.
        type: string
      responses:
        '200':
          description: Success
          headers:
            Sync-Token:
              description: Enables real-time consistency between requests by providing the returned value in the next request made to the server.
              type: string
        default:
          description: Error response.
      x-ms-examples:
        CheckKeys:
          $ref: ./examples/CheckKeys.json
      description: Needs a more full description created.
  /keys/{key-name}/create:
    post:
      operationId: Keys_Create
      summary: Microsoft Azure Create a Key
      description: Creates a new key, stores it, then returns key parameters and attributes to the client. The create key operation can be used to create any key type in Azure Key Vault.
      tags:
      - Keys
      parameters:
      - name: key-name
        in: path
        required: true
        description: The name for the new key.
        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/KeyCreateParameters'
            examples:
              KeysCreateRequestExample:
                summary: Default Keys_Create request
                x-microcks-default: true
                value:
                  kty: EC
                  key_size: 10
                  key_ops:
                  - encrypt
                  attributes:
                    enabled: true
                    nbf: 10
                    exp: 10
                    created: 10
                    updated: 10
                    recoveryLevel: Purgeable
                    recoverableDays: 10
                    exportable: true
                    hsmPlatform: example_value
                  tags: example_value
                  crv: P-256
                  release_policy:
                    contentType: example_value
                    immutable: true
                    data: example_value
                  exportable: true
      responses:
        '200':
          description: Successfully created the key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KeyBundle'
              examples:
                KeysCreate200Example:
                  summary: Default Keys_Create 200 response
                  x-microcks-default: true
                  value:
                    key:
                      kid: '500123'
                      kty: EC
                      key_ops:
                      - {}
                      n: example_value
                      e: example_value
                      d: example_value
                      dp: example_value
                      dq: example_value
                      qi: example_value
                      p: example_value
                      q: example_value
                      k: example_value
                      crv: P-256
                      x: example_value
                      y: example_value
                    attributes:
                      enabled: true
                      nbf: 10
                      exp: 10
                      created: 10
                      updated: 10
                      recoveryLevel: Purgeable
                      recoverableDays: 10
                      exportable: true
                      hsmPlatform: example_value
                    tags: example_value
                    managed: true
                    release_policy:
                      contentType: example_value
                      immutable: true
                      data: example_value
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KeyVaultError'
              examples:
                KeysCreatedefaultExample:
                  summary: Default Keys_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
  /keys/{key-name}/{key-version}:
    get:
      operationId: Keys_Get
      summary: Microsoft Azure Get a Key
      description: Gets the public part of a stored key. The get key operation applies to all key types. If the requested key is symmetric, then no key material is released in the response.
      tags:
      - Keys
      parameters:
      - name: key-name
        in: path
        required: true
        description: The name of the key.
        schema:
          type: string
        example: example_value
      - name: key-version
        in: path
        required: true
        description: The version of the key. Use an empty string to get the latest version.
        schema:
          type: string
        example: example_value
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Successfully returned the key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KeyBundle'
              examples:
                KeysGet200Example:
                  summary: Default Keys_Get 200 response
                  x-microcks-default: true
                  value:
                    key:
                      kid: '500123'
                      kty: EC
                      key_ops:
                      - {}
                      n: example_value
                      e: example_value
                      d: example_value
                      dp: example_value
                      dq: example_value
                      qi: example_value
                      p: example_value
                      q: example_value
                      k: example_value
                      crv: P-256
                      x: example_value
                      y: example_value
                    attributes:
                      enabled: true
                      nbf: 10
                      exp: 10
                      created: 10
                      updated: 10
                      recoveryLevel: Purgeable
                      recoverableDays: 10
                      exportable: true
                      hsmPlatform: example_value
                    tags: example_value
                    managed: true
                    release_policy:
                      contentType: example_value
                      immutable: true
                      data: example_value
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KeyVaultError'
              examples:
                KeysGetdefaultExample:
                  summary: Default Keys_Get 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
    patch:
      operationId: Keys_Update
      summary: Microsoft Azure Update Key Attributes
      description: The update key operation changes specified attributes of a stored key and can be applied to any key type and key version stored in Azure Key Vault.
      tags:
      - Keys
      parameters:
      - name: key-name
        in: path
        required: true
        description: The name of the key.
        schema:
          type: string
        example: example_value
      - name: key-version
        in: path
        required: true
        description: The version of the key.
        schema:
          type: string
        example: example_value
      - $ref: '#/components/parameters/ApiVersionParameter'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/KeyUpdateParameters'
            examples:
              KeysUpdateRequestExample:
                summary: Default Keys_Update request
                x-microcks-default: true
                value:
                  key_ops:
                  - example_value
                  attributes:
                    enabled: true
                    nbf: 10
                    exp: 10
                    created: 10
                    updated: 10
                    recoveryLevel: Purgeable
                    recoverableDays: 10
                    exportable: true
                    hsmPlatform: example_value
                  tags: example_value
                  release_policy:
                    contentType: example_value
                    immutable: true
                    data: example_value
      responses:
        '200':
          description: Successfully updated the key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KeyBundle'
              examples:
                KeysUpdate200Example:
                  summary: Default Keys_Update 200 response
                  x-microcks-default: true
                  value:
                    key:
                      kid: '500123'
                      kty: EC
                      key_ops:
                      - {}
                      n: example_value
                      e: example_value
                      d: example_value
                      dp: example_value
                      dq: example_value
                      qi: example_value
                      p: example_value
                      q: example_value
                      k: example_value
                      crv: P-256
                      x: example_value
                      y: example_value
                    attributes:
                      enabled: true
                      nbf: 10
                      exp: 10
                      created: 10
                      updated: 10
                      recoveryLevel: Purgeable
                      recoverableDays: 10
                      exportable: true
                      hsmPlatform: example_value
                    tags: example_value
                    managed: true
                    release_policy:
                      contentType: example_value
                      immutable: true
                      data: example_value
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KeyVaultError'
              examples:
                KeysUpdatedefaultExample:
                  summary: Default Keys_Update 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
  /keys/{key-name}:
    delete:
      operationId: Keys_Delete
      summary: Microsoft Azure Delete a Key
      description: Deletes a key of any type from storage in Azure Key Vault. The delete key operation cannot be used to remove individual versions of a key.
      tags:
      - Keys
      parameters:
      - name: key-name
        in: path
        required: true
        description: The name of the key to delete.
        schema:
          type: string
        example: example_value
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Successfully deleted the key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeletedKeyBundle'
              examples:
                KeysDelete200Example:
                  summary: Default Keys_Delete 200 response
                  x-microcks-default: true
                  value:
                    recoveryId: '500123'
                    scheduledPurgeDate: 10
                    deletedDate: 10
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KeyVaultError'
              examples:
                KeysDeletedefaultExample:
                  summary: Default Keys_Delete 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
  ? /modelmanagement/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.MachineLearningServices/workspaces/{workspace}/services/{id}/listkeys
  : post:
      tags:
      - Keys
      summary: Microsoft Azure Lists Service Keys
      description: Gets a list of Service keys.
      operationId: microsoftAzureServicesListservicekeys
      consumes: []
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupParameter'
      - $ref: '#/parameters/workspaceParameter'
      - name: id
        in: path
        description: The Service Id.
        required: true
        type: string
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/AuthKeys'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ModelErrorResponse'
  ? /modelmanagement/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.MachineLearningServices/workspaces/{workspace}/services/{id}/regenerateKeys
  : post:
      tags:
      - Keys
      summary: Microsoft Azure Regenerate Service Keys
      description: Regenerate and return the Service keys.
      operationId: microsoftAzureServicesRegenerateservicekeys
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupParameter'
      - $ref: '#/parameters/workspaceParameter'
      - name: id
        in: path
        description: The Service Id.
        required: true
        type: string
      - name: request
        in: body
        description: The payload that is used to regenerate keys.
        required: true
        schema:
          $ref: '#/definitions/RegenerateServiceKeysRequest'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/AuthKeys'
        '202':
          description: The request was accepted. The header 'Operation-Location' contains the async operation location URL.  Accessing this URL with a GET call will return the status of the background task.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ModelErrorResponse'
components:
  schemas:
    KeyVaultError:
      type: object
      description: The key vault error exception.
      properties:
        error:
          type: object
          readOnly: true
          description: The key vault server error.
          properties:
            code:
              type: string
              readOnly: true
              description: The error code.
            message:
              type: string
              readOnly: true
              description: The error message.
            innererror:
              type: object
              readOnly: true
              description: Inner error details.
              properties:
                code:
                  type: string
                  readOnly: true
                innererror:
                  type: object
                  readOnly: true
          example: example_value
    KeyCreateParameters:
      type: object
      description: The key create parameters.
      properties:
        kty:
          type: string
          description: The type of key to create.
          enum:
          - EC
          - EC-HSM
          - RSA
          - RSA-HSM
          - oct
          - oct-HSM
          example: EC
        key_size:
          type: integer
          description: The key size in bits. For example, 2048, 3072, or 4096 for RSA.
          example: 10
        key_ops:
          type: array
          items:
            type: string
            enum:
            - encrypt
            - decrypt
            - sign
            - verify
            - wrapKey
            - unwrapKey
            - import
            - export
          description: JSON web key operations.
          example: []
        attributes:
          $ref: '#/components/schemas/KeyAttributes'
        tags:
          type: object
          additionalProperties:
            type: string
          description: Application-specific metadata.
          example: example_value
        crv:
          type: string
          description: Elliptic curve name (for EC key types).
          enum:
          - P-256
          - P-384
          - P-521
          - P-256K
          example: P-256
        release_policy:
          $ref: '#/components/schemas/KeyReleasePolicy'
        exportable:
          type: boolean
          description: Whether the private key can be exported.
          example: true
      required:
      - kty
    DeletedKeyBundle:
      type: object
      description: A deleted key bundle.
      allOf:
      - $ref: '#/components/schemas/KeyBundle'
      properties:
        recoveryId:
          type: string
          description: The URL of the recovery object.
          example: '500123'
        scheduledPurgeDate:
          type: integer
          description: The time when the key is scheduled to be purged (Unix time).
          example: 10
        deletedDate:
          type: integer
          description: The time when the key was deleted (Unix time).
          example: 10
    KeyReleasePolicy:
      type: object
      description: The policy rules under which the key can be exported.
      properties:
        contentType:
          type: string
          default: application/json; charset=utf-8
          description: Content type and version of key release policy.
          example: example_value
        immutable:
          type: boolean
          description: Defines whether the policy is immutable.
          example: true
        data:
          type: string
          description: Blob encoding the policy rules (base64url-encoded).
          example: example_value
    KeyAttributes:
      type: object
      description: The attributes of a key.
      properties:
        enabled:
          type: boolean
          description: Whether the key is enabled.
          example: true
        nbf:
          type: integer
          description: Not before date in UTC (Unix time).
          example: 10
        exp:
          type: integer
          description: Expiry date in UTC (Unix time).
          example: 10
        created:
          type: integer
          readOnly: true
          description: Creation time in UTC (Unix time).
          example: 10
        updated:
          type: integer
          readOnly: true
          description: Last updated time in UTC (Unix time).
          example: 10
        recoveryLevel:
          type: string
          readOnly: true
          description: The recovery level currently in effect.
          enum:
          - Purgeable
          - Recoverable+Purgeable
          - Recoverable
          - Recoverable+ProtectedSubscription
          example: Purgeable
        recoverableDays:
          type: integer
          readOnly: true
          description: The soft-delete data retention days.
          example: 10
        exportable:
          type: boolean
          description: Whether the private key can be exported.
          example: true
        hsmPlatform:
          type: string
          readOnly: true
          description: The underlying HSM platform.
          example: example_value
    JsonWebKey:
      type: object
      description: JSON Web Key (JWK) representation of a key.
      properties:
        kid:
          type: string
          description: Key identifier.
          example: '500123'
        kty:
          type: string
          description: Key type (e.g., RSA, EC, oct, oct-HSM).
          enum:
          - EC
          - EC-HSM
          - RSA
          - RSA-HSM
          - oct
          - oct-HSM
          example: EC
        key_ops:
          type: array
          items:
            type: string
            enum:
            - encrypt
            - decrypt
            - sign
            - verify
            - wrapKey
            - unwrapKey
            - import
            - export
          description: Allowed key operations.
          example: []
        n:
          type: string
          description: RSA modulus.
          example: example_value
        e:
          type: string
          description: RSA public exponent.
          example: example_value
        d:
          type: string
          description: RSA private exponent.
          example: example_value
        dp:
          type: string
          description: RSA private key parameter.
          example: example_value
        dq:
          type: string
          description: RSA private key parameter.
          example: example_value
        qi:
          type: string
          description: RSA private key parameter.
          example: example_value
        p:
          type: string
          description: RSA secret prime.
          example: example_value
        q:
          type: string
          description: RSA secret prime.
          example: example_value
        k:
          type: string
          description: Symmetric key.
          example: example_value
        crv:
          type: string
          description: Elliptic curve name.
          enum:
          - P-256
          - P-384
          - P-521
          - P-256K
          example: P-256
        x:
          type: string
          description: X component of an EC public key.
          example: example_value
        y:
          type: string
          description: Y component of an EC public key.
          example: example_value
    KeyUpdateParameters:
      type: object
      description: The key update parameters.
      properties:
        key_ops:
          type: array
          items:
            type: string
          description: JSON web key operations.
          example: []
        attributes:
          $ref: '#/components/schemas/KeyAttributes'
        tags:
          type: object
          additionalProperties:
            type: string
          description: Application-specific metadata.
          example: example_value
        release_policy:
          $ref: '#/components/schemas/KeyReleasePolicy'
    KeyBundle:
      type: object
      description: A key bundle containing the key and its attributes.
      properties:
        key:
          $ref: '#/components/schemas/JsonWebKey'
        attributes:
          $ref: '#/components/schemas/KeyAttributes'
        tags:
          type: object
          additionalProperties:
            type: string
          description: Application-specific metadata in the form of key-value pairs.
          example: example_value
        managed:
          type: boolean
          readOnly: true
          description: Whether the key's lifetime is managed by Key Vault.
          example: true
        release_policy:
          $ref: '#/components/schemas/KeyReleasePolicy'
  parameters:
    ApiVersionParameter:
      name: api-version
      in: query
      required: true
      description: Client API version.
      schema:
        type: string
        default: '7.5'
definitions:
  RegenerateServiceKeysRequest:
    type: object
    properties:
      keyType:
        format: int32
        description: Specification for which type of key to generate.
        enum:
        - Primary
        - Secondary
        type: integer
        example: Primary
        x-ms-enum:
          name: KeyType
          modelAsString: false
      keyValue:
        description: The value the key is set to.
        type: string
  KeyListResult:
    description: The result of a list request.
    type: object
    properties:
      items:
        description: The collection value.
        type: array
        items:
          $ref: '#/definitions/Key'
      '@nextLink':
        description: The URI that can be used to request the next set of paged results.
        type: string
  ErrorDetails:
    description: The error details.
    type: object
    properties:
      code:
        description: The error code.
        type: string
      message:
        description: The error message.
        type: string
      target:
        description: The target of the error (e.g., the name of the property in error).
        type: string
  Key:
    type: object
    properties:
      name:
        type: string
        readOnly: true
        description: The name of the key.
  AuthKeys:
    type: object
    properties:
      primaryKey:
        description: The primary key.
        type: string
      secondaryKey:
        description: The secondary key.
        type: string
  ModelErrorResponse:
    description: The Model Management Service Error object.
    type: object
    properties:
      code:
        description: The error code.
        type: string
      statusCode:
        format: int32
        description: The HTTP status code.
        type: integer
      message:
        description: The error message.
        type: string
      details:
        description: An array of error detail objects.
        uniqueItems: false
        type: array
        items:
          $ref: '#/definitions/ErrorDetails'
  Error:
    description: Azure App Configuration error object.
    type: object
    properties:
      type:
        description: The type of the error.
        type: string
      title:
        description: A brief summary of the error.
        type: string
      name:
        description: The name of the parameter that resulted in the error.
        type: string
      detail:
        description: A detailed description of the error.
        type: string
      status:
        description: The HTTP status code that the error maps to.
        type: integer
    readOnly: true
parameters:
  workspaceParameter:
    name: workspace
    in: path
    description: The name of the workspace.
    required: true
    type: string
    x-ms-parameter-location: method
  ApiVersion:
    name: api-version
    in: query
    description: The API version to be used with the HTTP request.
    required: true
    type: string
  resourceGroupParameter:
    name: resourceGroup
    in: path
    description: The Name of the resource group in which the workspace is located.
    required: true
    type: string
    x-ms-parameter-location: method
  subscriptionIdParameter:
    name: subscriptionId
    in: path
    description: The Azure Subscription ID.
    required: true
    type: string
    format: uuid
    x-ms-parameter-location: method
  SyncTokens:
    name: Sync-Token
    in: header
    description: Used to guarantee real-time consistency between requests.
    type: string
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'