Microsoft.HardwareSecurityModules (stable:2021-11-30)

2025/09/05 • 8 new, 8 deleted methods

Operations_List (new)
Description :  Get a list of Dedicated HSM operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.HardwareSecurityModules/operations
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Dedicated HSM Resource Provider operations. ,
Required: False ,
}
[
{
name:
{
Description: The name of the Dedicated HSM Resource Provider Operation. ,
Required: False ,
}
string ,
isDataAction:
{
Description: Gets or sets a value indicating whether it is a data plane action ,
Required: False ,
}
boolean ,
origin:
{
Description: The origin of the operation ,
Required: False ,
}
string ,
display:
{
Description: The display string. ,
Required: False ,
}
{
provider:
{
Description: The Resource Provider of the operation ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed. ,
Required: False ,
}
string ,
operation:
{
Description: Operation type: Read, write, delete, etc. ,
Required: False ,
}
string ,
description:
{
Description: The object that represents the operation. ,
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_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 to which the resource belongs. ,
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 ,
}
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created dedicated hsm resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created dedicated hsm resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of dedicated hsm resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified dedicated hsm resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified dedicated hsm resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of dedicated hsm resource last modification (UTC). ,
Format: date-time ,
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 ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
networkInterfaces:
{
Description: Specifies the list of resource Ids for the network interfaces associated with the dedicated HSM. ,
Required: False ,
}
[
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
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 ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
networkInterfaces:
{
Description: Specifies the list of resource Ids for the network interfaces associated with the dedicated HSM. ,
Required: False ,
}
[
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
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 full 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: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created dedicated hsm resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created dedicated hsm resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of dedicated hsm resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified dedicated hsm resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified dedicated hsm resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of dedicated hsm resource last modification (UTC). ,
Format: date-time ,
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 ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
networkInterfaces:
{
Description: Specifies the list of resource Ids for the network interfaces associated with the dedicated HSM. ,
Required: False ,
}
[
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
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 ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
networkInterfaces:
{
Description: Specifies the list of resource Ids for the network interfaces associated with the dedicated HSM. ,
Required: False ,
}
[
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
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 full 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)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created dedicated hsm resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created dedicated hsm resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of dedicated hsm resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified dedicated hsm resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified dedicated hsm resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of dedicated hsm resource last modification (UTC). ,
Format: date-time ,
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 ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
networkInterfaces:
{
Description: Specifies the list of resource Ids for the network interfaces associated with the dedicated HSM. ,
Required: False ,
}
[
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
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 ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
networkInterfaces:
{
Description: Specifies the list of resource Ids for the network interfaces associated with the dedicated HSM. ,
Required: False ,
}
[
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
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 full 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 to which the server belongs. ,
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: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created dedicated hsm resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created dedicated hsm resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of dedicated hsm resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified dedicated hsm resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified dedicated hsm resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of dedicated hsm resource last modification (UTC). ,
Format: date-time ,
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 ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
networkInterfaces:
{
Description: Specifies the list of resource Ids for the network interfaces associated with the dedicated HSM. ,
Required: False ,
}
[
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
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 ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
networkInterfaces:
{
Description: Specifies the list of resource Ids for the network interfaces associated with the dedicated HSM. ,
Required: False ,
}
[
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
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 full 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_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 to which the dedicated HSM belongs. ,
Required: True ,
}
string ,
name:
{
Description: The name of the dedicated HSM to delete ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ 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 to which the dedicated hsm belongs. ,
Required: True ,
}
string ,
name:
{
Description: The name of the dedicated HSM. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created dedicated hsm resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created dedicated hsm resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of dedicated hsm resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified dedicated hsm resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified dedicated hsm resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of dedicated hsm resource last modification (UTC). ,
Format: date-time ,
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 ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
networkInterfaces:
{
Description: Specifies the list of resource Ids for the network interfaces associated with the dedicated HSM. ,
Required: False ,
}
[
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
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 ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
networkInterfaces:
{
Description: Specifies the list of resource Ids for the network interfaces associated with the dedicated HSM. ,
Required: False ,
}
[
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
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 full 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 to which the dedicated HSM belongs. ,
Required: True ,
}
string ,
$top:
{
Description: Maximum number of results to return. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of dedicated HSMs. ,
Required: False ,
}
[
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created dedicated hsm resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created dedicated hsm resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of dedicated hsm resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified dedicated hsm resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified dedicated hsm resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of dedicated hsm resource last modification (UTC). ,
Format: date-time ,
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 ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
networkInterfaces:
{
Description: Specifies the list of resource Ids for the network interfaces associated with the dedicated HSM. ,
Required: False ,
}
[
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
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 ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
networkInterfaces:
{
Description: Specifies the list of resource Ids for the network interfaces associated with the dedicated HSM. ,
Required: False ,
}
[
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
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 full 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: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of dedicated HSMs. ,
Required: False ,
}
[
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created dedicated hsm resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created dedicated hsm resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of dedicated hsm resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified dedicated hsm resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified dedicated hsm resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of dedicated hsm resource last modification (UTC). ,
Format: date-time ,
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 ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
networkInterfaces:
{
Description: Specifies the list of resource Ids for the network interfaces associated with the dedicated HSM. ,
Required: False ,
}
[
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
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 ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
networkInterfaces:
{
Description: Specifies the list of resource Ids for the network interfaces associated with the dedicated HSM. ,
Required: False ,
}
[
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
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 full 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 to which the dedicated hsm belongs. ,
Required: True ,
}
string ,
name:
{
Description: The name of the dedicated HSM. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
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 (removed)
Description :  Get a list of Dedicated HSM operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.HardwareSecurityModules/operations
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Dedicated HSM Resource Provider operations. ,
Required: False ,
}
[
{
name:
{
Description: The name of the Dedicated HSM Resource Provider Operation. ,
Required: False ,
}
string ,
isDataAction:
{
Description: Gets or sets a value indicating whether it is a data plane action ,
Required: False ,
}
boolean ,
origin:
{
Description: The origin of the operation ,
Required: False ,
}
string ,
display:
{
Description: The display string. ,
Required: False ,
}
{
provider:
{
Description: The Resource Provider of the operation ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed. ,
Required: False ,
}
string ,
operation:
{
Description: Operation type: Read, write, delete, etc. ,
Required: False ,
}
string ,
description:
{
Description: The object that represents the operation. ,
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_CreateOrUpdate (removed)
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 to which the resource belongs. ,
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 ,
}
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created dedicated hsm resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created dedicated hsm resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of dedicated hsm resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified dedicated hsm resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified dedicated hsm resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of dedicated hsm resource last modification (UTC). ,
Format: date-time ,
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 ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
networkInterfaces:
{
Description: Specifies the list of resource Ids for the network interfaces associated with the dedicated HSM. ,
Required: False ,
}
[
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
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 ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
networkInterfaces:
{
Description: Specifies the list of resource Ids for the network interfaces associated with the dedicated HSM. ,
Required: False ,
}
[
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
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 full 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: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created dedicated hsm resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created dedicated hsm resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of dedicated hsm resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified dedicated hsm resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified dedicated hsm resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of dedicated hsm resource last modification (UTC). ,
Format: date-time ,
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 ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
networkInterfaces:
{
Description: Specifies the list of resource Ids for the network interfaces associated with the dedicated HSM. ,
Required: False ,
}
[
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
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 ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
networkInterfaces:
{
Description: Specifies the list of resource Ids for the network interfaces associated with the dedicated HSM. ,
Required: False ,
}
[
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
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 full 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)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created dedicated hsm resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created dedicated hsm resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of dedicated hsm resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified dedicated hsm resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified dedicated hsm resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of dedicated hsm resource last modification (UTC). ,
Format: date-time ,
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 ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
networkInterfaces:
{
Description: Specifies the list of resource Ids for the network interfaces associated with the dedicated HSM. ,
Required: False ,
}
[
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
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 ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
networkInterfaces:
{
Description: Specifies the list of resource Ids for the network interfaces associated with the dedicated HSM. ,
Required: False ,
}
[
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
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 full 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 (removed)
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 to which the server belongs. ,
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: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created dedicated hsm resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created dedicated hsm resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of dedicated hsm resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified dedicated hsm resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified dedicated hsm resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of dedicated hsm resource last modification (UTC). ,
Format: date-time ,
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 ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
networkInterfaces:
{
Description: Specifies the list of resource Ids for the network interfaces associated with the dedicated HSM. ,
Required: False ,
}
[
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
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 ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
networkInterfaces:
{
Description: Specifies the list of resource Ids for the network interfaces associated with the dedicated HSM. ,
Required: False ,
}
[
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
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 full 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_Delete (removed)
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 to which the dedicated HSM belongs. ,
Required: True ,
}
string ,
name:
{
Description: The name of the dedicated HSM to delete ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ 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 (removed)
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 to which the dedicated hsm belongs. ,
Required: True ,
}
string ,
name:
{
Description: The name of the dedicated HSM. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created dedicated hsm resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created dedicated hsm resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of dedicated hsm resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified dedicated hsm resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified dedicated hsm resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of dedicated hsm resource last modification (UTC). ,
Format: date-time ,
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 ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
networkInterfaces:
{
Description: Specifies the list of resource Ids for the network interfaces associated with the dedicated HSM. ,
Required: False ,
}
[
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
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 ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
networkInterfaces:
{
Description: Specifies the list of resource Ids for the network interfaces associated with the dedicated HSM. ,
Required: False ,
}
[
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
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 full 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 (removed)
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 to which the dedicated HSM belongs. ,
Required: True ,
}
string ,
$top:
{
Description: Maximum number of results to return. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of dedicated HSMs. ,
Required: False ,
}
[
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created dedicated hsm resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created dedicated hsm resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of dedicated hsm resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified dedicated hsm resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified dedicated hsm resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of dedicated hsm resource last modification (UTC). ,
Format: date-time ,
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 ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
networkInterfaces:
{
Description: Specifies the list of resource Ids for the network interfaces associated with the dedicated HSM. ,
Required: False ,
}
[
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
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 ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
networkInterfaces:
{
Description: Specifies the list of resource Ids for the network interfaces associated with the dedicated HSM. ,
Required: False ,
}
[
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
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 full 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 (removed)
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: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of dedicated HSMs. ,
Required: False ,
}
[
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created dedicated hsm resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created dedicated hsm resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of dedicated hsm resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified dedicated hsm resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified dedicated hsm resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of dedicated hsm resource last modification (UTC). ,
Format: date-time ,
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 ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
networkInterfaces:
{
Description: Specifies the list of resource Ids for the network interfaces associated with the dedicated HSM. ,
Required: False ,
}
[
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
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 ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
networkInterfaces:
{
Description: Specifies the list of resource Ids for the network interfaces associated with the dedicated HSM. ,
Required: False ,
}
[
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
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 full 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 (removed)
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 to which the dedicated hsm belongs. ,
Required: True ,
}
string ,
name:
{
Description: The name of the dedicated HSM. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
}
,
}