Microsoft.HardwareSecurityModules (preview:2022-08-31)

2025/09/05 • 11 new, 11 deleted 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. ,
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 24 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 ,
}
{
provisioningState:
{
Description: The Cloud HSM Cluster's provisioningState ,
Enum:
{
Provisioning: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
autoGeneratedDomainNameLabelScope:
{
Description: The Cloud HSM Cluster's auto-generated Domain Name Label Scope ,
Required: False ,
}
string ,
securityDomain:
{
Description: Security domain properties information for Cloud HSM cluster ,
Required: False ,
}
{
fipsState:
{
Description: FIPS state information for security domain ,
Format: int32 ,
Required: False ,
}
integer ,
activationStatus:
{
Description: status of security domain activation ,
Required: False ,
}
string ,
}
,
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 ,
Required: False ,
}
string ,
stateMessage:
{
Description: The Cloud HSM State message ,
Required: False ,
}
string ,
}
,
]
,
publicNetworkAccess:
{
Description: The Cloud HSM Cluster public network access ,
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 ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the Cloud HSM Cluster ,
Required: False ,
}
{
provisioningState:
{
Description: The Cloud HSM Cluster's provisioningState ,
Enum:
{
Provisioning: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
autoGeneratedDomainNameLabelScope:
{
Description: The Cloud HSM Cluster's auto-generated Domain Name Label Scope ,
Required: False ,
}
string ,
securityDomain:
{
Description: Security domain properties information for Cloud HSM cluster ,
Required: False ,
}
{
fipsState:
{
Description: FIPS state information for security domain ,
Format: int32 ,
Required: False ,
}
integer ,
activationStatus:
{
Description: status of security domain activation ,
Required: False ,
}
string ,
}
,
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 ,
Required: False ,
}
string ,
stateMessage:
{
Description: The Cloud HSM State message ,
Required: False ,
}
string ,
}
,
]
,
publicNetworkAccess:
{
Description: The Cloud HSM Cluster public network access ,
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 ,
}
,
]
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the Cloud HSM Cluster ,
Required: False ,
}
{
provisioningState:
{
Description: The Cloud HSM Cluster's provisioningState ,
Enum:
{
Provisioning: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
autoGeneratedDomainNameLabelScope:
{
Description: The Cloud HSM Cluster's auto-generated Domain Name Label Scope ,
Required: False ,
}
string ,
securityDomain:
{
Description: Security domain properties information for Cloud HSM cluster ,
Required: False ,
}
{
fipsState:
{
Description: FIPS state information for security domain ,
Format: int32 ,
Required: False ,
}
integer ,
activationStatus:
{
Description: status of security domain activation ,
Required: False ,
}
string ,
}
,
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 ,
Required: False ,
}
string ,
stateMessage:
{
Description: The Cloud HSM State message ,
Required: False ,
}
string ,
}
,
]
,
publicNetworkAccess:
{
Description: The Cloud HSM Cluster public network access ,
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 ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error details ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
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. ,
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 24 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 ,
sku:
{
Description: SKU details ,
Required: False ,
}
{
family:
{
Description: Sku family of the Cloud HSM Cluster ,
Enum:
{
B: No description available. ,
}
,
Required: True ,
}
enum ,
name:
{
Description: Sku name of the Cloud HSM Cluster ,
Enum:
{
Standard_B1: No description available. ,
Standard B10: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: Sku capacity ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the Cloud HSM Cluster ,
Required: False ,
}
{
provisioningState:
{
Description: The Cloud HSM Cluster's provisioningState ,
Enum:
{
Provisioning: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
autoGeneratedDomainNameLabelScope:
{
Description: The Cloud HSM Cluster's auto-generated Domain Name Label Scope ,
Required: False ,
}
string ,
securityDomain:
{
Description: Security domain properties information for Cloud HSM cluster ,
Required: False ,
}
{
fipsState:
{
Description: FIPS state information for security domain ,
Format: int32 ,
Required: False ,
}
integer ,
activationStatus:
{
Description: status of security domain activation ,
Required: False ,
}
string ,
}
,
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 ,
Required: False ,
}
string ,
stateMessage:
{
Description: The Cloud HSM State message ,
Required: False ,
}
string ,
}
,
]
,
publicNetworkAccess:
{
Description: The Cloud HSM Cluster public network access ,
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 ,
}
,
]
,
}
,
}

⚐ Response (202)

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

⚐ Response (default)

{
error:
{
Description: Error details ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
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. ,
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 24 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 ,
}
{
provisioningState:
{
Description: The Cloud HSM Cluster's provisioningState ,
Enum:
{
Provisioning: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
autoGeneratedDomainNameLabelScope:
{
Description: The Cloud HSM Cluster's auto-generated Domain Name Label Scope ,
Required: False ,
}
string ,
securityDomain:
{
Description: Security domain properties information for Cloud HSM cluster ,
Required: False ,
}
{
fipsState:
{
Description: FIPS state information for security domain ,
Format: int32 ,
Required: False ,
}
integer ,
activationStatus:
{
Description: status of security domain activation ,
Required: False ,
}
string ,
}
,
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 ,
Required: False ,
}
string ,
stateMessage:
{
Description: The Cloud HSM State message ,
Required: False ,
}
string ,
}
,
]
,
publicNetworkAccess:
{
Description: The Cloud HSM Cluster public network access ,
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 ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error details ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
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. ,
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 24 characters in length. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

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

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Error details ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
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. ,
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 ,
}
{
provisioningState:
{
Description: The Cloud HSM Cluster's provisioningState ,
Enum:
{
Provisioning: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
autoGeneratedDomainNameLabelScope:
{
Description: The Cloud HSM Cluster's auto-generated Domain Name Label Scope ,
Required: False ,
}
string ,
securityDomain:
{
Description: Security domain properties information for Cloud HSM cluster ,
Required: False ,
}
{
fipsState:
{
Description: FIPS state information for security domain ,
Format: int32 ,
Required: False ,
}
integer ,
activationStatus:
{
Description: status of security domain activation ,
Required: False ,
}
string ,
}
,
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 ,
Required: False ,
}
string ,
stateMessage:
{
Description: The Cloud HSM State message ,
Required: False ,
}
string ,
}
,
]
,
publicNetworkAccess:
{
Description: The Cloud HSM Cluster public network access ,
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 ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of Cloud HSM Clusters. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error details ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
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. ,
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 ,
}
{
provisioningState:
{
Description: The Cloud HSM Cluster's provisioningState ,
Enum:
{
Provisioning: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
autoGeneratedDomainNameLabelScope:
{
Description: The Cloud HSM Cluster's auto-generated Domain Name Label Scope ,
Required: False ,
}
string ,
securityDomain:
{
Description: Security domain properties information for Cloud HSM cluster ,
Required: False ,
}
{
fipsState:
{
Description: FIPS state information for security domain ,
Format: int32 ,
Required: False ,
}
integer ,
activationStatus:
{
Description: status of security domain activation ,
Required: False ,
}
string ,
}
,
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 ,
Required: False ,
}
string ,
stateMessage:
{
Description: The Cloud HSM State message ,
Required: False ,
}
string ,
}
,
]
,
publicNetworkAccess:
{
Description: The Cloud HSM Cluster public network access ,
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 ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of Cloud HSM Clusters. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error details ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
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. ,
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 24 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 ,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Error details ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
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. ,
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 24 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: Error details ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
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. ,
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 24 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)

{}

⚐ Response (202)

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

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Error details ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
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. ,
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 24 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: Error details ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
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. ,
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 24 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: Error details ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
CloudHsmClusters_CreateOrUpdate (removed)
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. ,
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 24 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 ,
}
{
provisioningState:
{
Description: The Cloud HSM Cluster's provisioningState ,
Enum:
{
Provisioning: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
autoGeneratedDomainNameLabelScope:
{
Description: The Cloud HSM Cluster's auto-generated Domain Name Label Scope ,
Required: False ,
}
string ,
securityDomain:
{
Description: Security domain properties information for Cloud HSM cluster ,
Required: False ,
}
{
fipsState:
{
Description: FIPS state information for security domain ,
Format: int32 ,
Required: False ,
}
integer ,
activationStatus:
{
Description: status of security domain activation ,
Required: False ,
}
string ,
}
,
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 ,
Required: False ,
}
string ,
stateMessage:
{
Description: The Cloud HSM State message ,
Required: False ,
}
string ,
}
,
]
,
publicNetworkAccess:
{
Description: The Cloud HSM Cluster public network access ,
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 ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the Cloud HSM Cluster ,
Required: False ,
}
{
provisioningState:
{
Description: The Cloud HSM Cluster's provisioningState ,
Enum:
{
Provisioning: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
autoGeneratedDomainNameLabelScope:
{
Description: The Cloud HSM Cluster's auto-generated Domain Name Label Scope ,
Required: False ,
}
string ,
securityDomain:
{
Description: Security domain properties information for Cloud HSM cluster ,
Required: False ,
}
{
fipsState:
{
Description: FIPS state information for security domain ,
Format: int32 ,
Required: False ,
}
integer ,
activationStatus:
{
Description: status of security domain activation ,
Required: False ,
}
string ,
}
,
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 ,
Required: False ,
}
string ,
stateMessage:
{
Description: The Cloud HSM State message ,
Required: False ,
}
string ,
}
,
]
,
publicNetworkAccess:
{
Description: The Cloud HSM Cluster public network access ,
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 ,
}
,
]
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the Cloud HSM Cluster ,
Required: False ,
}
{
provisioningState:
{
Description: The Cloud HSM Cluster's provisioningState ,
Enum:
{
Provisioning: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
autoGeneratedDomainNameLabelScope:
{
Description: The Cloud HSM Cluster's auto-generated Domain Name Label Scope ,
Required: False ,
}
string ,
securityDomain:
{
Description: Security domain properties information for Cloud HSM cluster ,
Required: False ,
}
{
fipsState:
{
Description: FIPS state information for security domain ,
Format: int32 ,
Required: False ,
}
integer ,
activationStatus:
{
Description: status of security domain activation ,
Required: False ,
}
string ,
}
,
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 ,
Required: False ,
}
string ,
stateMessage:
{
Description: The Cloud HSM State message ,
Required: False ,
}
string ,
}
,
]
,
publicNetworkAccess:
{
Description: The Cloud HSM Cluster public network access ,
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 ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error details ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
CloudHsmClusters_Update (removed)
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. ,
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 24 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 ,
sku:
{
Description: SKU details ,
Required: False ,
}
{
family:
{
Description: Sku family of the Cloud HSM Cluster ,
Enum:
{
B: No description available. ,
}
,
Required: True ,
}
enum ,
name:
{
Description: Sku name of the Cloud HSM Cluster ,
Enum:
{
Standard_B1: No description available. ,
Standard B10: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: Sku capacity ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the Cloud HSM Cluster ,
Required: False ,
}
{
provisioningState:
{
Description: The Cloud HSM Cluster's provisioningState ,
Enum:
{
Provisioning: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
autoGeneratedDomainNameLabelScope:
{
Description: The Cloud HSM Cluster's auto-generated Domain Name Label Scope ,
Required: False ,
}
string ,
securityDomain:
{
Description: Security domain properties information for Cloud HSM cluster ,
Required: False ,
}
{
fipsState:
{
Description: FIPS state information for security domain ,
Format: int32 ,
Required: False ,
}
integer ,
activationStatus:
{
Description: status of security domain activation ,
Required: False ,
}
string ,
}
,
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 ,
Required: False ,
}
string ,
stateMessage:
{
Description: The Cloud HSM State message ,
Required: False ,
}
string ,
}
,
]
,
publicNetworkAccess:
{
Description: The Cloud HSM Cluster public network access ,
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 ,
}
,
]
,
}
,
}

⚐ Response (202)

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

⚐ Response (default)

{
error:
{
Description: Error details ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
CloudHsmClusters_Get (removed)
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. ,
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 24 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 ,
}
{
provisioningState:
{
Description: The Cloud HSM Cluster's provisioningState ,
Enum:
{
Provisioning: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
autoGeneratedDomainNameLabelScope:
{
Description: The Cloud HSM Cluster's auto-generated Domain Name Label Scope ,
Required: False ,
}
string ,
securityDomain:
{
Description: Security domain properties information for Cloud HSM cluster ,
Required: False ,
}
{
fipsState:
{
Description: FIPS state information for security domain ,
Format: int32 ,
Required: False ,
}
integer ,
activationStatus:
{
Description: status of security domain activation ,
Required: False ,
}
string ,
}
,
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 ,
Required: False ,
}
string ,
stateMessage:
{
Description: The Cloud HSM State message ,
Required: False ,
}
string ,
}
,
]
,
publicNetworkAccess:
{
Description: The Cloud HSM Cluster public network access ,
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 ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error details ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
CloudHsmClusters_Delete (removed)
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. ,
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 24 characters in length. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

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

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Error details ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
CloudHsmClusters_ListByResourceGroup (removed)
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. ,
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 ,
}
{
provisioningState:
{
Description: The Cloud HSM Cluster's provisioningState ,
Enum:
{
Provisioning: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
autoGeneratedDomainNameLabelScope:
{
Description: The Cloud HSM Cluster's auto-generated Domain Name Label Scope ,
Required: False ,
}
string ,
securityDomain:
{
Description: Security domain properties information for Cloud HSM cluster ,
Required: False ,
}
{
fipsState:
{
Description: FIPS state information for security domain ,
Format: int32 ,
Required: False ,
}
integer ,
activationStatus:
{
Description: status of security domain activation ,
Required: False ,
}
string ,
}
,
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 ,
Required: False ,
}
string ,
stateMessage:
{
Description: The Cloud HSM State message ,
Required: False ,
}
string ,
}
,
]
,
publicNetworkAccess:
{
Description: The Cloud HSM Cluster public network access ,
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 ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of Cloud HSM Clusters. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error details ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
CloudHsmClusters_ListBySubscription (removed)
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. ,
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 ,
}
{
provisioningState:
{
Description: The Cloud HSM Cluster's provisioningState ,
Enum:
{
Provisioning: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
autoGeneratedDomainNameLabelScope:
{
Description: The Cloud HSM Cluster's auto-generated Domain Name Label Scope ,
Required: False ,
}
string ,
securityDomain:
{
Description: Security domain properties information for Cloud HSM cluster ,
Required: False ,
}
{
fipsState:
{
Description: FIPS state information for security domain ,
Format: int32 ,
Required: False ,
}
integer ,
activationStatus:
{
Description: status of security domain activation ,
Required: False ,
}
string ,
}
,
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 ,
Required: False ,
}
string ,
stateMessage:
{
Description: The Cloud HSM State message ,
Required: False ,
}
string ,
}
,
]
,
publicNetworkAccess:
{
Description: The Cloud HSM Cluster public network access ,
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 ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of Cloud HSM Clusters. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error details ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
CloudHsmClusterPrivateLinkResources_ListByCloudHsmCluster (removed)
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. ,
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 24 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 ,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Error details ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
CloudHsmClusterPrivateEndpointConnections_Create (removed)
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. ,
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 24 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: Error details ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
CloudHsmClusterPrivateEndpointConnections_Delete (removed)
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. ,
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 24 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)

{}

⚐ Response (202)

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

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Error details ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
CloudHsmClusterPrivateEndpointConnections_Get (removed)
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. ,
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 24 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: Error details ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
PrivateEndpointConnections_ListByCloudHsmCluster (removed)
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. ,
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 24 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: Error details ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}