openapi-directory/api/azure.com/hardwaresecuritymodules-dedicatedhsm.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"description":"The Azure management API provides a RESTful set of web services that interact with Azure Dedicated HSM RP.","title":"Azure Dedicated HSM Resource Provider","version":"2018-10-31-preview","x-apisguru-categories":["cloud"],"x-logo":{"url":"https://assets.onestore.ms/cdnfiles/onestorerolling-1606-01000/shell/v3/images/logo/microsoft.png"},"x-origin":[{"format":"swagger","url":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/preview/2018-10-31-preview/dedicatedhsm.json","version":"2.0"}],"x-providerName":"azure.com","x-serviceName":"hardwaresecuritymodules-dedicatedhsm","x-tags":["Azure","Microsoft"]},"security":[{"azure_auth":["user_impersonation"]}],"paths":{"/subscriptions/{subscriptionId}/providers/Microsoft.HardwareSecurityModules/dedicatedHSMs":{"get":{"description":"The List operation gets information about the dedicated HSMs associated with the subscription.","operationId":"DedicatedHsm_ListBySubscription","parameters":[{"description":"Maximum number of results to return.","in":"query","name":"$top","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"},"examples":{"List dedicated HSM devices in a subscription":{"$ref":"#/components/examples/List_dedicated_HSM_devices_in_a_subscription"}}}}},"default":{"description":"The error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DedicatedHsmError"}}}}},"tags":["DedicatedHsms"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HardwareSecurityModules/dedicatedHSMs":{"get":{"description":"The List operation gets information about the dedicated hsms associated with the subscription and within the specified resource group.","operationId":"DedicatedHsm_ListByResourceGroup","parameters":[{"description":"The name of the Resource Group to which the dedicated HSM belongs.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"List dedicated HSM devices in a resource group":{"value":"hsm-group"}}},{"description":"Maximum number of results to return.","in":"query","name":"$top","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"},"examples":{"List dedicated HSM devices in a resource group":{"$ref":"#/components/examples/List_dedicated_HSM_devices_in_a_resource_group"}}}}},"default":{"description":"The error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DedicatedHsmError"}}}}},"tags":["DedicatedHsms"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HardwareSecurityModules/dedicatedHSMs/{name}":{"delete":{"description":"Deletes the specified Azure Dedicated HSM.","operationId":"DedicatedHsm_Delete","parameters":[{"description":"The name of the Resource Group to which the dedicated HSM belongs.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"Delete a dedicated HSM":{"value":"hsm-group"}}},{"description":"The name of the dedicated HSM to delete","in":"path","name":"name","required":true,"schema":{"type":"string"},"examples":{"Delete a dedicated HSM":{"value":"hsm1"}}},{"$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"}}}}},"tags":["DedicatedHsms"],"x-ms-long-running-operation":true},"get":{"description":"Gets the specified Azure dedicated HSM.","operationId":"DedicatedHsm_Get","parameters":[{"description":"The name of the Resource Group to which the dedicated hsm belongs.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"Get a dedicated HSM":{"value":"hsm-group"}}},{"description":"The name of the dedicated HSM.","in":"path","name":"name","required":true,"schema":{"type":"string"},"examples":{"Get a dedicated HSM":{"value":"hsm1"}}},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"responses":{"200":{"description":"Retrieved dedicated HSM","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DedicatedHsm"},"examples":{"Get a dedicated HSM":{"$ref":"#/components/examples/Get_a_dedicated_HSM"}}}}},"default":{"description":"The error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DedicatedHsmError"}}}}},"tags":["DedicatedHsms"]},"patch":{"description":"Update a dedicated HSM in the specified subscription.","operationId":"DedicatedHsm_Update","parameters":[{"description":"The name of the Resource Group to which the server belongs.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"Update an existing dedicated HSM":{"value":"hsm-group"}}},{"description":"Name of the dedicated HSM","in":"path","name":"name","required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9-]{3,24}$"},"examples":{"Update an existing dedicated HSM":{"value":"hsm1"}}},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DedicatedHsmPatchParameters"}}},"description":"Parameters to patch the dedicated HSM","required":true,"x-ms-client-flatten":true},"responses":{"200":{"description":"Patched dedicated HSM","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DedicatedHsm"},"examples":{"Update an existing dedicated HSM":{"$ref":"#/components/examples/Update_an_existing_dedicated_HSM"}}}}},"default":{"description":"The error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DedicatedHsmError"}}}}},"tags":["DedicatedHsms"],"x-ms-long-running-operation":true},"put":{"description":"Create or Update a dedicated HSM in the specified subscription.","operationId":"DedicatedHsm_CreateOrUpdate","parameters":[{"description":"The name of the Resource Group to which the resource belongs.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"Create a new or update an existing dedicated HSM":{"value":"hsm-group"}}},{"description":"Name of the dedicated Hsm","in":"path","name":"name","required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9-]{3,24}$"},"examples":{"Create a new or update an existing dedicated HSM":{"value":"hsm1"}}},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DedicatedHsm"}}},"description":"Parameters to create or update the dedicated hsm","required":true},"responses":{"200":{"description":"Created dedicated HSM","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DedicatedHsm"},"examples":{"Create a new or update an existing dedicated HSM":{"$ref":"#/components/examples/Create_a_new_or_update_an_existing_dedicated_HSM"}}}}},"201":{"description":"Created dedicated HSM","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DedicatedHsm"},"examples":{"Create a new or update an existing dedicated HSM":{"$ref":"#/components/examples/Create_a_new_or_update_an_existing_dedicated_HSM"}}}}},"default":{"description":"The error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DedicatedHsmError"}}}}},"tags":["DedicatedHsms"],"x-ms-long-running-operation":true}}},"servers":[{"url":"https://management.azure.com"}],"components":{"examples":{"List_dedicated_HSM_devices_in_a_subscription":{"value":{"nextLink":"https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.HardwareSecurityModules/dedicatedHSMs?api-version=2018-10-31-preview&$skiptoken=dmF1bHQtcGVza3ktanVyeS03MzA3Ng==","value":[{"id":"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.HardwareSecurityModules/dedicatedHSMs/hsm1","location":"westus","name":"hsm1","properties":{"networkProfile":{"networkInterfaces":[{"id":"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/networkInterfaces/hsm_vnic","privateIpAddress":"1.0.0.1"}],"subnet":{"id":"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/virtualNetworks/stamp01/subnets/stamp01"}},"provisioningState":"Succeeded","stampId":"stamp01","statusMessage":"DedicatedHsm device is functional."},"sku":{"name":"SafeNet Luna Network HSM A790"},"tags":{"Dept":"hsm","Environment":"dogfood","Slice":"A"},"type":"Microsoft.HardwareSecurityModules/dedicatedHSMs"},{"id":"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.HardwareSecurityModules/dedicatedHSMs/hsm2","location":"westus","name":"hsm1","properties":{"networkProfile":{"networkInterfaces":[{"id":"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/networkInterfaces/hsm_vnic","privateIpAddress":"1.0.0.2"}],"subnet":{"id":"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/virtualNetworks/stamp01/subnets/stamp01"}},"provisioningState":"Succeeded","stampId":"stamp01","statusMessage":"DedicatedHsm device is functional."},"sku":{"name":"SafeNet Luna Network HSM A790"},"tags":{"Dept":"hsm","Environment":"dogfood","Slice":"B"},"type":"Microsoft.HardwareSecurityModules/dedicatedHSMs"}]}},"List_dedicated_HSM_devices_in_a_resource_group":{"value":{"nextLink":"https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.HardwareSecurityModules/dedicatedHSMs?api-version=2018-10-31-preview&$skiptoken=dmF1bHQtcGVza3ktanVyeS03MzA3Ng==","value":[{"id":"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.HardwareSecurityModules/dedicatedHSMs/hsm1","location":"westus","name":"hsm1","properties":{"networkProfile":{"networkInterfaces":[{"id":"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/networkInterfaces/hsm_vnic","privateIpAddress":"1.0.0.1"}],"subnet":{"id":"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/virtualNetworks/stamp01/subnets/stamp01"}},"provisioningState":"Succeeded","stampId":"stamp01","statusMessage":"DedicatedHsm device is functional."},"sku":{"name":"SafeNet Luna Network HSM A790"},"tags":{"Dept":"hsm","Environment":"dogfood","Slice":"A"},"type":"Microsoft.HardwareSecurityModules/dedicatedHSMs"},{"id":"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.HardwareSecurityModules/dedicatedHSMs/hsm2","location":"westus","name":"hsm1","properties":{"networkProfile":{"networkInterfaces":[{"id":"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/networkInterfaces/hsm_vnic","privateIpAddress":"1.0.0.2"}],"subnet":{"id":"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/virtualNetworks/stamp01/subnets/stamp01"}},"provisioningState":"Succeeded","stampId":"stamp01","statusMessage":"DedicatedHsm device is functional."},"sku":{"name":"SafeNet Luna Network HSM A790"},"tags":{"Dept":"hsm","Environment":"dogfood","Slice":"B"},"type":"Microsoft.HardwareSecurityModules/dedicatedHSMs"}]}},"Get_a_dedicated_HSM":{"value":{"id":"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.HardwareSecurityModules/dedicatedHSMs/hsm1","location":"westus","name":"hsm1","properties":{"networkProfile":{"networkInterfaces":[{"id":"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/networkInterfaces/hsm_vnic","privateIpAddress":"1.0.0.1"}],"subnet":{"id":"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/virtualNetworks/stamp01/subnets/stamp01"}},"provisioningState":"Succeeded","stampId":"stamp01","statusMessage":"DedicatedHsm device is functional."},"sku":{"name":"SafeNet Luna Network HSM A790"},"tags":{"Dept":"hsm","Environment":"dogfood","Slice":"A"},"type":"Microsoft.HardwareSecurityModules/dedicatedHSMs"}},"Update_an_existing_dedicated_HSM":{"value":{"id":"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.HardwareSecurityModules/dedicatedHSMs/hsm1","location":"westus","name":"hsm1","properties":{"networkProfile":{"networkInterfaces":[{"id":"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/networkInterfaces/hsm_vnic","privateIpAddress":"1.0.0.1"}],"subnet":{"id":"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/virtualNetworks/stamp01/subnets/stamp01"}},"provisioningState":"Succeeded","stampId":"stamp01","statusMessage":"DedicatedHsm device is functional."},"sku":{"name":"SafeNet Luna Network HSM A790"},"tags":{"Dept":"hsm","Environment":"dogfood","Slice":"A"},"type":"Microsoft.HardwareSecurityModules/dedicatedHSMs"}},"Create_a_new_or_update_an_existing_dedicated_HSM":{"value":{"id":"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.HardwareSecurityModules/dedicatedHSMs/hsm1","location":"westus","name":"hsm1","properties":{"networkProfile":{"networkInterfaces":[{"id":"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/networkInterfaces/hsm_vnic","privateIpAddress":"1.0.0.1"}],"subnet":{"id":"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/virtualNetworks/stamp01/subnets/stamp01"}},"provisioningState":"Provisioning","stampId":"stamp01","statusMessage":"DedicatedHsm device is being provisioned."},"sku":{"name":"SafeNet Luna Network HSM A790"},"tags":{"Dept":"hsm","Environment":"dogfood"},"type":"Microsoft.HardwareSecurityModules/dedicatedHSMs"}}},"parameters":{"ApiVersionParameter":{"description":"Client Api Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"List dedicated HSM devices in a subscription":{"value":"2018-10-31-preview"},"List dedicated HSM devices in a resource group":{"value":"2018-10-31-preview"},"Delete a dedicated HSM":{"value":"2018-10-31-preview"},"Get a dedicated HSM":{"value":"2018-10-31-preview"},"Update an existing dedicated HSM":{"value":"2018-10-31-preview"},"Create a new or update an existing dedicated HSM":{"value":"2018-10-31-preview"}}},"SubscriptionIdParameter":{"description":"Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"List dedicated HSM devices in a subscription":{"value":"00000000-0000-0000-0000-000000000000"},"List dedicated HSM devices in a resource group":{"value":"00000000-0000-0000-0000-000000000000"},"Delete a dedicated HSM":{"value":"00000000-0000-0000-0000-000000000000"},"Get a dedicated HSM":{"value":"00000000-0000-0000-0000-000000000000"},"Update an existing dedicated HSM":{"value":"00000000-0000-0000-0000-000000000000"},"Create a new or update an existing dedicated HSM":{"value":"00000000-0000-0000-0000-000000000000"}}}},"securitySchemes":{"azure_auth":{"description":"Azure Active Directory OAuth2 Flow","type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://login.microsoftonline.com/common/oauth2/authorize","scopes":{"user_impersonation":"impersonate your user account"}}}}},"schemas":{"ApiEntityReference":{"description":"The API entity reference.","properties":{"id":{"description":"The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...","type":"string"}}},"DedicatedHsm":{"allOf":[{"$ref":"#/components/schemas/Resource"}],"description":"Resource information with extended details.","properties":{"properties":{"$ref":"#/components/schemas/DedicatedHsmProperties"}},"required":["location","sku","properties"]},"DedicatedHsmError":{"description":"The error exception.","properties":{"error":{"$ref":"#/components/schemas/Error"}}},"DedicatedHsmListResult":{"description":"List of dedicated HSMs","properties":{"nextLink":{"description":"The URL to get the next set of dedicated hsms.","type":"string"},"value":{"description":"The list of dedicated HSMs.","items":{"$ref":"#/components/schemas/DedicatedHsm"},"type":"array"}}},"DedicatedHsmPatchParameters":{"description":"Patchable properties of the dedicated HSM","properties":{"tags":{"additionalProperties":{"type":"string"},"description":"Resource tags","type":"object"}}},"DedicatedHsmProperties":{"description":"Properties of the dedicated hsm","properties":{"networkProfile":{"$ref":"#/components/schemas/NetworkProfile"},"provisioningState":{"description":"Provisioning state.","enum":["Succeeded","Provisioning","Allocating","Connecting","Failed","CheckingQuota","Deleting"],"readOnly":true,"type":"string","x-ms-enum":{"modelAsString":true,"name":"JsonWebKeyType","values":[{"description":"The dedicated HSM has been full provisioned.","value":"Succeeded"},{"description":"The dedicated HSM is currently being provisioned.","value":"Provisioning"},{"description":"A device is currently being allocated for the dedicated HSM resource.","value":"Allocating"},{"description":"The dedicated HSM is being connected to the virtual network.","value":"Connecting"},{"description":"Provisioning of the dedicated HSM has failed.","value":"Failed"},{"description":"Validating the subscription has sufficient quota to allocate a dedicated HSM device.","value":"CheckingQuota"},{"description":"The dedicated HSM is currently being deleted.","value":"Deleting"}]}},"stampId":{"description":"This field will be used when RP does not support Availability zones.","type":"string"},"statusMessage":{"description":"Resource Status Message.","readOnly":true,"type":"string"}}},"Error":{"description":"The key vault server error.","properties":{"code":{"description":"The error code.","readOnly":true,"type":"string"},"innererror":{"$ref":"#/components/schemas/Error"},"message":{"description":"The error message.","readOnly":true,"type":"string"}}},"NetworkInterface":{"description":"The network interface definition.","properties":{"id":{"description":"The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...","readOnly":true,"type":"string"},"privateIpAddress":{"description":"Private Ip address of the interface","type":"string"}}},"NetworkProfile":{"properties":{"networkInterfaces":{"description":"Specifies the list of resource Ids for the network interfaces associated with the dedicated HSM.","items":{"$ref":"#/components/schemas/NetworkInterface"},"type":"array"},"subnet":{"$ref":"#/components/schemas/ApiEntityReference"}}},"Resource":{"description":"Dedicated HSM resource","properties":{"id":{"description":"The Azure Resource Manager resource ID for the dedicated HSM.","readOnly":true,"type":"string"},"location":{"description":"The supported Azure location where the dedicated HSM should be created.","type":"string"},"name":{"description":"The name of the dedicated HSM.","readOnly":true,"type":"string"},"sku":{"$ref":"#/components/schemas/Sku"},"tags":{"additionalProperties":{"type":"string"},"description":"Resource tags","type":"object"},"type":{"description":"The resource type of the dedicated HSM.","readOnly":true,"type":"string"},"zones":{"description":"The Dedicated Hsm zones.","items":{"type":"string"},"type":"array"}},"required":["location"],"x-ms-azure-resource":true},"ResourceListResult":{"description":"List of dedicated HSM resources.","properties":{"nextLink":{"description":"The URL to get the next set of dedicated HSM resources.","type":"string"},"value":{"description":"The list of dedicated HSM resources.","items":{"$ref":"#/components/schemas/Resource"},"type":"array"}}},"Sku":{"properties":{"name":{"description":"SKU of the dedicated HSM","enum":["SafeNet Luna Network HSM A790"],"type":"string"}}}}}}