Microsoft.RecoveryServices (stable:2016-06-01)

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

VaultCertificates_Create (new)
Description :  Uploads a certificate for a resource.
Reference :  Link ¶

⚼ Request

PUT:  /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/certificates/{certificateName}
{
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
certificateName:
{
Description: Certificate friendly name. ,
Required: True ,
}
string ,
certificateRequest:
{
Description: Input parameters for uploading the vault certificate. ,
Required: True ,
}
{
properties:
{
Description: Raw certificate data. ,
Required: False ,
}
{
authType:
{
Description: Specifies the authentication type. ,
Enum:
{
Invalid: No description available. ,
ACS: No description available. ,
AAD: No description available. ,
AccessControlService: No description available. ,
AzureActiveDirectory: No description available. ,
}
,
Required: False ,
}
enum ,
certificate:
{
Description: The base64 encoded certificate raw data string ,
Format: byte ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
name:
{
Description: Resource name associated with the resource. ,
Required: False ,
}
string ,
type:
{
Description: Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/... ,
Required: False ,
}
string ,
id:
{
Description: Resource Id represents the complete path to the resource. ,
Required: False ,
}
string ,
properties:
{
Description: Certificate details representing the Vault credentials. ,
Required: False ,
}
{
authType:
{
Description: This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. ,
Required: True ,
}
string ,
certificate:
{
Description: The base64 encoded certificate raw data string. ,
Format: byte ,
Required: False ,
}
string ,
friendlyName:
{
Description: Certificate friendly name. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate issuer. ,
Required: False ,
}
string ,
resourceId:
{
Description: Resource ID of the vault. ,
Format: int64 ,
Required: False ,
}
integer ,
subject:
{
Description: Certificate Subject Name. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate thumbprint. ,
Required: False ,
}
string ,
validFrom:
{
Description: Certificate Validity start Date time. ,
Format: date-time ,
Required: False ,
}
string ,
validTo:
{
Description: Certificate Validity End Date time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
RegisteredIdentities_Delete (new)
Description :  Unregisters the given container from your Recovery Services vault.
Reference :  Link ¶

⚼ Request

DELETE:  /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/registeredIdentities/{identityName}
{
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
identityName:
{
Description: Name of the protection container to unregister. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}
ReplicationUsages_List (new)
Description :  Fetches the replication usages of the vault.
Reference :  Link ¶

⚼ Request

GET:  /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/replicationUsages
{
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of replication usages for the given vault. ,
Required: False ,
}
[
{
monitoringSummary:
{
Description: Summary of the replication monitoring data for this vault. ,
Required: False ,
}
{
unHealthyVmCount:
{
Description: Count of unhealthy VMs. ,
Required: False ,
}
integer ,
unHealthyProviderCount:
{
Description: Count of unhealthy replication providers. ,
Required: False ,
}
integer ,
eventsCount:
{
Description: Count of all critical warnings. ,
Required: False ,
}
integer ,
deprecatedProviderCount:
{
Description: Count of all deprecated recovery service providers. ,
Required: False ,
}
integer ,
supportedProviderCount:
{
Description: Count of all the supported recovery service providers. ,
Required: False ,
}
integer ,
unsupportedProviderCount:
{
Description: Count of all the unsupported recovery service providers. ,
Required: False ,
}
integer ,
}
,
jobsSummary:
{
Description: Summary of the replication jobs data for this vault. ,
Required: False ,
}
{
failedJobs:
{
Description: Count of failed jobs. ,
Required: False ,
}
integer ,
suspendedJobs:
{
Description: Count of suspended jobs. ,
Required: False ,
}
integer ,
inProgressJobs:
{
Description: Count of in-progress jobs. ,
Required: False ,
}
integer ,
}
,
protectedItemCount:
{
Description: Number of replication protected items for this vault. ,
Required: False ,
}
integer ,
recoveryPlanCount:
{
Description: Number of replication recovery plans for this vault. ,
Required: False ,
}
integer ,
registeredServersCount:
{
Description: Number of servers registered to this vault. ,
Required: False ,
}
integer ,
recoveryServicesProviderAuthType:
{
Description: The authentication type of recovery service providers in the vault. ,
Required: False ,
}
integer ,
}
,
]
,
}
PrivateLinkResources_List (new)
Description :  Returns the list of private link resources that need to be created for Backup and SiteRecovery
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/privateLinkResources
{
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A collection of private link resources ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties ,
Required: False ,
}
{
groupId:
{
Description: e.g. f9ad6492-33d4-4690-9999-6bfd52a0d081 (Backup) or f9ad6492-33d4-4690-9999-6bfd52a0d082 (SiteRecovery) ,
Required: False ,
}
string ,
requiredMembers:
{
Description: [backup-ecs1, backup-prot1, backup-prot1b, backup-prot1c, backup-id1] ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: The private link resource Private link DNS zone name. ,
Required: False ,
}
[
string ,
]
,
}
,
id:
{
Description: Fully qualified identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: e.g. Microsoft.RecoveryServices/vaults/privateLinkResources ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Link to the next chunk of the response ,
Required: False ,
}
string ,
}
PrivateLinkResources_Get (new)
Description :  Returns a specified private link resource that need to be created for Backup and SiteRecovery
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/privateLinkResources/{privateLinkResourceName}
{
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
privateLinkResourceName:
{
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties ,
Required: False ,
}
{
groupId:
{
Description: e.g. f9ad6492-33d4-4690-9999-6bfd52a0d081 (Backup) or f9ad6492-33d4-4690-9999-6bfd52a0d082 (SiteRecovery) ,
Required: False ,
}
string ,
requiredMembers:
{
Description: [backup-ecs1, backup-prot1, backup-prot1b, backup-prot1c, backup-id1] ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: The private link resource Private link DNS zone name. ,
Required: False ,
}
[
string ,
]
,
}
,
id:
{
Description: Fully qualified identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: e.g. Microsoft.RecoveryServices/vaults/privateLinkResources ,
Required: False ,
}
string ,
}
RecoveryServices_CheckNameAvailability (new)
Description :  API to check for resource name availability. A name is available if no other resource exists that has the same SubscriptionId, Resource Name and Type or if one or more such resources exist, each of these must be GC'd and their time of deletion be more than 24 Hours Ago
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/locations/{location}/checkNameAvailability
{
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
location:
{
Description: Location of the resource ,
Required: True ,
}
string ,
input:
{
Description: Contains information about Resource type and Resource name ,
Required: True ,
}
{
type:
{
Description: Describes the Resource type: Microsoft.RecoveryServices/Vaults ,
Required: False ,
}
string ,
name:
{
Description: Resource name for which availability needs to be checked ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
nameAvailable:
{
Required: False ,
}
boolean ,
reason:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
}
Vaults_ListBySubscriptionId (new)
Description :  Fetches all the resources of the specified type in the subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.RecoveryServices/vaults
{
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
properties:
{
Description: Properties of the vault. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning State. ,
Required: False ,
}
string ,
upgradeDetails:
{
Description: Details for upgrading vault. ,
Required: False ,
}
{
operationId:
{
Description: ID of the vault upgrade operation. ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: UTC time at which the upgrade operation has started. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedTimeUtc:
{
Description: UTC time at which the upgrade operation status was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
endTimeUtc:
{
Description: UTC time at which the upgrade operation has ended. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Status of the vault upgrade operation. ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Upgraded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Message to the user containing information about the upgrade operation. ,
Required: False ,
}
string ,
triggerType:
{
Description: The way the vault upgrade was triggered. ,
Enum:
{
UserTriggered: No description available. ,
ForcedUpgrade: No description available. ,
}
,
Required: False ,
}
enum ,
upgradedResourceId:
{
Description: Resource ID of the upgraded vault. ,
Required: False ,
}
string ,
previousResourceId:
{
Description: Resource ID of the vault before the upgrade. ,
Required: False ,
}
string ,
}
,
privateEndpointConnections:
{
Description: List of private endpoint connection. ,
Required: False ,
}
[
{
id:
{
Description: Format of id subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.[Service]/{resource}/{resourceName}/privateEndpointConnections/{connectionName}. ,
Required: False ,
}
string ,
properties:
{
Description: Private Endpoint Connection Response Properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets provisioning state of the private endpoint connection. ,
Enum:
{
Succeeded: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The Private Endpoint network resource that is linked to the Private Endpoint connection. ,
Required: False ,
}
{
id:
{
Description: Gets or sets id. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Gets or sets private link service connection state. ,
Required: False ,
}
{
status:
{
Description: Gets or sets the status. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Gets or sets description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Gets or sets actions required. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
privateEndpointStateForBackup:
{
Description: Private endpoint state for backup. ,
Enum:
{
None: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointStateForSiteRecovery:
{
Description: Private endpoint state for site recovery. ,
Enum:
{
None: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Identifies the unique system identifier for each Azure resource. ,
Required: False ,
}
{
name:
{
Description: The Sku name. ,
Enum:
{
Standard: No description available. ,
RS0: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Required: False ,
}
string ,
}
Operations_List (new)
Description :  Returns the list of available operations.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: List of available operations. ,
Required: False ,
}
[
{
name:
{
Description: Name of the Operation. ,
Required: False ,
}
string ,
display:
{
Description: Contains the localized display information for this particular operation ,
Required: False ,
}
{
provider:
{
Description: Name of the provider for display purposes ,
Required: False ,
}
string ,
resource:
{
Description: ResourceType for which this Operation can be performed. ,
Required: False ,
}
string ,
operation:
{
Description: Operations Name itself. ,
Required: False ,
}
string ,
description:
{
Description: Description of the operation having details of what operation is about. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation;governs the display of the operation in the RBAC UX and the audit logs UX ,
Required: False ,
}
string ,
properties:
{
Description: ShoeBox properties for the given operation. ,
Required: False ,
}
{
serviceSpecification:
{
Description: Operation properties. ,
Required: False ,
}
{
logSpecifications:
{
Description: List of log specifications of this operation. ,
Required: False ,
}
[
{
name:
{
Description: Name of the log. ,
Required: False ,
}
string ,
displayName:
{
Description: Localized display name ,
Required: False ,
}
string ,
blobDuration:
{
Description: Blobs created in customer storage account per hour ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next chunk of the response ,
Required: False ,
}
string ,
}
Vaults_ListByResourceGroup (new)
Description :  Retrieve a list of Vaults.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults
{
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
properties:
{
Description: Properties of the vault. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning State. ,
Required: False ,
}
string ,
upgradeDetails:
{
Description: Details for upgrading vault. ,
Required: False ,
}
{
operationId:
{
Description: ID of the vault upgrade operation. ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: UTC time at which the upgrade operation has started. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedTimeUtc:
{
Description: UTC time at which the upgrade operation status was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
endTimeUtc:
{
Description: UTC time at which the upgrade operation has ended. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Status of the vault upgrade operation. ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Upgraded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Message to the user containing information about the upgrade operation. ,
Required: False ,
}
string ,
triggerType:
{
Description: The way the vault upgrade was triggered. ,
Enum:
{
UserTriggered: No description available. ,
ForcedUpgrade: No description available. ,
}
,
Required: False ,
}
enum ,
upgradedResourceId:
{
Description: Resource ID of the upgraded vault. ,
Required: False ,
}
string ,
previousResourceId:
{
Description: Resource ID of the vault before the upgrade. ,
Required: False ,
}
string ,
}
,
privateEndpointConnections:
{
Description: List of private endpoint connection. ,
Required: False ,
}
[
{
id:
{
Description: Format of id subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.[Service]/{resource}/{resourceName}/privateEndpointConnections/{connectionName}. ,
Required: False ,
}
string ,
properties:
{
Description: Private Endpoint Connection Response Properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets provisioning state of the private endpoint connection. ,
Enum:
{
Succeeded: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The Private Endpoint network resource that is linked to the Private Endpoint connection. ,
Required: False ,
}
{
id:
{
Description: Gets or sets id. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Gets or sets private link service connection state. ,
Required: False ,
}
{
status:
{
Description: Gets or sets the status. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Gets or sets description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Gets or sets actions required. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
privateEndpointStateForBackup:
{
Description: Private endpoint state for backup. ,
Enum:
{
None: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointStateForSiteRecovery:
{
Description: Private endpoint state for site recovery. ,
Enum:
{
None: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Identifies the unique system identifier for each Azure resource. ,
Required: False ,
}
{
name:
{
Description: The Sku name. ,
Enum:
{
Standard: No description available. ,
RS0: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Required: False ,
}
string ,
}
Vaults_Get (new)
Description :  Get the Vault details.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}
{
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
properties:
{
Description: Properties of the vault. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning State. ,
Required: False ,
}
string ,
upgradeDetails:
{
Description: Details for upgrading vault. ,
Required: False ,
}
{
operationId:
{
Description: ID of the vault upgrade operation. ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: UTC time at which the upgrade operation has started. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedTimeUtc:
{
Description: UTC time at which the upgrade operation status was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
endTimeUtc:
{
Description: UTC time at which the upgrade operation has ended. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Status of the vault upgrade operation. ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Upgraded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Message to the user containing information about the upgrade operation. ,
Required: False ,
}
string ,
triggerType:
{
Description: The way the vault upgrade was triggered. ,
Enum:
{
UserTriggered: No description available. ,
ForcedUpgrade: No description available. ,
}
,
Required: False ,
}
enum ,
upgradedResourceId:
{
Description: Resource ID of the upgraded vault. ,
Required: False ,
}
string ,
previousResourceId:
{
Description: Resource ID of the vault before the upgrade. ,
Required: False ,
}
string ,
}
,
privateEndpointConnections:
{
Description: List of private endpoint connection. ,
Required: False ,
}
[
{
id:
{
Description: Format of id subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.[Service]/{resource}/{resourceName}/privateEndpointConnections/{connectionName}. ,
Required: False ,
}
string ,
properties:
{
Description: Private Endpoint Connection Response Properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets provisioning state of the private endpoint connection. ,
Enum:
{
Succeeded: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The Private Endpoint network resource that is linked to the Private Endpoint connection. ,
Required: False ,
}
{
id:
{
Description: Gets or sets id. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Gets or sets private link service connection state. ,
Required: False ,
}
{
status:
{
Description: Gets or sets the status. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Gets or sets description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Gets or sets actions required. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
privateEndpointStateForBackup:
{
Description: Private endpoint state for backup. ,
Enum:
{
None: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointStateForSiteRecovery:
{
Description: Private endpoint state for site recovery. ,
Enum:
{
None: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Identifies the unique system identifier for each Azure resource. ,
Required: False ,
}
{
name:
{
Description: The Sku name. ,
Enum:
{
Standard: No description available. ,
RS0: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
Vaults_CreateOrUpdate (new)
Description :  Creates or updates a Recovery Services vault.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}
{
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
vault:
{
Description: Recovery Services Vault to be created. ,
Required: True ,
}
{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
properties:
{
Description: Properties of the vault. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning State. ,
Required: False ,
}
string ,
upgradeDetails:
{
Description: Details for upgrading vault. ,
Required: False ,
}
{
operationId:
{
Description: ID of the vault upgrade operation. ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: UTC time at which the upgrade operation has started. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedTimeUtc:
{
Description: UTC time at which the upgrade operation status was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
endTimeUtc:
{
Description: UTC time at which the upgrade operation has ended. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Status of the vault upgrade operation. ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Upgraded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Message to the user containing information about the upgrade operation. ,
Required: False ,
}
string ,
triggerType:
{
Description: The way the vault upgrade was triggered. ,
Enum:
{
UserTriggered: No description available. ,
ForcedUpgrade: No description available. ,
}
,
Required: False ,
}
enum ,
upgradedResourceId:
{
Description: Resource ID of the upgraded vault. ,
Required: False ,
}
string ,
previousResourceId:
{
Description: Resource ID of the vault before the upgrade. ,
Required: False ,
}
string ,
}
,
privateEndpointConnections:
{
Description: List of private endpoint connection. ,
Required: False ,
}
[
{
id:
{
Description: Format of id subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.[Service]/{resource}/{resourceName}/privateEndpointConnections/{connectionName}. ,
Required: False ,
}
string ,
properties:
{
Description: Private Endpoint Connection Response Properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets provisioning state of the private endpoint connection. ,
Enum:
{
Succeeded: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The Private Endpoint network resource that is linked to the Private Endpoint connection. ,
Required: False ,
}
{
id:
{
Description: Gets or sets id. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Gets or sets private link service connection state. ,
Required: False ,
}
{
status:
{
Description: Gets or sets the status. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Gets or sets description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Gets or sets actions required. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
privateEndpointStateForBackup:
{
Description: Private endpoint state for backup. ,
Enum:
{
None: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointStateForSiteRecovery:
{
Description: Private endpoint state for site recovery. ,
Enum:
{
None: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Identifies the unique system identifier for each Azure resource. ,
Required: False ,
}
{
name:
{
Description: The Sku name. ,
Enum:
{
Standard: No description available. ,
RS0: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
properties:
{
Description: Properties of the vault. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning State. ,
Required: False ,
}
string ,
upgradeDetails:
{
Description: Details for upgrading vault. ,
Required: False ,
}
{
operationId:
{
Description: ID of the vault upgrade operation. ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: UTC time at which the upgrade operation has started. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedTimeUtc:
{
Description: UTC time at which the upgrade operation status was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
endTimeUtc:
{
Description: UTC time at which the upgrade operation has ended. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Status of the vault upgrade operation. ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Upgraded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Message to the user containing information about the upgrade operation. ,
Required: False ,
}
string ,
triggerType:
{
Description: The way the vault upgrade was triggered. ,
Enum:
{
UserTriggered: No description available. ,
ForcedUpgrade: No description available. ,
}
,
Required: False ,
}
enum ,
upgradedResourceId:
{
Description: Resource ID of the upgraded vault. ,
Required: False ,
}
string ,
previousResourceId:
{
Description: Resource ID of the vault before the upgrade. ,
Required: False ,
}
string ,
}
,
privateEndpointConnections:
{
Description: List of private endpoint connection. ,
Required: False ,
}
[
{
id:
{
Description: Format of id subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.[Service]/{resource}/{resourceName}/privateEndpointConnections/{connectionName}. ,
Required: False ,
}
string ,
properties:
{
Description: Private Endpoint Connection Response Properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets provisioning state of the private endpoint connection. ,
Enum:
{
Succeeded: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The Private Endpoint network resource that is linked to the Private Endpoint connection. ,
Required: False ,
}
{
id:
{
Description: Gets or sets id. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Gets or sets private link service connection state. ,
Required: False ,
}
{
status:
{
Description: Gets or sets the status. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Gets or sets description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Gets or sets actions required. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
privateEndpointStateForBackup:
{
Description: Private endpoint state for backup. ,
Enum:
{
None: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointStateForSiteRecovery:
{
Description: Private endpoint state for site recovery. ,
Enum:
{
None: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Identifies the unique system identifier for each Azure resource. ,
Required: False ,
}
{
name:
{
Description: The Sku name. ,
Enum:
{
Standard: No description available. ,
RS0: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (201)

{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
properties:
{
Description: Properties of the vault. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning State. ,
Required: False ,
}
string ,
upgradeDetails:
{
Description: Details for upgrading vault. ,
Required: False ,
}
{
operationId:
{
Description: ID of the vault upgrade operation. ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: UTC time at which the upgrade operation has started. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedTimeUtc:
{
Description: UTC time at which the upgrade operation status was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
endTimeUtc:
{
Description: UTC time at which the upgrade operation has ended. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Status of the vault upgrade operation. ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Upgraded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Message to the user containing information about the upgrade operation. ,
Required: False ,
}
string ,
triggerType:
{
Description: The way the vault upgrade was triggered. ,
Enum:
{
UserTriggered: No description available. ,
ForcedUpgrade: No description available. ,
}
,
Required: False ,
}
enum ,
upgradedResourceId:
{
Description: Resource ID of the upgraded vault. ,
Required: False ,
}
string ,
previousResourceId:
{
Description: Resource ID of the vault before the upgrade. ,
Required: False ,
}
string ,
}
,
privateEndpointConnections:
{
Description: List of private endpoint connection. ,
Required: False ,
}
[
{
id:
{
Description: Format of id subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.[Service]/{resource}/{resourceName}/privateEndpointConnections/{connectionName}. ,
Required: False ,
}
string ,
properties:
{
Description: Private Endpoint Connection Response Properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets provisioning state of the private endpoint connection. ,
Enum:
{
Succeeded: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The Private Endpoint network resource that is linked to the Private Endpoint connection. ,
Required: False ,
}
{
id:
{
Description: Gets or sets id. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Gets or sets private link service connection state. ,
Required: False ,
}
{
status:
{
Description: Gets or sets the status. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Gets or sets description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Gets or sets actions required. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
privateEndpointStateForBackup:
{
Description: Private endpoint state for backup. ,
Enum:
{
None: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointStateForSiteRecovery:
{
Description: Private endpoint state for site recovery. ,
Enum:
{
None: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Identifies the unique system identifier for each Azure resource. ,
Required: False ,
}
{
name:
{
Description: The Sku name. ,
Enum:
{
Standard: No description available. ,
RS0: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
Vaults_Delete (new)
Description :  Deletes a vault.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}
{
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}
Vaults_Update (new)
Description :  Updates the vault.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}
{
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
vault:
{
Description: Recovery Services Vault to be created. ,
Required: True ,
}
{
properties:
{
Description: Properties of the vault. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning State. ,
Required: False ,
}
string ,
upgradeDetails:
{
Description: Details for upgrading vault. ,
Required: False ,
}
{
operationId:
{
Description: ID of the vault upgrade operation. ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: UTC time at which the upgrade operation has started. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedTimeUtc:
{
Description: UTC time at which the upgrade operation status was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
endTimeUtc:
{
Description: UTC time at which the upgrade operation has ended. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Status of the vault upgrade operation. ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Upgraded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Message to the user containing information about the upgrade operation. ,
Required: False ,
}
string ,
triggerType:
{
Description: The way the vault upgrade was triggered. ,
Enum:
{
UserTriggered: No description available. ,
ForcedUpgrade: No description available. ,
}
,
Required: False ,
}
enum ,
upgradedResourceId:
{
Description: Resource ID of the upgraded vault. ,
Required: False ,
}
string ,
previousResourceId:
{
Description: Resource ID of the vault before the upgrade. ,
Required: False ,
}
string ,
}
,
privateEndpointConnections:
{
Description: List of private endpoint connection. ,
Required: False ,
}
[
{
id:
{
Description: Format of id subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.[Service]/{resource}/{resourceName}/privateEndpointConnections/{connectionName}. ,
Required: False ,
}
string ,
properties:
{
Description: Private Endpoint Connection Response Properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets provisioning state of the private endpoint connection. ,
Enum:
{
Succeeded: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The Private Endpoint network resource that is linked to the Private Endpoint connection. ,
Required: False ,
}
{
id:
{
Description: Gets or sets id. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Gets or sets private link service connection state. ,
Required: False ,
}
{
status:
{
Description: Gets or sets the status. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Gets or sets description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Gets or sets actions required. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
privateEndpointStateForBackup:
{
Description: Private endpoint state for backup. ,
Enum:
{
None: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointStateForSiteRecovery:
{
Description: Private endpoint state for site recovery. ,
Enum:
{
None: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Identifies the unique system identifier for each Azure resource. ,
Required: False ,
}
{
name:
{
Description: The Sku name. ,
Enum:
{
Standard: No description available. ,
RS0: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
properties:
{
Description: Properties of the vault. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning State. ,
Required: False ,
}
string ,
upgradeDetails:
{
Description: Details for upgrading vault. ,
Required: False ,
}
{
operationId:
{
Description: ID of the vault upgrade operation. ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: UTC time at which the upgrade operation has started. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedTimeUtc:
{
Description: UTC time at which the upgrade operation status was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
endTimeUtc:
{
Description: UTC time at which the upgrade operation has ended. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Status of the vault upgrade operation. ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Upgraded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Message to the user containing information about the upgrade operation. ,
Required: False ,
}
string ,
triggerType:
{
Description: The way the vault upgrade was triggered. ,
Enum:
{
UserTriggered: No description available. ,
ForcedUpgrade: No description available. ,
}
,
Required: False ,
}
enum ,
upgradedResourceId:
{
Description: Resource ID of the upgraded vault. ,
Required: False ,
}
string ,
previousResourceId:
{
Description: Resource ID of the vault before the upgrade. ,
Required: False ,
}
string ,
}
,
privateEndpointConnections:
{
Description: List of private endpoint connection. ,
Required: False ,
}
[
{
id:
{
Description: Format of id subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.[Service]/{resource}/{resourceName}/privateEndpointConnections/{connectionName}. ,
Required: False ,
}
string ,
properties:
{
Description: Private Endpoint Connection Response Properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets provisioning state of the private endpoint connection. ,
Enum:
{
Succeeded: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The Private Endpoint network resource that is linked to the Private Endpoint connection. ,
Required: False ,
}
{
id:
{
Description: Gets or sets id. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Gets or sets private link service connection state. ,
Required: False ,
}
{
status:
{
Description: Gets or sets the status. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Gets or sets description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Gets or sets actions required. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
privateEndpointStateForBackup:
{
Description: Private endpoint state for backup. ,
Enum:
{
None: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointStateForSiteRecovery:
{
Description: Private endpoint state for site recovery. ,
Enum:
{
None: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Identifies the unique system identifier for each Azure resource. ,
Required: False ,
}
{
name:
{
Description: The Sku name. ,
Enum:
{
Standard: No description available. ,
RS0: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (201)

{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
properties:
{
Description: Properties of the vault. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning State. ,
Required: False ,
}
string ,
upgradeDetails:
{
Description: Details for upgrading vault. ,
Required: False ,
}
{
operationId:
{
Description: ID of the vault upgrade operation. ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: UTC time at which the upgrade operation has started. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedTimeUtc:
{
Description: UTC time at which the upgrade operation status was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
endTimeUtc:
{
Description: UTC time at which the upgrade operation has ended. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Status of the vault upgrade operation. ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Upgraded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Message to the user containing information about the upgrade operation. ,
Required: False ,
}
string ,
triggerType:
{
Description: The way the vault upgrade was triggered. ,
Enum:
{
UserTriggered: No description available. ,
ForcedUpgrade: No description available. ,
}
,
Required: False ,
}
enum ,
upgradedResourceId:
{
Description: Resource ID of the upgraded vault. ,
Required: False ,
}
string ,
previousResourceId:
{
Description: Resource ID of the vault before the upgrade. ,
Required: False ,
}
string ,
}
,
privateEndpointConnections:
{
Description: List of private endpoint connection. ,
Required: False ,
}
[
{
id:
{
Description: Format of id subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.[Service]/{resource}/{resourceName}/privateEndpointConnections/{connectionName}. ,
Required: False ,
}
string ,
properties:
{
Description: Private Endpoint Connection Response Properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets provisioning state of the private endpoint connection. ,
Enum:
{
Succeeded: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The Private Endpoint network resource that is linked to the Private Endpoint connection. ,
Required: False ,
}
{
id:
{
Description: Gets or sets id. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Gets or sets private link service connection state. ,
Required: False ,
}
{
status:
{
Description: Gets or sets the status. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Gets or sets description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Gets or sets actions required. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
privateEndpointStateForBackup:
{
Description: Private endpoint state for backup. ,
Enum:
{
None: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointStateForSiteRecovery:
{
Description: Private endpoint state for site recovery. ,
Enum:
{
None: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Identifies the unique system identifier for each Azure resource. ,
Required: False ,
}
{
name:
{
Description: The Sku name. ,
Enum:
{
Standard: No description available. ,
RS0: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
VaultExtendedInfo_Get (new)
Description :  Get the vault extended info.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/extendedInformation/vaultExtendedInfo
{
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Vault extended information. ,
Required: False ,
}
{
integrityKey:
{
Description: Integrity key. ,
Required: False ,
}
string ,
encryptionKey:
{
Description: Encryption key. ,
Required: False ,
}
string ,
encryptionKeyThumbprint:
{
Description: Encryption key thumbprint. ,
Required: False ,
}
string ,
algorithm:
{
Description: Algorithm for Vault ExtendedInfo ,
Required: False ,
}
string ,
}
,
}
VaultExtendedInfo_CreateOrUpdate (new)
Description :  Create vault extended info.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/extendedInformation/vaultExtendedInfo
{
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceResourceExtendedInfoDetails:
{
Description: Details of ResourceExtendedInfo ,
Required: True ,
}
{
properties:
{
Description: Vault extended information. ,
Required: False ,
}
{
integrityKey:
{
Description: Integrity key. ,
Required: False ,
}
string ,
encryptionKey:
{
Description: Encryption key. ,
Required: False ,
}
string ,
encryptionKeyThumbprint:
{
Description: Encryption key thumbprint. ,
Required: False ,
}
string ,
algorithm:
{
Description: Algorithm for Vault ExtendedInfo ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Vault extended information. ,
Required: False ,
}
{
integrityKey:
{
Description: Integrity key. ,
Required: False ,
}
string ,
encryptionKey:
{
Description: Encryption key. ,
Required: False ,
}
string ,
encryptionKeyThumbprint:
{
Description: Encryption key thumbprint. ,
Required: False ,
}
string ,
algorithm:
{
Description: Algorithm for Vault ExtendedInfo ,
Required: False ,
}
string ,
}
,
}
VaultExtendedInfo_Update (new)
Description :  Update vault extended info.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/extendedInformation/vaultExtendedInfo
{
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceResourceExtendedInfoDetails:
{
Description: Details of ResourceExtendedInfo ,
Required: True ,
}
{
properties:
{
Description: Vault extended information. ,
Required: False ,
}
{
integrityKey:
{
Description: Integrity key. ,
Required: False ,
}
string ,
encryptionKey:
{
Description: Encryption key. ,
Required: False ,
}
string ,
encryptionKeyThumbprint:
{
Description: Encryption key thumbprint. ,
Required: False ,
}
string ,
algorithm:
{
Description: Algorithm for Vault ExtendedInfo ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Vault extended information. ,
Required: False ,
}
{
integrityKey:
{
Description: Integrity key. ,
Required: False ,
}
string ,
encryptionKey:
{
Description: Encryption key. ,
Required: False ,
}
string ,
encryptionKeyThumbprint:
{
Description: Encryption key thumbprint. ,
Required: False ,
}
string ,
algorithm:
{
Description: Algorithm for Vault ExtendedInfo ,
Required: False ,
}
string ,
}
,
}
Usages_ListByVaults (new)
Description :  Fetches the usages of the vault.
Reference :  Link ¶

⚼ Request

GET:  /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/usages
{
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of usages for the given vault. ,
Required: False ,
}
[
{
unit:
{
Description: Unit of the usage. ,
Enum:
{
Count: No description available. ,
Bytes: No description available. ,
Seconds: No description available. ,
Percent: No description available. ,
CountPerSecond: No description available. ,
BytesPerSecond: No description available. ,
}
,
Required: False ,
}
enum ,
quotaPeriod:
{
Description: Quota period of usage. ,
Required: False ,
}
string ,
nextResetTime:
{
Description: Next reset time of usage. ,
Format: date-time ,
Required: False ,
}
string ,
currentValue:
{
Description: Current value of usage. ,
Format: int64 ,
Required: False ,
}
integer ,
limit:
{
Description: Limit of usage. ,
Format: int64 ,
Required: False ,
}
integer ,
name:
{
Description: Name of usage. ,
Required: False ,
}
{
value:
{
Description: Value of usage. ,
Required: False ,
}
string ,
localizedValue:
{
Description: Localized value of usage. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
VaultCertificates_Create (removed)
Description :  Uploads a certificate for a resource.
Reference :  Link ¶

⚼ Request

PUT:  /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/certificates/{certificateName}
{
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
certificateName:
{
Description: Certificate friendly name. ,
Required: True ,
}
string ,
certificateRequest:
{
Description: Input parameters for uploading the vault certificate. ,
Required: True ,
}
{
properties:
{
Description: Raw certificate data. ,
Required: False ,
}
{
authType:
{
Description: Specifies the authentication type. ,
Enum:
{
Invalid: No description available. ,
ACS: No description available. ,
AAD: No description available. ,
AccessControlService: No description available. ,
AzureActiveDirectory: No description available. ,
}
,
Required: False ,
}
enum ,
certificate:
{
Description: The base64 encoded certificate raw data string ,
Format: byte ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
name:
{
Description: Resource name associated with the resource. ,
Required: False ,
}
string ,
type:
{
Description: Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/... ,
Required: False ,
}
string ,
id:
{
Description: Resource Id represents the complete path to the resource. ,
Required: False ,
}
string ,
properties:
{
Description: Certificate details representing the Vault credentials. ,
Required: False ,
}
{
authType:
{
Description: This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. ,
Required: True ,
}
string ,
certificate:
{
Description: The base64 encoded certificate raw data string. ,
Format: byte ,
Required: False ,
}
string ,
friendlyName:
{
Description: Certificate friendly name. ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate issuer. ,
Required: False ,
}
string ,
resourceId:
{
Description: Resource ID of the vault. ,
Format: int64 ,
Required: False ,
}
integer ,
subject:
{
Description: Certificate Subject Name. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate thumbprint. ,
Required: False ,
}
string ,
validFrom:
{
Description: Certificate Validity start Date time. ,
Format: date-time ,
Required: False ,
}
string ,
validTo:
{
Description: Certificate Validity End Date time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
RegisteredIdentities_Delete (removed)
Description :  Unregisters the given container from your Recovery Services vault.
Reference :  Link ¶

⚼ Request

DELETE:  /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/registeredIdentities/{identityName}
{
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
identityName:
{
Description: Name of the protection container to unregister. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}
ReplicationUsages_List (removed)
Description :  Fetches the replication usages of the vault.
Reference :  Link ¶

⚼ Request

GET:  /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/replicationUsages
{
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of replication usages for the given vault. ,
Required: False ,
}
[
{
monitoringSummary:
{
Description: Summary of the replication monitoring data for this vault. ,
Required: False ,
}
{
unHealthyVmCount:
{
Description: Count of unhealthy VMs. ,
Required: False ,
}
integer ,
unHealthyProviderCount:
{
Description: Count of unhealthy replication providers. ,
Required: False ,
}
integer ,
eventsCount:
{
Description: Count of all critical warnings. ,
Required: False ,
}
integer ,
deprecatedProviderCount:
{
Description: Count of all deprecated recovery service providers. ,
Required: False ,
}
integer ,
supportedProviderCount:
{
Description: Count of all the supported recovery service providers. ,
Required: False ,
}
integer ,
unsupportedProviderCount:
{
Description: Count of all the unsupported recovery service providers. ,
Required: False ,
}
integer ,
}
,
jobsSummary:
{
Description: Summary of the replication jobs data for this vault. ,
Required: False ,
}
{
failedJobs:
{
Description: Count of failed jobs. ,
Required: False ,
}
integer ,
suspendedJobs:
{
Description: Count of suspended jobs. ,
Required: False ,
}
integer ,
inProgressJobs:
{
Description: Count of in-progress jobs. ,
Required: False ,
}
integer ,
}
,
protectedItemCount:
{
Description: Number of replication protected items for this vault. ,
Required: False ,
}
integer ,
recoveryPlanCount:
{
Description: Number of replication recovery plans for this vault. ,
Required: False ,
}
integer ,
registeredServersCount:
{
Description: Number of servers registered to this vault. ,
Required: False ,
}
integer ,
recoveryServicesProviderAuthType:
{
Description: The authentication type of recovery service providers in the vault. ,
Required: False ,
}
integer ,
}
,
]
,
}
PrivateLinkResources_List (removed)
Description :  Returns the list of private link resources that need to be created for Backup and SiteRecovery
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/privateLinkResources
{
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A collection of private link resources ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties ,
Required: False ,
}
{
groupId:
{
Description: e.g. f9ad6492-33d4-4690-9999-6bfd52a0d081 (Backup) or f9ad6492-33d4-4690-9999-6bfd52a0d082 (SiteRecovery) ,
Required: False ,
}
string ,
requiredMembers:
{
Description: [backup-ecs1, backup-prot1, backup-prot1b, backup-prot1c, backup-id1] ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: The private link resource Private link DNS zone name. ,
Required: False ,
}
[
string ,
]
,
}
,
id:
{
Description: Fully qualified identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: e.g. Microsoft.RecoveryServices/vaults/privateLinkResources ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Link to the next chunk of the response ,
Required: False ,
}
string ,
}
PrivateLinkResources_Get (removed)
Description :  Returns a specified private link resource that need to be created for Backup and SiteRecovery
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/privateLinkResources/{privateLinkResourceName}
{
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
privateLinkResourceName:
{
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties ,
Required: False ,
}
{
groupId:
{
Description: e.g. f9ad6492-33d4-4690-9999-6bfd52a0d081 (Backup) or f9ad6492-33d4-4690-9999-6bfd52a0d082 (SiteRecovery) ,
Required: False ,
}
string ,
requiredMembers:
{
Description: [backup-ecs1, backup-prot1, backup-prot1b, backup-prot1c, backup-id1] ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: The private link resource Private link DNS zone name. ,
Required: False ,
}
[
string ,
]
,
}
,
id:
{
Description: Fully qualified identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: e.g. Microsoft.RecoveryServices/vaults/privateLinkResources ,
Required: False ,
}
string ,
}
RecoveryServices_CheckNameAvailability (removed)
Description :  API to check for resource name availability. A name is available if no other resource exists that has the same SubscriptionId, Resource Name and Type or if one or more such resources exist, each of these must be GC'd and their time of deletion be more than 24 Hours Ago
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/locations/{location}/checkNameAvailability
{
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
location:
{
Description: Location of the resource ,
Required: True ,
}
string ,
input:
{
Description: Contains information about Resource type and Resource name ,
Required: True ,
}
{
type:
{
Description: Describes the Resource type: Microsoft.RecoveryServices/Vaults ,
Required: False ,
}
string ,
name:
{
Description: Resource name for which availability needs to be checked ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
nameAvailable:
{
Required: False ,
}
boolean ,
reason:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
}
Vaults_ListBySubscriptionId (removed)
Description :  Fetches all the resources of the specified type in the subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.RecoveryServices/vaults
{
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
properties:
{
Description: Properties of the vault. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning State. ,
Required: False ,
}
string ,
upgradeDetails:
{
Description: Details for upgrading vault. ,
Required: False ,
}
{
operationId:
{
Description: ID of the vault upgrade operation. ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: UTC time at which the upgrade operation has started. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedTimeUtc:
{
Description: UTC time at which the upgrade operation status was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
endTimeUtc:
{
Description: UTC time at which the upgrade operation has ended. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Status of the vault upgrade operation. ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Upgraded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Message to the user containing information about the upgrade operation. ,
Required: False ,
}
string ,
triggerType:
{
Description: The way the vault upgrade was triggered. ,
Enum:
{
UserTriggered: No description available. ,
ForcedUpgrade: No description available. ,
}
,
Required: False ,
}
enum ,
upgradedResourceId:
{
Description: Resource ID of the upgraded vault. ,
Required: False ,
}
string ,
previousResourceId:
{
Description: Resource ID of the vault before the upgrade. ,
Required: False ,
}
string ,
}
,
privateEndpointConnections:
{
Description: List of private endpoint connection. ,
Required: False ,
}
[
{
id:
{
Description: Format of id subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.[Service]/{resource}/{resourceName}/privateEndpointConnections/{connectionName}. ,
Required: False ,
}
string ,
properties:
{
Description: Private Endpoint Connection Response Properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets provisioning state of the private endpoint connection. ,
Enum:
{
Succeeded: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The Private Endpoint network resource that is linked to the Private Endpoint connection. ,
Required: False ,
}
{
id:
{
Description: Gets or sets id. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Gets or sets private link service connection state. ,
Required: False ,
}
{
status:
{
Description: Gets or sets the status. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Gets or sets description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Gets or sets actions required. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
privateEndpointStateForBackup:
{
Description: Private endpoint state for backup. ,
Enum:
{
None: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointStateForSiteRecovery:
{
Description: Private endpoint state for site recovery. ,
Enum:
{
None: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Identifies the unique system identifier for each Azure resource. ,
Required: False ,
}
{
name:
{
Description: The Sku name. ,
Enum:
{
Standard: No description available. ,
RS0: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Required: False ,
}
string ,
}
Operations_List (removed)
Description :  Returns the list of available operations.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: List of available operations. ,
Required: False ,
}
[
{
name:
{
Description: Name of the Operation. ,
Required: False ,
}
string ,
display:
{
Description: Contains the localized display information for this particular operation ,
Required: False ,
}
{
provider:
{
Description: Name of the provider for display purposes ,
Required: False ,
}
string ,
resource:
{
Description: ResourceType for which this Operation can be performed. ,
Required: False ,
}
string ,
operation:
{
Description: Operations Name itself. ,
Required: False ,
}
string ,
description:
{
Description: Description of the operation having details of what operation is about. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation;governs the display of the operation in the RBAC UX and the audit logs UX ,
Required: False ,
}
string ,
properties:
{
Description: ShoeBox properties for the given operation. ,
Required: False ,
}
{
serviceSpecification:
{
Description: Operation properties. ,
Required: False ,
}
{
logSpecifications:
{
Description: List of log specifications of this operation. ,
Required: False ,
}
[
{
name:
{
Description: Name of the log. ,
Required: False ,
}
string ,
displayName:
{
Description: Localized display name ,
Required: False ,
}
string ,
blobDuration:
{
Description: Blobs created in customer storage account per hour ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next chunk of the response ,
Required: False ,
}
string ,
}
Vaults_ListByResourceGroup (removed)
Description :  Retrieve a list of Vaults.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults
{
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
properties:
{
Description: Properties of the vault. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning State. ,
Required: False ,
}
string ,
upgradeDetails:
{
Description: Details for upgrading vault. ,
Required: False ,
}
{
operationId:
{
Description: ID of the vault upgrade operation. ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: UTC time at which the upgrade operation has started. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedTimeUtc:
{
Description: UTC time at which the upgrade operation status was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
endTimeUtc:
{
Description: UTC time at which the upgrade operation has ended. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Status of the vault upgrade operation. ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Upgraded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Message to the user containing information about the upgrade operation. ,
Required: False ,
}
string ,
triggerType:
{
Description: The way the vault upgrade was triggered. ,
Enum:
{
UserTriggered: No description available. ,
ForcedUpgrade: No description available. ,
}
,
Required: False ,
}
enum ,
upgradedResourceId:
{
Description: Resource ID of the upgraded vault. ,
Required: False ,
}
string ,
previousResourceId:
{
Description: Resource ID of the vault before the upgrade. ,
Required: False ,
}
string ,
}
,
privateEndpointConnections:
{
Description: List of private endpoint connection. ,
Required: False ,
}
[
{
id:
{
Description: Format of id subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.[Service]/{resource}/{resourceName}/privateEndpointConnections/{connectionName}. ,
Required: False ,
}
string ,
properties:
{
Description: Private Endpoint Connection Response Properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets provisioning state of the private endpoint connection. ,
Enum:
{
Succeeded: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The Private Endpoint network resource that is linked to the Private Endpoint connection. ,
Required: False ,
}
{
id:
{
Description: Gets or sets id. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Gets or sets private link service connection state. ,
Required: False ,
}
{
status:
{
Description: Gets or sets the status. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Gets or sets description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Gets or sets actions required. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
privateEndpointStateForBackup:
{
Description: Private endpoint state for backup. ,
Enum:
{
None: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointStateForSiteRecovery:
{
Description: Private endpoint state for site recovery. ,
Enum:
{
None: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Identifies the unique system identifier for each Azure resource. ,
Required: False ,
}
{
name:
{
Description: The Sku name. ,
Enum:
{
Standard: No description available. ,
RS0: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Required: False ,
}
string ,
}
Vaults_Get (removed)
Description :  Get the Vault details.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}
{
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
properties:
{
Description: Properties of the vault. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning State. ,
Required: False ,
}
string ,
upgradeDetails:
{
Description: Details for upgrading vault. ,
Required: False ,
}
{
operationId:
{
Description: ID of the vault upgrade operation. ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: UTC time at which the upgrade operation has started. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedTimeUtc:
{
Description: UTC time at which the upgrade operation status was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
endTimeUtc:
{
Description: UTC time at which the upgrade operation has ended. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Status of the vault upgrade operation. ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Upgraded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Message to the user containing information about the upgrade operation. ,
Required: False ,
}
string ,
triggerType:
{
Description: The way the vault upgrade was triggered. ,
Enum:
{
UserTriggered: No description available. ,
ForcedUpgrade: No description available. ,
}
,
Required: False ,
}
enum ,
upgradedResourceId:
{
Description: Resource ID of the upgraded vault. ,
Required: False ,
}
string ,
previousResourceId:
{
Description: Resource ID of the vault before the upgrade. ,
Required: False ,
}
string ,
}
,
privateEndpointConnections:
{
Description: List of private endpoint connection. ,
Required: False ,
}
[
{
id:
{
Description: Format of id subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.[Service]/{resource}/{resourceName}/privateEndpointConnections/{connectionName}. ,
Required: False ,
}
string ,
properties:
{
Description: Private Endpoint Connection Response Properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets provisioning state of the private endpoint connection. ,
Enum:
{
Succeeded: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The Private Endpoint network resource that is linked to the Private Endpoint connection. ,
Required: False ,
}
{
id:
{
Description: Gets or sets id. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Gets or sets private link service connection state. ,
Required: False ,
}
{
status:
{
Description: Gets or sets the status. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Gets or sets description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Gets or sets actions required. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
privateEndpointStateForBackup:
{
Description: Private endpoint state for backup. ,
Enum:
{
None: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointStateForSiteRecovery:
{
Description: Private endpoint state for site recovery. ,
Enum:
{
None: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Identifies the unique system identifier for each Azure resource. ,
Required: False ,
}
{
name:
{
Description: The Sku name. ,
Enum:
{
Standard: No description available. ,
RS0: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
Vaults_CreateOrUpdate (removed)
Description :  Creates or updates a Recovery Services vault.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}
{
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
vault:
{
Description: Recovery Services Vault to be created. ,
Required: True ,
}
{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
properties:
{
Description: Properties of the vault. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning State. ,
Required: False ,
}
string ,
upgradeDetails:
{
Description: Details for upgrading vault. ,
Required: False ,
}
{
operationId:
{
Description: ID of the vault upgrade operation. ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: UTC time at which the upgrade operation has started. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedTimeUtc:
{
Description: UTC time at which the upgrade operation status was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
endTimeUtc:
{
Description: UTC time at which the upgrade operation has ended. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Status of the vault upgrade operation. ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Upgraded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Message to the user containing information about the upgrade operation. ,
Required: False ,
}
string ,
triggerType:
{
Description: The way the vault upgrade was triggered. ,
Enum:
{
UserTriggered: No description available. ,
ForcedUpgrade: No description available. ,
}
,
Required: False ,
}
enum ,
upgradedResourceId:
{
Description: Resource ID of the upgraded vault. ,
Required: False ,
}
string ,
previousResourceId:
{
Description: Resource ID of the vault before the upgrade. ,
Required: False ,
}
string ,
}
,
privateEndpointConnections:
{
Description: List of private endpoint connection. ,
Required: False ,
}
[
{
id:
{
Description: Format of id subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.[Service]/{resource}/{resourceName}/privateEndpointConnections/{connectionName}. ,
Required: False ,
}
string ,
properties:
{
Description: Private Endpoint Connection Response Properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets provisioning state of the private endpoint connection. ,
Enum:
{
Succeeded: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The Private Endpoint network resource that is linked to the Private Endpoint connection. ,
Required: False ,
}
{
id:
{
Description: Gets or sets id. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Gets or sets private link service connection state. ,
Required: False ,
}
{
status:
{
Description: Gets or sets the status. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Gets or sets description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Gets or sets actions required. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
privateEndpointStateForBackup:
{
Description: Private endpoint state for backup. ,
Enum:
{
None: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointStateForSiteRecovery:
{
Description: Private endpoint state for site recovery. ,
Enum:
{
None: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Identifies the unique system identifier for each Azure resource. ,
Required: False ,
}
{
name:
{
Description: The Sku name. ,
Enum:
{
Standard: No description available. ,
RS0: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
properties:
{
Description: Properties of the vault. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning State. ,
Required: False ,
}
string ,
upgradeDetails:
{
Description: Details for upgrading vault. ,
Required: False ,
}
{
operationId:
{
Description: ID of the vault upgrade operation. ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: UTC time at which the upgrade operation has started. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedTimeUtc:
{
Description: UTC time at which the upgrade operation status was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
endTimeUtc:
{
Description: UTC time at which the upgrade operation has ended. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Status of the vault upgrade operation. ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Upgraded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Message to the user containing information about the upgrade operation. ,
Required: False ,
}
string ,
triggerType:
{
Description: The way the vault upgrade was triggered. ,
Enum:
{
UserTriggered: No description available. ,
ForcedUpgrade: No description available. ,
}
,
Required: False ,
}
enum ,
upgradedResourceId:
{
Description: Resource ID of the upgraded vault. ,
Required: False ,
}
string ,
previousResourceId:
{
Description: Resource ID of the vault before the upgrade. ,
Required: False ,
}
string ,
}
,
privateEndpointConnections:
{
Description: List of private endpoint connection. ,
Required: False ,
}
[
{
id:
{
Description: Format of id subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.[Service]/{resource}/{resourceName}/privateEndpointConnections/{connectionName}. ,
Required: False ,
}
string ,
properties:
{
Description: Private Endpoint Connection Response Properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets provisioning state of the private endpoint connection. ,
Enum:
{
Succeeded: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The Private Endpoint network resource that is linked to the Private Endpoint connection. ,
Required: False ,
}
{
id:
{
Description: Gets or sets id. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Gets or sets private link service connection state. ,
Required: False ,
}
{
status:
{
Description: Gets or sets the status. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Gets or sets description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Gets or sets actions required. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
privateEndpointStateForBackup:
{
Description: Private endpoint state for backup. ,
Enum:
{
None: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointStateForSiteRecovery:
{
Description: Private endpoint state for site recovery. ,
Enum:
{
None: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Identifies the unique system identifier for each Azure resource. ,
Required: False ,
}
{
name:
{
Description: The Sku name. ,
Enum:
{
Standard: No description available. ,
RS0: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (201)

{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
properties:
{
Description: Properties of the vault. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning State. ,
Required: False ,
}
string ,
upgradeDetails:
{
Description: Details for upgrading vault. ,
Required: False ,
}
{
operationId:
{
Description: ID of the vault upgrade operation. ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: UTC time at which the upgrade operation has started. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedTimeUtc:
{
Description: UTC time at which the upgrade operation status was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
endTimeUtc:
{
Description: UTC time at which the upgrade operation has ended. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Status of the vault upgrade operation. ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Upgraded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Message to the user containing information about the upgrade operation. ,
Required: False ,
}
string ,
triggerType:
{
Description: The way the vault upgrade was triggered. ,
Enum:
{
UserTriggered: No description available. ,
ForcedUpgrade: No description available. ,
}
,
Required: False ,
}
enum ,
upgradedResourceId:
{
Description: Resource ID of the upgraded vault. ,
Required: False ,
}
string ,
previousResourceId:
{
Description: Resource ID of the vault before the upgrade. ,
Required: False ,
}
string ,
}
,
privateEndpointConnections:
{
Description: List of private endpoint connection. ,
Required: False ,
}
[
{
id:
{
Description: Format of id subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.[Service]/{resource}/{resourceName}/privateEndpointConnections/{connectionName}. ,
Required: False ,
}
string ,
properties:
{
Description: Private Endpoint Connection Response Properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets provisioning state of the private endpoint connection. ,
Enum:
{
Succeeded: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The Private Endpoint network resource that is linked to the Private Endpoint connection. ,
Required: False ,
}
{
id:
{
Description: Gets or sets id. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Gets or sets private link service connection state. ,
Required: False ,
}
{
status:
{
Description: Gets or sets the status. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Gets or sets description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Gets or sets actions required. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
privateEndpointStateForBackup:
{
Description: Private endpoint state for backup. ,
Enum:
{
None: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointStateForSiteRecovery:
{
Description: Private endpoint state for site recovery. ,
Enum:
{
None: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Identifies the unique system identifier for each Azure resource. ,
Required: False ,
}
{
name:
{
Description: The Sku name. ,
Enum:
{
Standard: No description available. ,
RS0: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
Vaults_Delete (removed)
Description :  Deletes a vault.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}
{
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}
Vaults_Update (removed)
Description :  Updates the vault.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}
{
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
vault:
{
Description: Recovery Services Vault to be created. ,
Required: True ,
}
{
properties:
{
Description: Properties of the vault. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning State. ,
Required: False ,
}
string ,
upgradeDetails:
{
Description: Details for upgrading vault. ,
Required: False ,
}
{
operationId:
{
Description: ID of the vault upgrade operation. ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: UTC time at which the upgrade operation has started. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedTimeUtc:
{
Description: UTC time at which the upgrade operation status was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
endTimeUtc:
{
Description: UTC time at which the upgrade operation has ended. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Status of the vault upgrade operation. ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Upgraded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Message to the user containing information about the upgrade operation. ,
Required: False ,
}
string ,
triggerType:
{
Description: The way the vault upgrade was triggered. ,
Enum:
{
UserTriggered: No description available. ,
ForcedUpgrade: No description available. ,
}
,
Required: False ,
}
enum ,
upgradedResourceId:
{
Description: Resource ID of the upgraded vault. ,
Required: False ,
}
string ,
previousResourceId:
{
Description: Resource ID of the vault before the upgrade. ,
Required: False ,
}
string ,
}
,
privateEndpointConnections:
{
Description: List of private endpoint connection. ,
Required: False ,
}
[
{
id:
{
Description: Format of id subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.[Service]/{resource}/{resourceName}/privateEndpointConnections/{connectionName}. ,
Required: False ,
}
string ,
properties:
{
Description: Private Endpoint Connection Response Properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets provisioning state of the private endpoint connection. ,
Enum:
{
Succeeded: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The Private Endpoint network resource that is linked to the Private Endpoint connection. ,
Required: False ,
}
{
id:
{
Description: Gets or sets id. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Gets or sets private link service connection state. ,
Required: False ,
}
{
status:
{
Description: Gets or sets the status. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Gets or sets description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Gets or sets actions required. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
privateEndpointStateForBackup:
{
Description: Private endpoint state for backup. ,
Enum:
{
None: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointStateForSiteRecovery:
{
Description: Private endpoint state for site recovery. ,
Enum:
{
None: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Identifies the unique system identifier for each Azure resource. ,
Required: False ,
}
{
name:
{
Description: The Sku name. ,
Enum:
{
Standard: No description available. ,
RS0: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
properties:
{
Description: Properties of the vault. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning State. ,
Required: False ,
}
string ,
upgradeDetails:
{
Description: Details for upgrading vault. ,
Required: False ,
}
{
operationId:
{
Description: ID of the vault upgrade operation. ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: UTC time at which the upgrade operation has started. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedTimeUtc:
{
Description: UTC time at which the upgrade operation status was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
endTimeUtc:
{
Description: UTC time at which the upgrade operation has ended. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Status of the vault upgrade operation. ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Upgraded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Message to the user containing information about the upgrade operation. ,
Required: False ,
}
string ,
triggerType:
{
Description: The way the vault upgrade was triggered. ,
Enum:
{
UserTriggered: No description available. ,
ForcedUpgrade: No description available. ,
}
,
Required: False ,
}
enum ,
upgradedResourceId:
{
Description: Resource ID of the upgraded vault. ,
Required: False ,
}
string ,
previousResourceId:
{
Description: Resource ID of the vault before the upgrade. ,
Required: False ,
}
string ,
}
,
privateEndpointConnections:
{
Description: List of private endpoint connection. ,
Required: False ,
}
[
{
id:
{
Description: Format of id subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.[Service]/{resource}/{resourceName}/privateEndpointConnections/{connectionName}. ,
Required: False ,
}
string ,
properties:
{
Description: Private Endpoint Connection Response Properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets provisioning state of the private endpoint connection. ,
Enum:
{
Succeeded: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The Private Endpoint network resource that is linked to the Private Endpoint connection. ,
Required: False ,
}
{
id:
{
Description: Gets or sets id. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Gets or sets private link service connection state. ,
Required: False ,
}
{
status:
{
Description: Gets or sets the status. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Gets or sets description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Gets or sets actions required. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
privateEndpointStateForBackup:
{
Description: Private endpoint state for backup. ,
Enum:
{
None: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointStateForSiteRecovery:
{
Description: Private endpoint state for site recovery. ,
Enum:
{
None: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Identifies the unique system identifier for each Azure resource. ,
Required: False ,
}
{
name:
{
Description: The Sku name. ,
Enum:
{
Standard: No description available. ,
RS0: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (201)

{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
properties:
{
Description: Properties of the vault. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning State. ,
Required: False ,
}
string ,
upgradeDetails:
{
Description: Details for upgrading vault. ,
Required: False ,
}
{
operationId:
{
Description: ID of the vault upgrade operation. ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: UTC time at which the upgrade operation has started. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedTimeUtc:
{
Description: UTC time at which the upgrade operation status was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
endTimeUtc:
{
Description: UTC time at which the upgrade operation has ended. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Status of the vault upgrade operation. ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Upgraded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Message to the user containing information about the upgrade operation. ,
Required: False ,
}
string ,
triggerType:
{
Description: The way the vault upgrade was triggered. ,
Enum:
{
UserTriggered: No description available. ,
ForcedUpgrade: No description available. ,
}
,
Required: False ,
}
enum ,
upgradedResourceId:
{
Description: Resource ID of the upgraded vault. ,
Required: False ,
}
string ,
previousResourceId:
{
Description: Resource ID of the vault before the upgrade. ,
Required: False ,
}
string ,
}
,
privateEndpointConnections:
{
Description: List of private endpoint connection. ,
Required: False ,
}
[
{
id:
{
Description: Format of id subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.[Service]/{resource}/{resourceName}/privateEndpointConnections/{connectionName}. ,
Required: False ,
}
string ,
properties:
{
Description: Private Endpoint Connection Response Properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets provisioning state of the private endpoint connection. ,
Enum:
{
Succeeded: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The Private Endpoint network resource that is linked to the Private Endpoint connection. ,
Required: False ,
}
{
id:
{
Description: Gets or sets id. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Gets or sets private link service connection state. ,
Required: False ,
}
{
status:
{
Description: Gets or sets the status. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Gets or sets description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Gets or sets actions required. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
privateEndpointStateForBackup:
{
Description: Private endpoint state for backup. ,
Enum:
{
None: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointStateForSiteRecovery:
{
Description: Private endpoint state for site recovery. ,
Enum:
{
None: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Identifies the unique system identifier for each Azure resource. ,
Required: False ,
}
{
name:
{
Description: The Sku name. ,
Enum:
{
Standard: No description available. ,
RS0: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
VaultExtendedInfo_Get (removed)
Description :  Get the vault extended info.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/extendedInformation/vaultExtendedInfo
{
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Vault extended information. ,
Required: False ,
}
{
integrityKey:
{
Description: Integrity key. ,
Required: False ,
}
string ,
encryptionKey:
{
Description: Encryption key. ,
Required: False ,
}
string ,
encryptionKeyThumbprint:
{
Description: Encryption key thumbprint. ,
Required: False ,
}
string ,
algorithm:
{
Description: Algorithm for Vault ExtendedInfo ,
Required: False ,
}
string ,
}
,
}
VaultExtendedInfo_CreateOrUpdate (removed)
Description :  Create vault extended info.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/extendedInformation/vaultExtendedInfo
{
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceResourceExtendedInfoDetails:
{
Description: Details of ResourceExtendedInfo ,
Required: True ,
}
{
properties:
{
Description: Vault extended information. ,
Required: False ,
}
{
integrityKey:
{
Description: Integrity key. ,
Required: False ,
}
string ,
encryptionKey:
{
Description: Encryption key. ,
Required: False ,
}
string ,
encryptionKeyThumbprint:
{
Description: Encryption key thumbprint. ,
Required: False ,
}
string ,
algorithm:
{
Description: Algorithm for Vault ExtendedInfo ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Vault extended information. ,
Required: False ,
}
{
integrityKey:
{
Description: Integrity key. ,
Required: False ,
}
string ,
encryptionKey:
{
Description: Encryption key. ,
Required: False ,
}
string ,
encryptionKeyThumbprint:
{
Description: Encryption key thumbprint. ,
Required: False ,
}
string ,
algorithm:
{
Description: Algorithm for Vault ExtendedInfo ,
Required: False ,
}
string ,
}
,
}
VaultExtendedInfo_Update (removed)
Description :  Update vault extended info.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/extendedInformation/vaultExtendedInfo
{
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceResourceExtendedInfoDetails:
{
Description: Details of ResourceExtendedInfo ,
Required: True ,
}
{
properties:
{
Description: Vault extended information. ,
Required: False ,
}
{
integrityKey:
{
Description: Integrity key. ,
Required: False ,
}
string ,
encryptionKey:
{
Description: Encryption key. ,
Required: False ,
}
string ,
encryptionKeyThumbprint:
{
Description: Encryption key thumbprint. ,
Required: False ,
}
string ,
algorithm:
{
Description: Algorithm for Vault ExtendedInfo ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Vault extended information. ,
Required: False ,
}
{
integrityKey:
{
Description: Integrity key. ,
Required: False ,
}
string ,
encryptionKey:
{
Description: Encryption key. ,
Required: False ,
}
string ,
encryptionKeyThumbprint:
{
Description: Encryption key thumbprint. ,
Required: False ,
}
string ,
algorithm:
{
Description: Algorithm for Vault ExtendedInfo ,
Required: False ,
}
string ,
}
,
}
Usages_ListByVaults (removed)
Description :  Fetches the usages of the vault.
Reference :  Link ¶

⚼ Request

GET:  /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/usages
{
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of usages for the given vault. ,
Required: False ,
}
[
{
unit:
{
Description: Unit of the usage. ,
Enum:
{
Count: No description available. ,
Bytes: No description available. ,
Seconds: No description available. ,
Percent: No description available. ,
CountPerSecond: No description available. ,
BytesPerSecond: No description available. ,
}
,
Required: False ,
}
enum ,
quotaPeriod:
{
Description: Quota period of usage. ,
Required: False ,
}
string ,
nextResetTime:
{
Description: Next reset time of usage. ,
Format: date-time ,
Required: False ,
}
string ,
currentValue:
{
Description: Current value of usage. ,
Format: int64 ,
Required: False ,
}
integer ,
limit:
{
Description: Limit of usage. ,
Format: int64 ,
Required: False ,
}
integer ,
name:
{
Description: Name of usage. ,
Required: False ,
}
{
value:
{
Description: Value of usage. ,
Required: False ,
}
string ,
localizedValue:
{
Description: Localized value of usage. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}