swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector DedicatedHsms API
schemes:
- https
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
        type: string
        description: The name of the Resource Group to which the resource belongs.
      - name: name
        in: path
        required: true
        type: string
        pattern: ^[a-zA-Z0-9-]{3,24}$
        description: Name of the dedicated Hsm
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/DedicatedHsm'
        description: Parameters to create or update the dedicated hsm
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: Created dedicated HSM
          schema:
            $ref: '#/definitions/DedicatedHsm'
        '201':
          description: Created dedicated HSM
          schema:
            $ref: '#/definitions/DedicatedHsm'
        default:
          description: The error response describing why the operation failed.
          schema:
            $ref: '#/definitions/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 Resourcegroupname Providers Microsoft Hardwaresecuritymodules Dedicatedhsms Name
    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
        type: string
        description: The name of the Resource Group to which the server belongs.
      - name: name
        in: path
        required: true
        type: string
        pattern: ^[a-zA-Z0-9-]{3,24}$
        description: Name of the dedicated HSM
      - name: parameters
        in: body
        required: true
        x-ms-client-flatten: true
        schema:
          $ref: '#/definitions/DedicatedHsmPatchParameters'
        description: Parameters to patch the dedicated HSM
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: Patched dedicated HSM
          schema:
            $ref: '#/definitions/DedicatedHsm'
        default:
          description: The error response describing why the operation failed.
          schema:
            $ref: '#/definitions/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 Resourcegroupname Providers Microsoft Hardwaresecuritymodules Dedicatedhsms Name
    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
        type: string
        description: The name of the Resource Group to which the dedicated HSM belongs.
      - name: name
        in: path
        required: true
        type: string
        description: The name of the dedicated HSM to delete
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: OK Response.
        '202':
          description: Accepted
        '204':
          description: No Content
        default:
          description: The error response describing why the operation failed.
          schema:
            $ref: '#/definitions/DedicatedHsmError'
      x-ms-examples:
        Delete a dedicated HSM:
          $ref: ./examples//DedicatedHsm_Delete.json
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Hardwaresecuritymodules Dedicatedhsms Name
    get:
      tags:
      - DedicatedHsms
      operationId: microsoftAzureDedicatedhsmGet
      description: Gets the specified Azure dedicated HSM.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        type: string
        description: The name of the Resource Group to which the dedicated hsm belongs.
      - name: name
        in: path
        required: true
        type: string
        description: The name of the dedicated HSM.
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: Retrieved dedicated HSM
          schema:
            $ref: '#/definitions/DedicatedHsm'
        default:
          description: The error response describing why the operation failed.
          schema:
            $ref: '#/definitions/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 Resourcegroupname Providers Microsoft Hardwaresecuritymodules Dedicatedhsms Name
  ? /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
        type: string
        description: The name of the Resource Group to which the dedicated HSM belongs.
      - name: $top
        in: query
        type: integer
        format: int32
        description: Maximum number of results to return.
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: Get information about all dedicated HSMs in the specified resource group.
          schema:
            $ref: '#/definitions/DedicatedHsmListResult'
        default:
          description: The error response describing why the operation failed.
          schema:
            $ref: '#/definitions/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 Resourcegroupname Providers Microsoft Hardwaresecuritymodules Dedicatedhsms
  /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
        type: integer
        format: int32
        description: Maximum number of results to return.
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: Get information about all dedicated HSMs in the specified subscription.
          schema:
            $ref: '#/definitions/DedicatedHsmListResult'
        default:
          description: The error response describing why the operation failed.
          schema:
            $ref: '#/definitions/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 Hardwaresecuritymodules Dedicatedhsms
definitions:
  DedicatedHsmListResult:
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/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
  DedicatedHsmPatchParameters:
    properties:
      tags:
        type: object
        additionalProperties:
          type: string
        description: Resource tags
    description: Patchable 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: '#/definitions/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
  NetworkProfile:
    properties:
      subnet:
        $ref: '#/definitions/ApiEntityReference'
        description: Specifies the identifier of the subnet.
      networkInterfaces:
        type: array
        items:
          $ref: '#/definitions/NetworkInterface'
        description: Specifies the list of resource Ids for the network interfaces associated with the dedicated HSM.
  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.
  DedicatedHsm:
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/DedicatedHsmProperties'
        description: Properties of the dedicated HSM
    allOf:
    - $ref: '#/definitions/Resource'
    required:
    - location
    - sku
    - properties
    description: Resource information with extended details.
  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.
  DedicatedHsmProperties:
    properties:
      networkProfile:
        $ref: '#/definitions/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
  DedicatedHsmError:
    properties:
      error:
        readOnly: true
        $ref: '#/definitions/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: '#/definitions/Error'
    description: The key vault server error.
  ApiEntityReference:
    properties:
      id:
        type: string
        description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...
    description: The API entity reference.
parameters:
  ApiVersionParameter:
    name: api-version
    in: query
    required: true
    type: string
    description: Client Api Version.
  SubscriptionIdParameter:
    name: subscriptionId
    in: path
    required: true
    type: string
    description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'