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

2025/12/02 • 1 updated methods

CloudHsmClusterRestoreStatus_Get (updated)
Description :  Gets the restore operation status of the specified Cloud HSM Cluster
Reference :  Link ¶

⚶ Changes

{
  "#id": "CloudHsmClusterRestoreStatus_Get",
  "$parameters": [
    {
      "#name": "cloudHsmClusterName",
      "Description": {
        "new": "The name of the Cloud HSM Cluster within the specified resource group. Cloud HSM Cluster names must be between 3 and 23 characters in length.",
        "old": "Name of the Cloud HSM Cluster"
      }
    }
  ]
}

⚼ Request

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

⚐ Response (200)

{
$headers:
{
x-ms-request-id:
{
Description: An opaque, globally-unique, server-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Restore operation properties ,
}
{
properties:
{
Description: Backup and Restore operation common properties ,
Required: False ,
}
{
status:
{
Description: Status of the backup/restore operation ,
Enum:
{
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: The status details of backup/restore operation ,
Required: False ,
}
string ,
error:
{
Description: Error encountered, if any, during the backup/restore operation. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
startTime:
{
Description: The start time of the backup/restore operation in UTC ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of the backup/restore operation in UTC ,
Format: date-time ,
Required: False ,
}
string ,
jobId:
{
Description: Identifier for the backup/restore operation. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
x-ms-request-id:
{
Description: An opaque, globally-unique, server-generated string identifier for the request. ,
}
string ,
}

⚐ Response (default)

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