Microsoft.HardwareSecurityModules (stable:2025-03-31)

2025/05/15 • 25 new methods

CloudHsmClusters_CreateOrUpdate (new)
Description :  Create or Update a Cloud HSM Cluster in the specified subscription.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HardwareSecurityModules/cloudHsmClusters/{cloudHsmClusterName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
cloudHsmClusterName:
{
Description: The name of the Cloud HSM Cluster within the specified resource group. Cloud HSM Cluster names must be between 3 and 23 characters in length. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Parameters to create Cloud HSM Cluster ,
Required: True ,
}
{
properties:
{
Description: Properties of the Cloud HSM Cluster ,
Required: False ,
}
{
activationState:
{
Description: State of security domain activation ,
Enum:
{
NotDefined: No description available. ,
NotActivated: No description available. ,
Active: No description available. ,
Failed: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
autoGeneratedDomainNameLabelScope:
{
Description: The Cloud HSM Cluster's auto-generated Domain Name Label Scope ,
Enum:
{
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
NoReuse: No description available. ,
}
,
Required: False ,
}
enum ,
hsms:
{
Description: An array of Cloud HSM Cluster's HSMs ,
Required: False ,
}
[
{
fqdn:
{
Description: FQDN of the Cloud HSM ,
Required: False ,
}
string ,
state:
{
Description: The Cloud HSM State. Values are: Deploying, ConfiguringSlb, Starting, Starting, Failed, Failed, Deleting, DeletingSlbEntry, InitialProvisioning, Updating ,
Required: False ,
}
string ,
stateMessage:
{
Description: The Cloud HSM State message ,
Required: False ,
}
string ,
}
,
]
,
privateEndpointConnections:
{
Description: List of private endpoint connection resources ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
InternalError: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
}
,
etag:
{
Description: Modified whenever there is a change in the state of private endpoint connection. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The Cloud HSM Cluster's provisioningState ,
Enum:
{
Provisioning: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: The Cloud HSM Cluster public network access ,
Enum:
{
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
statusMessage:
{
Description: Cloud HSM Cluster status message ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the Cloud HSM Cluster ,
Required: False ,
}
{
activationState:
{
Description: State of security domain activation ,
Enum:
{
NotDefined: No description available. ,
NotActivated: No description available. ,
Active: No description available. ,
Failed: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
autoGeneratedDomainNameLabelScope:
{
Description: The Cloud HSM Cluster's auto-generated Domain Name Label Scope ,
Enum:
{
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
NoReuse: No description available. ,
}
,
Required: False ,
}
enum ,
hsms:
{
Description: An array of Cloud HSM Cluster's HSMs ,
Required: False ,
}
[
{
fqdn:
{
Description: FQDN of the Cloud HSM ,
Required: False ,
}
string ,
state:
{
Description: The Cloud HSM State. Values are: Deploying, ConfiguringSlb, Starting, Starting, Failed, Failed, Deleting, DeletingSlbEntry, InitialProvisioning, Updating ,
Required: False ,
}
string ,
stateMessage:
{
Description: The Cloud HSM State message ,
Required: False ,
}
string ,
}
,
]
,
privateEndpointConnections:
{
Description: List of private endpoint connection resources ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
InternalError: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
}
,
etag:
{
Description: Modified whenever there is a change in the state of private endpoint connection. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The Cloud HSM Cluster's provisioningState ,
Enum:
{
Provisioning: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: The Cloud HSM Cluster public network access ,
Enum:
{
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
statusMessage:
{
Description: Cloud HSM Cluster status message ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the Cloud HSM Cluster ,
Required: False ,
}
{
activationState:
{
Description: State of security domain activation ,
Enum:
{
NotDefined: No description available. ,
NotActivated: No description available. ,
Active: No description available. ,
Failed: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
autoGeneratedDomainNameLabelScope:
{
Description: The Cloud HSM Cluster's auto-generated Domain Name Label Scope ,
Enum:
{
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
NoReuse: No description available. ,
}
,
Required: False ,
}
enum ,
hsms:
{
Description: An array of Cloud HSM Cluster's HSMs ,
Required: False ,
}
[
{
fqdn:
{
Description: FQDN of the Cloud HSM ,
Required: False ,
}
string ,
state:
{
Description: The Cloud HSM State. Values are: Deploying, ConfiguringSlb, Starting, Starting, Failed, Failed, Deleting, DeletingSlbEntry, InitialProvisioning, Updating ,
Required: False ,
}
string ,
stateMessage:
{
Description: The Cloud HSM State message ,
Required: False ,
}
string ,
}
,
]
,
privateEndpointConnections:
{
Description: List of private endpoint connection resources ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
InternalError: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
}
,
etag:
{
Description: Modified whenever there is a change in the state of private endpoint connection. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The Cloud HSM Cluster's provisioningState ,
Enum:
{
Provisioning: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: The Cloud HSM Cluster public network access ,
Enum:
{
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
statusMessage:
{
Description: Cloud HSM Cluster status message ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CloudHsmClusters_Update (new)
Description :  Update a Cloud HSM Cluster in the specified subscription.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HardwareSecurityModules/cloudHsmClusters/{cloudHsmClusterName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
cloudHsmClusterName:
{
Description: The name of the Cloud HSM Cluster within the specified resource group. Cloud HSM Cluster names must be between 3 and 23 characters in length. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Parameters to create Cloud HSM Cluster ,
Required: True ,
}
{
tags:
{
Description: The Cloud HSM Cluster's tags ,
Required: False ,
}
object ,
identity:
{
Description: Managed service identity (system assigned and/or user assigned identities) ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the Cloud HSM Cluster ,
Required: False ,
}
{
activationState:
{
Description: State of security domain activation ,
Enum:
{
NotDefined: No description available. ,
NotActivated: No description available. ,
Active: No description available. ,
Failed: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
autoGeneratedDomainNameLabelScope:
{
Description: The Cloud HSM Cluster's auto-generated Domain Name Label Scope ,
Enum:
{
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
NoReuse: No description available. ,
}
,
Required: False ,
}
enum ,
hsms:
{
Description: An array of Cloud HSM Cluster's HSMs ,
Required: False ,
}
[
{
fqdn:
{
Description: FQDN of the Cloud HSM ,
Required: False ,
}
string ,
state:
{
Description: The Cloud HSM State. Values are: Deploying, ConfiguringSlb, Starting, Starting, Failed, Failed, Deleting, DeletingSlbEntry, InitialProvisioning, Updating ,
Required: False ,
}
string ,
stateMessage:
{
Description: The Cloud HSM State message ,
Required: False ,
}
string ,
}
,
]
,
privateEndpointConnections:
{
Description: List of private endpoint connection resources ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
InternalError: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
}
,
etag:
{
Description: Modified whenever there is a change in the state of private endpoint connection. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The Cloud HSM Cluster's provisioningState ,
Enum:
{
Provisioning: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: The Cloud HSM Cluster public network access ,
Enum:
{
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
statusMessage:
{
Description: Cloud HSM Cluster status message ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The URI to poll for completion status. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CloudHsmClusters_Get (new)
Description :  Gets the specified Cloud HSM Cluster
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HardwareSecurityModules/cloudHsmClusters/{cloudHsmClusterName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
cloudHsmClusterName:
{
Description: The name of the Cloud HSM Cluster within the specified resource group. Cloud HSM Cluster names must be between 3 and 23 characters in length. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the Cloud HSM Cluster ,
Required: False ,
}
{
activationState:
{
Description: State of security domain activation ,
Enum:
{
NotDefined: No description available. ,
NotActivated: No description available. ,
Active: No description available. ,
Failed: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
autoGeneratedDomainNameLabelScope:
{
Description: The Cloud HSM Cluster's auto-generated Domain Name Label Scope ,
Enum:
{
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
NoReuse: No description available. ,
}
,
Required: False ,
}
enum ,
hsms:
{
Description: An array of Cloud HSM Cluster's HSMs ,
Required: False ,
}
[
{
fqdn:
{
Description: FQDN of the Cloud HSM ,
Required: False ,
}
string ,
state:
{
Description: The Cloud HSM State. Values are: Deploying, ConfiguringSlb, Starting, Starting, Failed, Failed, Deleting, DeletingSlbEntry, InitialProvisioning, Updating ,
Required: False ,
}
string ,
stateMessage:
{
Description: The Cloud HSM State message ,
Required: False ,
}
string ,
}
,
]
,
privateEndpointConnections:
{
Description: List of private endpoint connection resources ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
InternalError: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
}
,
etag:
{
Description: Modified whenever there is a change in the state of private endpoint connection. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The Cloud HSM Cluster's provisioningState ,
Enum:
{
Provisioning: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: The Cloud HSM Cluster public network access ,
Enum:
{
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
statusMessage:
{
Description: Cloud HSM Cluster status message ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CloudHsmClusters_Delete (new)
Description :  Deletes the specified Cloud HSM Cluster
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HardwareSecurityModules/cloudHsmClusters/{cloudHsmClusterName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
cloudHsmClusterName:
{
Description: The name of the Cloud HSM Cluster within the specified resource group. Cloud HSM Cluster names must be between 3 and 23 characters in length. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The URI to poll for completion status. ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CloudHsmClusters_ListByResourceGroup (new)
Description :  The List operation gets information about the Cloud HSM Clusters associated with the subscription and within the specified resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HardwareSecurityModules/cloudHsmClusters
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
$skiptoken:
{
Description: The page-continuation token to use with a paged version of this API ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of Cloud HSM Clusters. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Cloud HSM Cluster ,
Required: False ,
}
{
activationState:
{
Description: State of security domain activation ,
Enum:
{
NotDefined: No description available. ,
NotActivated: No description available. ,
Active: No description available. ,
Failed: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
autoGeneratedDomainNameLabelScope:
{
Description: The Cloud HSM Cluster's auto-generated Domain Name Label Scope ,
Enum:
{
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
NoReuse: No description available. ,
}
,
Required: False ,
}
enum ,
hsms:
{
Description: An array of Cloud HSM Cluster's HSMs ,
Required: False ,
}
[
{
fqdn:
{
Description: FQDN of the Cloud HSM ,
Required: False ,
}
string ,
state:
{
Description: The Cloud HSM State. Values are: Deploying, ConfiguringSlb, Starting, Starting, Failed, Failed, Deleting, DeletingSlbEntry, InitialProvisioning, Updating ,
Required: False ,
}
string ,
stateMessage:
{
Description: The Cloud HSM State message ,
Required: False ,
}
string ,
}
,
]
,
privateEndpointConnections:
{
Description: List of private endpoint connection resources ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
InternalError: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
}
,
etag:
{
Description: Modified whenever there is a change in the state of private endpoint connection. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The Cloud HSM Cluster's provisioningState ,
Enum:
{
Provisioning: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: The Cloud HSM Cluster public network access ,
Enum:
{
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
statusMessage:
{
Description: Cloud HSM Cluster status message ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of Cloud HSM Clusters. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CloudHsmClusters_ListBySubscription (new)
Description :  The List operation gets information about the Cloud HSM Clusters associated with the subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.HardwareSecurityModules/cloudHsmClusters
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
$skiptoken:
{
Description: The page-continuation token to use with a paged version of this API ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of Cloud HSM Clusters. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Cloud HSM Cluster ,
Required: False ,
}
{
activationState:
{
Description: State of security domain activation ,
Enum:
{
NotDefined: No description available. ,
NotActivated: No description available. ,
Active: No description available. ,
Failed: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
autoGeneratedDomainNameLabelScope:
{
Description: The Cloud HSM Cluster's auto-generated Domain Name Label Scope ,
Enum:
{
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
NoReuse: No description available. ,
}
,
Required: False ,
}
enum ,
hsms:
{
Description: An array of Cloud HSM Cluster's HSMs ,
Required: False ,
}
[
{
fqdn:
{
Description: FQDN of the Cloud HSM ,
Required: False ,
}
string ,
state:
{
Description: The Cloud HSM State. Values are: Deploying, ConfiguringSlb, Starting, Starting, Failed, Failed, Deleting, DeletingSlbEntry, InitialProvisioning, Updating ,
Required: False ,
}
string ,
stateMessage:
{
Description: The Cloud HSM State message ,
Required: False ,
}
string ,
}
,
]
,
privateEndpointConnections:
{
Description: List of private endpoint connection resources ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
InternalError: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
}
,
etag:
{
Description: Modified whenever there is a change in the state of private endpoint connection. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The Cloud HSM Cluster's provisioningState ,
Enum:
{
Provisioning: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: The Cloud HSM Cluster public network access ,
Enum:
{
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
statusMessage:
{
Description: Cloud HSM Cluster status message ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of Cloud HSM Clusters. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CloudHsmClusterPrivateLinkResources_ListByCloudHsmCluster (new)
Description :  Gets the private link resources supported for the Cloud Hsm Cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HardwareSecurityModules/cloudHsmClusters/{cloudHsmClusterName}/privateLinkResources
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
cloudHsmClusterName:
{
Description: The name of the Cloud HSM Cluster within the specified resource group. Cloud HSM Cluster names must be between 3 and 23 characters in length. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of private link resources ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupId:
{
Description: The private link resource group id. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The private link resource required member names. ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: The private link resource private link DNS zone name. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results (if there are any). ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CloudHsmClusterPrivateEndpointConnections_Create (new)
Description :  Creates or updates the private endpoint connection for the Cloud Hsm Cluster.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HardwareSecurityModules/cloudHsmClusters/{cloudHsmClusterName}/privateEndpointConnections/{peConnectionName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
cloudHsmClusterName:
{
Description: The name of the Cloud HSM Cluster within the specified resource group. Cloud HSM Cluster names must be between 3 and 23 characters in length. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
peConnectionName:
{
Description: Name of the private endpoint connection associated with the Cloud HSM Cluster. ,
Required: True ,
}
string ,
properties:
{
Description: Parameters of the PrivateEndpointConnection ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
InternalError: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
}
,
etag:
{
Description: Modified whenever there is a change in the state of private endpoint connection. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
InternalError: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
}
,
etag:
{
Description: Modified whenever there is a change in the state of private endpoint connection. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CloudHsmClusterPrivateEndpointConnections_Delete (new)
Description :  Deletes the private endpoint connection for the Cloud Hsm Cluster.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HardwareSecurityModules/cloudHsmClusters/{cloudHsmClusterName}/privateEndpointConnections/{peConnectionName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
cloudHsmClusterName:
{
Description: The name of the Cloud HSM Cluster within the specified resource group. Cloud HSM Cluster names must be between 3 and 23 characters in length. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
peConnectionName:
{
Description: Name of the private endpoint connection associated with the Cloud HSM Cluster. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The URI to poll for completion status. ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CloudHsmClusterPrivateEndpointConnections_Get (new)
Description :  Gets the private endpoint connection for the Cloud Hsm Cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HardwareSecurityModules/cloudHsmClusters/{cloudHsmClusterName}/privateEndpointConnections/{peConnectionName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
cloudHsmClusterName:
{
Description: The name of the Cloud HSM Cluster within the specified resource group. Cloud HSM Cluster names must be between 3 and 23 characters in length. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
peConnectionName:
{
Description: Name of the private endpoint connection associated with the Cloud HSM Cluster. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
InternalError: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
}
,
etag:
{
Description: Modified whenever there is a change in the state of private endpoint connection. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_ListByCloudHsmCluster (new)
Description :  The List operation gets information about the private endpoint connections associated with the Cloud HSM Cluster
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HardwareSecurityModules/cloudHsmClusters/{cloudHsmClusterName}/privateEndpointConnections
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
cloudHsmClusterName:
{
Description: The name of the Cloud HSM Cluster within the specified resource group. Cloud HSM Cluster names must be between 3 and 23 characters in length. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
InternalError: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
}
,
etag:
{
Description: Modified whenever there is a change in the state of private endpoint connection. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of private endpoint connections. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CloudHsmClusters_ValidateBackupProperties (new)
Description :  Pre Backup operation to validate whether the customer can perform a backup on the Cloud HSM Cluster resource in the specified subscription.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HardwareSecurityModules/cloudHsmClusters/{cloudHsmClusterName}/validateBackupProperties
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
cloudHsmClusterName:
{
Description: The name of the Cloud HSM Cluster within the specified resource group. Cloud HSM Cluster names must be between 3 and 23 characters in length. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
backupRequestProperties:
{
Description: Backup Operation Required properties ,
Required: False ,
}
object ,
}

⚐ Response (200)

{
$headers:
{
x-ms-request-id:
{
Description: A unique ID for the current operation, service generated. All the resource providers must return this value in the response headers to facilitate debugging. ,
}
string ,
}
,
$schema:
{
Description: Backup operation Result ,
}
{
properties:
{
Description: Properties of the Cloud HSM Cluster ,
Required: False ,
}
{
azureStorageBlobContainerUri:
{
Description: The Azure blob storage container Uri which contains the backup ,
Format: uri ,
Required: False ,
}
string ,
backupId:
{
Description: The ID of the backup. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{
retry-after:
{
Description: The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation. ,
}
integer ,
azure-asyncoperation:
{
Description: The URI to poll for completion status ,
}
string ,
location:
{
Description: The URI to poll for completion status ,
}
string ,
x-ms-request-id:
{
Description: A unique ID for the current operation, service generated. All the resource providers must return this value in the response headers to facilitate debugging. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CloudHsmClusters_Backup (new)
Description :  Create a backup of the Cloud HSM Cluster in the specified subscription
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HardwareSecurityModules/cloudHsmClusters/{cloudHsmClusterName}/backup
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
cloudHsmClusterName:
{
Description: The name of the Cloud HSM Cluster within the specified resource group. Cloud HSM Cluster names must be between 3 and 23 characters in length. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
backupRequestProperties:
{
Description: Azure storage Resource Uri ,
Required: False ,
}
object ,
}

⚐ Response (200)

{
$headers:
{
x-ms-request-id:
{
Description: A unique ID for the current operation, service generated. All the resource providers must return this value in the response headers to facilitate debugging. ,
}
string ,
}
,
$schema:
{
Description: Backup operation Result ,
}
{
properties:
{
Description: Properties of the Cloud HSM Cluster ,
Required: False ,
}
{
azureStorageBlobContainerUri:
{
Description: The Azure blob storage container Uri which contains the backup ,
Format: uri ,
Required: False ,
}
string ,
backupId:
{
Description: The ID of the backup. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{
retry-after:
{
Description: The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation. ,
}
integer ,
azure-asyncoperation:
{
Description: The URI to poll for completion status. ,
}
string ,
location:
{
Description: The URI to poll for completion status ,
}
string ,
x-ms-request-id:
{
Description: A unique ID for the current operation, service generated. All the resource providers must return this value in the response headers to facilitate debugging. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CloudHsmClusterBackupStatus_Get (new)
Description :  Gets the backup operation status of the specified Cloud HSM Cluster
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HardwareSecurityModules/cloudHsmClusters/{cloudHsmClusterName}/backupOperationStatus/{jobId}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
cloudHsmClusterName:
{
Description: The name of the Cloud HSM Cluster within the specified resource group. Cloud HSM Cluster names must be between 3 and 23 characters in length. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
jobId:
{
Description: The id returned as part of the backup request ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-request-id:
{
Description: A unique ID for the current operation, service generated. All the resource providers must return this value in the response headers to facilitate debugging. ,
}
string ,
}
,
$schema:
{
Description: Backup operation Result ,
}
{
properties:
{
Description: Properties of the Cloud HSM Cluster ,
Required: False ,
}
{
azureStorageBlobContainerUri:
{
Description: The Azure blob storage container Uri which contains the backup ,
Format: uri ,
Required: False ,
}
string ,
backupId:
{
Description: The ID of the backup. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{
x-ms-request-id:
{
Description: A unique ID for the current operation, service generated. All the resource providers must return this value in the response headers to facilitate debugging. ,
}
string ,
location:
{
Description: The URI to poll for completion status ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-request-id:
{
Description: A unique ID for the current operation, service generated. All the resource providers must return this value in the response headers to facilitate debugging. ,
}
string ,
}
,
$schema:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.). ,
}
{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}
CloudHsmClusters_ValidateRestoreProperties (new)
Description :  Queued validating pre restore operation
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HardwareSecurityModules/cloudHsmClusters/{cloudHsmClusterName}/validateRestoreProperties
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
cloudHsmClusterName:
{
Description: The name of the Cloud HSM Cluster within the specified resource group. Cloud HSM Cluster names must be between 3 and 23 characters in length. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
restoreRequestProperties:
{
Description: Optional Parameters to validate prior performing a restore operation. ,
Required: False ,
}
{
backupId:
{
Description: An autogenerated unique string ID for labeling the backup. It contains both a UUID and a date timestamp. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
$headers:
{
x-ms-request-id:
{
Description: A unique ID for the current operation, service generated. All the resource providers must return this value in the response headers to facilitate debugging. ,
}
string ,
}
,
$schema:
{
Description: Restore operation properties ,
}
{
properties:
{
Description: Backup and Restore operation common properties ,
Required: False ,
}
{
status:
{
Description: Status of the backup/restore operation ,
Enum:
{
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: The status details of backup/restore operation ,
Required: False ,
}
string ,
error:
{
Description: Error encountered, if any, during the backup/restore operation. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
startTime:
{
Description: The start time of the backup/restore operation in UTC ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of the backup/restore operation in UTC ,
Format: date-time ,
Required: False ,
}
string ,
jobId:
{
Description: Identifier for the backup/restore operation. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{
retry-after:
{
Description: The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation. ,
}
integer ,
azure-asyncoperation:
{
Description: The URI to poll for completion status. ,
}
string ,
location:
{
Description: The URI to poll for completion status ,
}
string ,
x-ms-request-id:
{
Description: A unique ID for the current operation, service generated. All the resource providers must return this value in the response headers to facilitate debugging. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CloudHsmClusters_Restore (new)
Description :  Restores all key materials of a specified Cloud HSM Cluster
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HardwareSecurityModules/cloudHsmClusters/{cloudHsmClusterName}/restore
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
cloudHsmClusterName:
{
Description: The name of the Cloud HSM Cluster within the specified resource group. Cloud HSM Cluster names must be between 3 and 23 characters in length. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
restoreRequestProperties:
{
Description: Restore Operation Required properties ,
Required: True ,
}
{
backupId:
{
Description: An autogenerated unique string ID for labeling the backup. It contains both a UUID and a date timestamp. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
$headers:
{
x-ms-request-id:
{
Description: A unique ID for the current operation, service generated. All the resource providers must return this value in the response headers to facilitate debugging. ,
}
string ,
}
,
$schema:
{
Description: Restore operation properties ,
}
{
properties:
{
Description: Backup and Restore operation common properties ,
Required: False ,
}
{
status:
{
Description: Status of the backup/restore operation ,
Enum:
{
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: The status details of backup/restore operation ,
Required: False ,
}
string ,
error:
{
Description: Error encountered, if any, during the backup/restore operation. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
startTime:
{
Description: The start time of the backup/restore operation in UTC ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of the backup/restore operation in UTC ,
Format: date-time ,
Required: False ,
}
string ,
jobId:
{
Description: Identifier for the backup/restore operation. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{
retry-after:
{
Description: The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation. ,
}
integer ,
azure-asyncoperation:
{
Description: The URI to poll for completion status. ,
}
string ,
location:
{
Description: The URI to poll for completion status ,
}
string ,
x-ms-request-id:
{
Description: A unique ID for the current operation, service generated. All the resource providers must return this value in the response headers to facilitate debugging. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CloudHsmClusterRestoreStatus_Get (new)
Description :  Gets the restore operation status of the specified Cloud HSM Cluster
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HardwareSecurityModules/cloudHsmClusters/{cloudHsmClusterName}/restoreOperationStatus/{jobId}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
cloudHsmClusterName:
{
Description: The name of the Cloud HSM Cluster within the specified resource group. Cloud HSM Cluster names must be between 3 and 23 characters in length. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
jobId:
{
Description: The id returned as part of the backup request ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-request-id:
{
Description: A unique ID for the current operation, service generated. All the resource providers must return this value in the response headers to facilitate debugging. ,
}
string ,
}
,
$schema:
{
Description: Restore operation properties ,
}
{
properties:
{
Description: Backup and Restore operation common properties ,
Required: False ,
}
{
status:
{
Description: Status of the backup/restore operation ,
Enum:
{
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: The status details of backup/restore operation ,
Required: False ,
}
string ,
error:
{
Description: Error encountered, if any, during the backup/restore operation. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
startTime:
{
Description: The start time of the backup/restore operation in UTC ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of the backup/restore operation in UTC ,
Format: date-time ,
Required: False ,
}
string ,
jobId:
{
Description: Identifier for the backup/restore operation. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{
x-ms-request-id:
{
Description: A unique ID for the current operation, service generated. All the resource providers must return this value in the response headers to facilitate debugging. ,
}
string ,
location:
{
Description: The URI to poll for completion status ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-request-id:
{
Description: A unique ID for the current operation, service generated. All the resource providers must return this value in the response headers to facilitate debugging. ,
}
string ,
}
,
$schema:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.). ,
}
{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}
DedicatedHsm_CreateOrUpdate (new)
Description :  Create or Update a dedicated HSM in the specified subscription.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HardwareSecurityModules/dedicatedHSMs/{name}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
name:
{
Description: Name of the dedicated Hsm ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters to create or update the dedicated hsm ,
Required: True ,
}
{
sku:
{
Description: SKU details ,
Required: True ,
}
{
name:
{
Description: SKU of the dedicated HSM ,
Enum:
{
SafeNet Luna Network HSM A790: The dedicated HSM is a Safenet Luna Network HSM A790 device. ,
payShield10K_LMK1_CPS60: 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. ,
payShield10K_LMK1_CPS250: 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. ,
payShield10K_LMK1_CPS2500: 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. ,
payShield10K_LMK2_CPS60: 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. ,
payShield10K_LMK2_CPS250: 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. ,
payShield10K_LMK2_CPS2500: 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. ,
}
,
Required: False ,
}
enum ,
}
,
zones:
{
Description: The Dedicated Hsm zones. ,
Required: False ,
}
[
string ,
]
,
properties:
{
Description: Properties of the dedicated HSM ,
Required: True ,
}
{
networkProfile:
{
Description: Specifies the network interfaces of the dedicated hsm. ,
Required: False ,
}
{
subnet:
{
Description: Specifies the identifier of the subnet. ,
Required: False ,
}
{
resourceId:
{
Description: The Azure resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
networkInterfaces:
{
Description: Specifies the list of resource Ids for the network interfaces associated with the dedicated HSM. ,
Required: False ,
}
[
{
resourceId:
{
Description: The Azure resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Format: arm-id ,
Required: False ,
}
string ,
privateIpAddress:
{
Description: Private Ip address of the interface ,
Required: False ,
}
string ,
}
,
]
,
}
,
managementNetworkProfile:
{
Description: Specifies the management network interfaces of the dedicated hsm. ,
Required: False ,
}
{
subnet:
{
Description: Specifies the identifier of the subnet. ,
Required: False ,
}
{
resourceId:
{
Description: The Azure resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
networkInterfaces:
{
Description: Specifies the list of resource Ids for the network interfaces associated with the dedicated HSM. ,
Required: False ,
}
[
{
resourceId:
{
Description: The Azure resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Format: arm-id ,
Required: False ,
}
string ,
privateIpAddress:
{
Description: Private Ip address of the interface ,
Required: False ,
}
string ,
}
,
]
,
}
,
stampId:
{
Description: This field will be used when RP does not support Availability zones. ,
Required: False ,
}
string ,
statusMessage:
{
Description: Resource Status Message. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state. ,
Enum:
{
Succeeded: The dedicated HSM has been fully provisioned. ,
Provisioning: The dedicated HSM is currently being provisioned. ,
Allocating: A device is currently being allocated for the dedicated HSM resource. ,
Connecting: The dedicated HSM is being connected to the virtual network. ,
Failed: Provisioning of the dedicated HSM has failed. ,
CheckingQuota: Validating the subscription has sufficient quota to allocate a dedicated HSM device. ,
Deleting: The dedicated HSM is currently being deleted. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
sku:
{
Description: SKU details ,
Required: True ,
}
{
name:
{
Description: SKU of the dedicated HSM ,
Enum:
{
SafeNet Luna Network HSM A790: The dedicated HSM is a Safenet Luna Network HSM A790 device. ,
payShield10K_LMK1_CPS60: 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. ,
payShield10K_LMK1_CPS250: 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. ,
payShield10K_LMK1_CPS2500: 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. ,
payShield10K_LMK2_CPS60: 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. ,
payShield10K_LMK2_CPS250: 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. ,
payShield10K_LMK2_CPS2500: 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. ,
}
,
Required: False ,
}
enum ,
}
,
zones:
{
Description: The Dedicated Hsm zones. ,
Required: False ,
}
[
string ,
]
,
properties:
{
Description: Properties of the dedicated HSM ,
Required: True ,
}
{
networkProfile:
{
Description: Specifies the network interfaces of the dedicated hsm. ,
Required: False ,
}
{
subnet:
{
Description: Specifies the identifier of the subnet. ,
Required: False ,
}
{
resourceId:
{
Description: The Azure resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
networkInterfaces:
{
Description: Specifies the list of resource Ids for the network interfaces associated with the dedicated HSM. ,
Required: False ,
}
[
{
resourceId:
{
Description: The Azure resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Format: arm-id ,
Required: False ,
}
string ,
privateIpAddress:
{
Description: Private Ip address of the interface ,
Required: False ,
}
string ,
}
,
]
,
}
,
managementNetworkProfile:
{
Description: Specifies the management network interfaces of the dedicated hsm. ,
Required: False ,
}
{
subnet:
{
Description: Specifies the identifier of the subnet. ,
Required: False ,
}
{
resourceId:
{
Description: The Azure resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
networkInterfaces:
{
Description: Specifies the list of resource Ids for the network interfaces associated with the dedicated HSM. ,
Required: False ,
}
[
{
resourceId:
{
Description: The Azure resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Format: arm-id ,
Required: False ,
}
string ,
privateIpAddress:
{
Description: Private Ip address of the interface ,
Required: False ,
}
string ,
}
,
]
,
}
,
stampId:
{
Description: This field will be used when RP does not support Availability zones. ,
Required: False ,
}
string ,
statusMessage:
{
Description: Resource Status Message. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state. ,
Enum:
{
Succeeded: The dedicated HSM has been fully provisioned. ,
Provisioning: The dedicated HSM is currently being provisioned. ,
Allocating: A device is currently being allocated for the dedicated HSM resource. ,
Connecting: The dedicated HSM is being connected to the virtual network. ,
Failed: Provisioning of the dedicated HSM has failed. ,
CheckingQuota: Validating the subscription has sufficient quota to allocate a dedicated HSM device. ,
Deleting: The dedicated HSM is currently being deleted. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
sku:
{
Description: SKU details ,
Required: True ,
}
{
name:
{
Description: SKU of the dedicated HSM ,
Enum:
{
SafeNet Luna Network HSM A790: The dedicated HSM is a Safenet Luna Network HSM A790 device. ,
payShield10K_LMK1_CPS60: 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. ,
payShield10K_LMK1_CPS250: 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. ,
payShield10K_LMK1_CPS2500: 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. ,
payShield10K_LMK2_CPS60: 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. ,
payShield10K_LMK2_CPS250: 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. ,
payShield10K_LMK2_CPS2500: 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. ,
}
,
Required: False ,
}
enum ,
}
,
zones:
{
Description: The Dedicated Hsm zones. ,
Required: False ,
}
[
string ,
]
,
properties:
{
Description: Properties of the dedicated HSM ,
Required: True ,
}
{
networkProfile:
{
Description: Specifies the network interfaces of the dedicated hsm. ,
Required: False ,
}
{
subnet:
{
Description: Specifies the identifier of the subnet. ,
Required: False ,
}
{
resourceId:
{
Description: The Azure resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
networkInterfaces:
{
Description: Specifies the list of resource Ids for the network interfaces associated with the dedicated HSM. ,
Required: False ,
}
[
{
resourceId:
{
Description: The Azure resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Format: arm-id ,
Required: False ,
}
string ,
privateIpAddress:
{
Description: Private Ip address of the interface ,
Required: False ,
}
string ,
}
,
]
,
}
,
managementNetworkProfile:
{
Description: Specifies the management network interfaces of the dedicated hsm. ,
Required: False ,
}
{
subnet:
{
Description: Specifies the identifier of the subnet. ,
Required: False ,
}
{
resourceId:
{
Description: The Azure resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
networkInterfaces:
{
Description: Specifies the list of resource Ids for the network interfaces associated with the dedicated HSM. ,
Required: False ,
}
[
{
resourceId:
{
Description: The Azure resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Format: arm-id ,
Required: False ,
}
string ,
privateIpAddress:
{
Description: Private Ip address of the interface ,
Required: False ,
}
string ,
}
,
]
,
}
,
stampId:
{
Description: This field will be used when RP does not support Availability zones. ,
Required: False ,
}
string ,
statusMessage:
{
Description: Resource Status Message. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state. ,
Enum:
{
Succeeded: The dedicated HSM has been fully provisioned. ,
Provisioning: The dedicated HSM is currently being provisioned. ,
Allocating: A device is currently being allocated for the dedicated HSM resource. ,
Connecting: The dedicated HSM is being connected to the virtual network. ,
Failed: Provisioning of the dedicated HSM has failed. ,
CheckingQuota: Validating the subscription has sufficient quota to allocate a dedicated HSM device. ,
Deleting: The dedicated HSM is currently being deleted. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error detail of the operation if any. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
DedicatedHsm_Update (new)
Description :  Update a dedicated HSM in the specified subscription.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HardwareSecurityModules/dedicatedHSMs/{name}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
name:
{
Description: Name of the dedicated Hsm ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters to patch the dedicated HSM ,
Required: True ,
}
{
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: SKU details ,
Required: True ,
}
{
name:
{
Description: SKU of the dedicated HSM ,
Enum:
{
SafeNet Luna Network HSM A790: The dedicated HSM is a Safenet Luna Network HSM A790 device. ,
payShield10K_LMK1_CPS60: 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. ,
payShield10K_LMK1_CPS250: 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. ,
payShield10K_LMK1_CPS2500: 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. ,
payShield10K_LMK2_CPS60: 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. ,
payShield10K_LMK2_CPS250: 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. ,
payShield10K_LMK2_CPS2500: 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. ,
}
,
Required: False ,
}
enum ,
}
,
zones:
{
Description: The Dedicated Hsm zones. ,
Required: False ,
}
[
string ,
]
,
properties:
{
Description: Properties of the dedicated HSM ,
Required: True ,
}
{
networkProfile:
{
Description: Specifies the network interfaces of the dedicated hsm. ,
Required: False ,
}
{
subnet:
{
Description: Specifies the identifier of the subnet. ,
Required: False ,
}
{
resourceId:
{
Description: The Azure resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
networkInterfaces:
{
Description: Specifies the list of resource Ids for the network interfaces associated with the dedicated HSM. ,
Required: False ,
}
[
{
resourceId:
{
Description: The Azure resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Format: arm-id ,
Required: False ,
}
string ,
privateIpAddress:
{
Description: Private Ip address of the interface ,
Required: False ,
}
string ,
}
,
]
,
}
,
managementNetworkProfile:
{
Description: Specifies the management network interfaces of the dedicated hsm. ,
Required: False ,
}
{
subnet:
{
Description: Specifies the identifier of the subnet. ,
Required: False ,
}
{
resourceId:
{
Description: The Azure resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
networkInterfaces:
{
Description: Specifies the list of resource Ids for the network interfaces associated with the dedicated HSM. ,
Required: False ,
}
[
{
resourceId:
{
Description: The Azure resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Format: arm-id ,
Required: False ,
}
string ,
privateIpAddress:
{
Description: Private Ip address of the interface ,
Required: False ,
}
string ,
}
,
]
,
}
,
stampId:
{
Description: This field will be used when RP does not support Availability zones. ,
Required: False ,
}
string ,
statusMessage:
{
Description: Resource Status Message. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state. ,
Enum:
{
Succeeded: The dedicated HSM has been fully provisioned. ,
Provisioning: The dedicated HSM is currently being provisioned. ,
Allocating: A device is currently being allocated for the dedicated HSM resource. ,
Connecting: The dedicated HSM is being connected to the virtual network. ,
Failed: Provisioning of the dedicated HSM has failed. ,
CheckingQuota: Validating the subscription has sufficient quota to allocate a dedicated HSM device. ,
Deleting: The dedicated HSM is currently being deleted. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The URI to poll for completion status. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error detail of the operation if any. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
DedicatedHsm_Delete (new)
Description :  Deletes the specified Azure Dedicated HSM.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HardwareSecurityModules/dedicatedHSMs/{name}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
name:
{
Description: Name of the dedicated Hsm ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The URI to poll for completion status. ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error detail of the operation if any. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
DedicatedHsm_Get (new)
Description :  Gets the specified Azure dedicated HSM.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HardwareSecurityModules/dedicatedHSMs/{name}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
name:
{
Description: Name of the dedicated Hsm ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: SKU details ,
Required: True ,
}
{
name:
{
Description: SKU of the dedicated HSM ,
Enum:
{
SafeNet Luna Network HSM A790: The dedicated HSM is a Safenet Luna Network HSM A790 device. ,
payShield10K_LMK1_CPS60: 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. ,
payShield10K_LMK1_CPS250: 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. ,
payShield10K_LMK1_CPS2500: 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. ,
payShield10K_LMK2_CPS60: 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. ,
payShield10K_LMK2_CPS250: 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. ,
payShield10K_LMK2_CPS2500: 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. ,
}
,
Required: False ,
}
enum ,
}
,
zones:
{
Description: The Dedicated Hsm zones. ,
Required: False ,
}
[
string ,
]
,
properties:
{
Description: Properties of the dedicated HSM ,
Required: True ,
}
{
networkProfile:
{
Description: Specifies the network interfaces of the dedicated hsm. ,
Required: False ,
}
{
subnet:
{
Description: Specifies the identifier of the subnet. ,
Required: False ,
}
{
resourceId:
{
Description: The Azure resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
networkInterfaces:
{
Description: Specifies the list of resource Ids for the network interfaces associated with the dedicated HSM. ,
Required: False ,
}
[
{
resourceId:
{
Description: The Azure resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Format: arm-id ,
Required: False ,
}
string ,
privateIpAddress:
{
Description: Private Ip address of the interface ,
Required: False ,
}
string ,
}
,
]
,
}
,
managementNetworkProfile:
{
Description: Specifies the management network interfaces of the dedicated hsm. ,
Required: False ,
}
{
subnet:
{
Description: Specifies the identifier of the subnet. ,
Required: False ,
}
{
resourceId:
{
Description: The Azure resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
networkInterfaces:
{
Description: Specifies the list of resource Ids for the network interfaces associated with the dedicated HSM. ,
Required: False ,
}
[
{
resourceId:
{
Description: The Azure resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Format: arm-id ,
Required: False ,
}
string ,
privateIpAddress:
{
Description: Private Ip address of the interface ,
Required: False ,
}
string ,
}
,
]
,
}
,
stampId:
{
Description: This field will be used when RP does not support Availability zones. ,
Required: False ,
}
string ,
statusMessage:
{
Description: Resource Status Message. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state. ,
Enum:
{
Succeeded: The dedicated HSM has been fully provisioned. ,
Provisioning: The dedicated HSM is currently being provisioned. ,
Allocating: A device is currently being allocated for the dedicated HSM resource. ,
Connecting: The dedicated HSM is being connected to the virtual network. ,
Failed: Provisioning of the dedicated HSM has failed. ,
CheckingQuota: Validating the subscription has sufficient quota to allocate a dedicated HSM device. ,
Deleting: The dedicated HSM is currently being deleted. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error detail of the operation if any. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
DedicatedHsm_ListByResourceGroup (new)
Description :  The List operation gets information about the dedicated hsms associated with the subscription and within the specified resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HardwareSecurityModules/dedicatedHSMs
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
$top:
{
Description: Maximum number of results to return. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of dedicated HSMs. ,
Required: False ,
}
[
{
sku:
{
Description: SKU details ,
Required: True ,
}
{
name:
{
Description: SKU of the dedicated HSM ,
Enum:
{
SafeNet Luna Network HSM A790: The dedicated HSM is a Safenet Luna Network HSM A790 device. ,
payShield10K_LMK1_CPS60: 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. ,
payShield10K_LMK1_CPS250: 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. ,
payShield10K_LMK1_CPS2500: 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. ,
payShield10K_LMK2_CPS60: 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. ,
payShield10K_LMK2_CPS250: 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. ,
payShield10K_LMK2_CPS2500: 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. ,
}
,
Required: False ,
}
enum ,
}
,
zones:
{
Description: The Dedicated Hsm zones. ,
Required: False ,
}
[
string ,
]
,
properties:
{
Description: Properties of the dedicated HSM ,
Required: True ,
}
{
networkProfile:
{
Description: Specifies the network interfaces of the dedicated hsm. ,
Required: False ,
}
{
subnet:
{
Description: Specifies the identifier of the subnet. ,
Required: False ,
}
{
resourceId:
{
Description: The Azure resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
networkInterfaces:
{
Description: Specifies the list of resource Ids for the network interfaces associated with the dedicated HSM. ,
Required: False ,
}
[
{
resourceId:
{
Description: The Azure resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Format: arm-id ,
Required: False ,
}
string ,
privateIpAddress:
{
Description: Private Ip address of the interface ,
Required: False ,
}
string ,
}
,
]
,
}
,
managementNetworkProfile:
{
Description: Specifies the management network interfaces of the dedicated hsm. ,
Required: False ,
}
{
subnet:
{
Description: Specifies the identifier of the subnet. ,
Required: False ,
}
{
resourceId:
{
Description: The Azure resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
networkInterfaces:
{
Description: Specifies the list of resource Ids for the network interfaces associated with the dedicated HSM. ,
Required: False ,
}
[
{
resourceId:
{
Description: The Azure resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Format: arm-id ,
Required: False ,
}
string ,
privateIpAddress:
{
Description: Private Ip address of the interface ,
Required: False ,
}
string ,
}
,
]
,
}
,
stampId:
{
Description: This field will be used when RP does not support Availability zones. ,
Required: False ,
}
string ,
statusMessage:
{
Description: Resource Status Message. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state. ,
Enum:
{
Succeeded: The dedicated HSM has been fully provisioned. ,
Provisioning: The dedicated HSM is currently being provisioned. ,
Allocating: A device is currently being allocated for the dedicated HSM resource. ,
Connecting: The dedicated HSM is being connected to the virtual network. ,
Failed: Provisioning of the dedicated HSM has failed. ,
CheckingQuota: Validating the subscription has sufficient quota to allocate a dedicated HSM device. ,
Deleting: The dedicated HSM is currently being deleted. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of dedicated hsms. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error detail of the operation if any. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
DedicatedHsm_ListBySubscription (new)
Description :  The List operation gets information about the dedicated HSMs associated with the subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.HardwareSecurityModules/dedicatedHSMs
{
$top:
{
Description: Maximum number of results to return. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of dedicated HSMs. ,
Required: False ,
}
[
{
sku:
{
Description: SKU details ,
Required: True ,
}
{
name:
{
Description: SKU of the dedicated HSM ,
Enum:
{
SafeNet Luna Network HSM A790: The dedicated HSM is a Safenet Luna Network HSM A790 device. ,
payShield10K_LMK1_CPS60: 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. ,
payShield10K_LMK1_CPS250: 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. ,
payShield10K_LMK1_CPS2500: 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. ,
payShield10K_LMK2_CPS60: 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. ,
payShield10K_LMK2_CPS250: 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. ,
payShield10K_LMK2_CPS2500: 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. ,
}
,
Required: False ,
}
enum ,
}
,
zones:
{
Description: The Dedicated Hsm zones. ,
Required: False ,
}
[
string ,
]
,
properties:
{
Description: Properties of the dedicated HSM ,
Required: True ,
}
{
networkProfile:
{
Description: Specifies the network interfaces of the dedicated hsm. ,
Required: False ,
}
{
subnet:
{
Description: Specifies the identifier of the subnet. ,
Required: False ,
}
{
resourceId:
{
Description: The Azure resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
networkInterfaces:
{
Description: Specifies the list of resource Ids for the network interfaces associated with the dedicated HSM. ,
Required: False ,
}
[
{
resourceId:
{
Description: The Azure resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Format: arm-id ,
Required: False ,
}
string ,
privateIpAddress:
{
Description: Private Ip address of the interface ,
Required: False ,
}
string ,
}
,
]
,
}
,
managementNetworkProfile:
{
Description: Specifies the management network interfaces of the dedicated hsm. ,
Required: False ,
}
{
subnet:
{
Description: Specifies the identifier of the subnet. ,
Required: False ,
}
{
resourceId:
{
Description: The Azure resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
networkInterfaces:
{
Description: Specifies the list of resource Ids for the network interfaces associated with the dedicated HSM. ,
Required: False ,
}
[
{
resourceId:
{
Description: The Azure resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Format: arm-id ,
Required: False ,
}
string ,
privateIpAddress:
{
Description: Private Ip address of the interface ,
Required: False ,
}
string ,
}
,
]
,
}
,
stampId:
{
Description: This field will be used when RP does not support Availability zones. ,
Required: False ,
}
string ,
statusMessage:
{
Description: Resource Status Message. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state. ,
Enum:
{
Succeeded: The dedicated HSM has been fully provisioned. ,
Provisioning: The dedicated HSM is currently being provisioned. ,
Allocating: A device is currently being allocated for the dedicated HSM resource. ,
Connecting: The dedicated HSM is being connected to the virtual network. ,
Failed: Provisioning of the dedicated HSM has failed. ,
CheckingQuota: Validating the subscription has sufficient quota to allocate a dedicated HSM device. ,
Deleting: The dedicated HSM is currently being deleted. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of dedicated hsms. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error detail of the operation if any. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
DedicatedHsm_ListOutboundNetworkDependenciesEndpoints (new)
Description :  Gets a list of egress endpoints (network endpoints of all outbound dependencies) in the specified dedicated hsm resource. The operation returns properties of each egress endpoint.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HardwareSecurityModules/dedicatedHSMs/{name}/outboundNetworkDependenciesEndpoints
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
name:
{
Description: Name of the dedicated Hsm ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
category:
{
Description: The category of endpoints accessed by the dedicated hsm service, e.g. azure-resource-management, apiserver, etc. ,
Required: False ,
}
string ,
endpoints:
{
Description: The endpoints that dedicated hsm service connects to ,
Required: False ,
}
[
{
domainName:
{
Description: The domain name of the dependency. ,
Required: False ,
}
string ,
endpointDetails:
{
Description: The Ports and Protocols used when connecting to domainName. ,
Required: False ,
}
[
{
ipAddress:
{
Description: An IP Address that Domain Name currently resolves to. ,
Required: False ,
}
string ,
port:
{
Description: The port an endpoint is connected to. ,
Format: int32 ,
Required: False ,
}
integer ,
protocol:
{
Description: The protocol used for connection ,
Required: False ,
}
string ,
description:
{
Description: Description of the detail ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error detail of the operation if any. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
Operations_List (new)
Description :  Get a list of Hardware Security Modules operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.HardwareSecurityModules/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" ,
Required: False ,
}
string ,
isDataAction:
{
Description: Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Localized display information for this particular operation. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". ,
Required: False ,
}
string ,
operation:
{
Description: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". ,
Required: False ,
}
string ,
description:
{
Description: The short, localized friendly description of the operation; suitable for tool tips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
actionType:
{
Description: Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. ,
Enum:
{
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results (if there are any). ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}