Microsoft Azure DedicatedHsms API

openapi: 3.2.0
info:
  title: Microsoft Azure Azure Dedicated HSM Resource Provider…
  description: The Azure management API provides a RESTful set of web services that interact with Azure Dedicated HSM RP.
  version: 2018-10-31-preview
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: DedicatedHsms
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HardwareSecurityModules/dedicatedHSMs/{name}
  : put:
      tags:
      - DedicatedHsms
      operationId: microsoftAzureDedicatedhsmCreateorupdate
      x-ms-long-running-operation: true
      description: Create or Update a dedicated HSM in the specified subscription.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        description: The name of the Resource Group to which the resource belongs.
        schema:
          type: string
      - name: name
        in: path
        required: true
        description: Name of the dedicated Hsm
        schema:
          type: string
          pattern: ^[a-zA-Z0-9-]{3,24}$
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: Created dedicated HSM
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DedicatedHsm'
        '201':
          description: Created dedicated HSM
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DedicatedHsm'
        default:
          description: The error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DedicatedHsmError'
      x-ms-examples:
        Create a new or update an existing dedicated HSM:
          $ref: ./examples//DedicatedHsm_CreateOrUpdate.json
        Create a new or update an existing payment HSM:
          $ref: ./examples//PaymentHsm_CreateOrUpdate.json
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups…
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DedicatedHsm'
        description: Parameters to create or update the dedicated hsm
        required: true
    patch:
      tags:
      - DedicatedHsms
      operationId: microsoftAzureDedicatedhsmUpdate
      x-ms-long-running-operation: true
      description: Update a dedicated HSM in the specified subscription.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        description: The name of the Resource Group to which the server belongs.
        schema:
          type: string
      - name: name
        in: path
        required: true
        description: Name of the dedicated HSM
        schema:
          type: string
          pattern: ^[a-zA-Z0-9-]{3,24}$
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: Patched dedicated HSM
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DedicatedHsm'
        default:
          description: The error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DedicatedHsmError'
      x-ms-examples:
        Update an existing dedicated HSM:
          $ref: ./examples//DedicatedHsm_Update.json
        Update an existing payment HSM:
          $ref: ./examples//PaymentHsm_Update.json
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups…
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DedicatedHsmPatchParameters'
        description: Parameters to patch the dedicated HSM
        required: true
    delete:
      tags:
      - DedicatedHsms
      operationId: microsoftAzureDedicatedhsmDelete
      x-ms-long-running-operation: true
      description: Deletes the specified Azure Dedicated HSM.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        description: The name of the Resource Group to which the dedicated HSM belongs.
        schema:
          type: string
      - name: name
        in: path
        required: true
        description: The name of the dedicated HSM to delete
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: OK Response.
        '202':
          description: Accepted
        '204':
          description: No Content
        default:
          description: The error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DedicatedHsmError'
      x-ms-examples:
        Delete a dedicated HSM:
          $ref: ./examples//DedicatedHsm_Delete.json
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups…
    get:
      tags:
      - DedicatedHsms
      operationId: microsoftAzureDedicatedhsmGet
      description: Gets the specified Azure dedicated HSM.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        description: The name of the Resource Group to which the dedicated hsm belongs.
        schema:
          type: string
      - name: name
        in: path
        required: true
        description: The name of the dedicated HSM.
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: Retrieved dedicated HSM
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DedicatedHsm'
        default:
          description: The error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DedicatedHsmError'
      x-ms-examples:
        Get a dedicated HSM:
          $ref: ./examples//DedicatedHsm_Get.json
        Get a payment HSM:
          $ref: ./examples//PaymentHsm_Get.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HardwareSecurityModules/dedicatedHSMs
  : get:
      tags:
      - DedicatedHsms
      operationId: microsoftAzureDedicatedhsmListbyresourcegroup
      description: The List operation gets information about the dedicated hsms associated with the subscription and within the specified resource group.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        description: The name of the Resource Group to which the dedicated HSM belongs.
        schema:
          type: string
      - name: $top
        in: query
        description: Maximum number of results to return.
        schema:
          type: integer
          format: int32
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: Get information about all dedicated HSMs in the specified resource group.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DedicatedHsmListResult'
        default:
          description: The error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DedicatedHsmError'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        List dedicated HSM devices in a resource group:
          $ref: ./examples//DedicatedHsm_ListByResourceGroup.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
  /subscriptions/{subscriptionId}/providers/Microsoft.HardwareSecurityModules/dedicatedHSMs:
    get:
      tags:
      - DedicatedHsms
      operationId: microsoftAzureDedicatedhsmListbysubscription
      description: The List operation gets information about the dedicated HSMs associated with the subscription.
      parameters:
      - name: $top
        in: query
        description: Maximum number of results to return.
        schema:
          type: integer
          format: int32
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: Get information about all dedicated HSMs in the specified subscription.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DedicatedHsmListResult'
        default:
          description: The error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DedicatedHsmError'
      x-ms-examples:
        List dedicated HSM devices in a subscription:
          $ref: ./examples//DedicatedHsm_ListBySubscription.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft…
components:
  schemas:
    NetworkProfile:
      properties:
        subnet:
          $ref: '#/components/schemas/ApiEntityReference'
          description: Specifies the identifier of the subnet.
        networkInterfaces:
          type: array
          items:
            $ref: '#/components/schemas/NetworkInterface'
          description: Specifies the list of resource Ids for the network interfaces associated with the dedicated HSM.
    DedicatedHsmError:
      properties:
        error:
          readOnly: true
          $ref: '#/components/schemas/Error'
      description: The error exception.
    Error:
      properties:
        code:
          type: string
          readOnly: true
          description: The error code.
        message:
          type: string
          readOnly: true
          description: The error message.
        innererror:
          x-ms-client-name: innerError
          readOnly: true
          $ref: '#/components/schemas/Error'
      description: The key vault server error.
    NetworkInterface:
      properties:
        id:
          readOnly: true
          type: string
          description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...
        privateIpAddress:
          type: string
          description: Private Ip address of the interface
      description: The network interface definition.
    DedicatedHsmPatchParameters:
      properties:
        tags:
          type: object
          additionalProperties:
            type: string
          description: Resource tags
      description: Patchable properties of the dedicated HSM
    DedicatedHsmListResult:
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/DedicatedHsm'
          description: The list of dedicated HSMs.
        nextLink:
          type: string
          description: The URL to get the next set of dedicated hsms.
      description: List of dedicated HSMs
    Sku:
      description: SKU of the dedicated HSM
      properties:
        name:
          type: string
          description: SKU of the dedicated HSM
          enum:
          - SafeNet Luna Network HSM A790
          - payShield10K_LMK1_CPS60
          - payShield10K_LMK1_CPS250
          - payShield10K_LMK1_CPS2500
          - payShield10K_LMK2_CPS60
          - payShield10K_LMK2_CPS250
          - payShield10K_LMK2_CPS2500
          x-ms-enum:
            name: SkuName
            modelAsString: true
            values:
            - value: SafeNet Luna Network HSM A790
              description: The dedicated HSM is a Safenet Luna Network HSM A790 device.
            - value: payShield10K_LMK1_CPS60
              description: The dedicated HSM is a payShield 10K, model PS10-D, 10Gb Ethernet Hardware Platform device with 1 local master key which supports up to 60 calls per second.
            - value: payShield10K_LMK1_CPS250
              description: The dedicated HSM is a payShield 10K, model PS10-D, 10Gb Ethernet Hardware Platform device with 1 local master key which supports up to 250 calls per second.
            - value: payShield10K_LMK1_CPS2500
              description: The dedicated HSM is a payShield 10K, model PS10-D, 10Gb Ethernet Hardware Platform device with 1 local master key which supports up to 2500 calls per second.
            - value: payShield10K_LMK2_CPS60
              description: The dedicated HSM is a payShield 10K, model PS10-D, 10Gb Ethernet Hardware Platform device with 2 local master keys which supports up to 60 calls per second.
            - value: payShield10K_LMK2_CPS250
              description: The dedicated HSM is a payShield 10K, model PS10-D, 10Gb Ethernet Hardware Platform device with 2 local master keys which supports up to 250 calls per second.
            - value: payShield10K_LMK2_CPS2500
              description: The dedicated HSM is a payShield 10K, model PS10-D, 10Gb Ethernet Hardware Platform device with 2 local master keys which supports up to 2500 calls per second.
    ApiEntityReference:
      properties:
        id:
          type: string
          description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...
      description: The API entity reference.
    DedicatedHsm:
      properties:
        properties:
          x-ms-client-flatten: true
          $ref: '#/components/schemas/DedicatedHsmProperties'
          description: Properties of the dedicated HSM
      allOf:
      - $ref: '#/components/schemas/Resource'
      required:
      - location
      - sku
      - properties
      description: Resource information with extended details.
    DedicatedHsmProperties:
      properties:
        networkProfile:
          $ref: '#/components/schemas/NetworkProfile'
          description: Specifies the network interfaces of the dedicated hsm.
        stampId:
          type: string
          description: This field will be used when RP does not support Availability zones.
        statusMessage:
          readOnly: true
          type: string
          description: Resource Status Message.
        provisioningState:
          readOnly: true
          type: string
          description: Provisioning state.
          enum:
          - Succeeded
          - Provisioning
          - Allocating
          - Connecting
          - Failed
          - CheckingQuota
          - Deleting
          x-ms-enum:
            name: JsonWebKeyType
            modelAsString: true
            values:
            - value: Succeeded
              description: The dedicated HSM has been full provisioned.
            - value: Provisioning
              description: The dedicated HSM is currently being provisioned.
            - value: Allocating
              description: A device is currently being allocated for the dedicated HSM resource.
            - value: Connecting
              description: The dedicated HSM is being connected to the virtual network.
            - value: Failed
              description: Provisioning of the dedicated HSM has failed.
            - value: CheckingQuota
              description: Validating the subscription has sufficient quota to allocate a dedicated HSM device.
            - value: Deleting
              description: The dedicated HSM is currently being deleted.
      description: Properties of the dedicated hsm
    Resource:
      properties:
        id:
          readOnly: true
          type: string
          description: The Azure Resource Manager resource ID for the dedicated HSM.
        name:
          readOnly: true
          type: string
          description: The name of the dedicated HSM.
        type:
          readOnly: true
          type: string
          description: The resource type of the dedicated HSM.
        location:
          type: string
          description: The supported Azure location where the dedicated HSM should be created.
        sku:
          $ref: '#/components/schemas/Sku'
          description: SKU details
        zones:
          type: array
          items:
            type: string
          description: The Dedicated Hsm zones.
        tags:
          type: object
          additionalProperties:
            type: string
          description: Resource tags
      description: Dedicated HSM resource
      required:
      - location
      x-ms-azure-resource: true
  parameters:
    ApiVersionParameter:
      name: api-version
      in: query
      required: true
      description: Client Api Version.
      schema:
        type: string
    SubscriptionIdParameter:
      name: subscriptionId
      in: path
      required: true
      description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
      schema:
        type: string
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            user_impersonation: impersonate your user account
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: Azure Active Directory OAuth2 Flow