Microsoft.RecoveryServices (preview:2024-09-30)

2025/01/09 • 24 new 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 ID of the target subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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 ID of the target subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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 ID of the target subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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 ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
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 ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
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 ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
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 ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
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 ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
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 ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
}
,
}
RecoveryServices_Capabilities (new)
Description :  API to get details about capabilities provided by Microsoft.RecoveryServices RP
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.RecoveryServices/locations/{location}/capabilities
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
location:
{
Description: Location of the resource ,
Required: True ,
}
string ,
input:
{
Description: Contains information about Resource type and properties to get capabilities ,
Required: True ,
}
{
properties:
{
Description: Capabilities information ,
Required: False ,
}
{
dnsZones:
{
Required: False ,
}
[
{
subResource:
{
Description: Subresource type for vault AzureBackup, AzureBackup_secondary or AzureSiteRecovery ,
Enum:
{
AzureBackup: No description available. ,
AzureBackup_secondary: No description available. ,
AzureSiteRecovery: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Capabilities properties in response ,
Required: False ,
}
{
dnsZones:
{
Required: False ,
}
[
{
requiredZoneNames:
{
Description: The private link resource Private link DNS zone names. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
}
,
}
DeletedVaults_ListBySubscriptionId (new)
Description :  List of all DeletedVaults in the subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.RecoveryServices/locations/{location}/deletedVaults
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of DeletedVaults. ,
Required: False ,
}
[
{
id:
{
Description: ARM ID of the resource. ,
Required: False ,
}
string ,
name:
{
Description: ARM name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Type of resource. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the DeletedVault. ,
Required: False ,
}
{
vaultId:
{
Description: ARM Id of the Vault which was deleted. ,
Required: False ,
}
string ,
vaultDeletionTime:
{
Description: Time in UTC at which the Vault was deleted. ,
Format: date-time ,
Required: False ,
}
string ,
purgeAt:
{
Description: Time in UTC at which the DeletedVault will be purged. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The value of next link. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
}
,
}
DeletedVaults_Get (new)
Description :  Get the DeletedVault details.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.RecoveryServices/locations/{location}/deletedVaults/{deletedVaultName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
deletedVaultName:
{
Description: The name of the deleted recovery services vault. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: ARM ID of the resource. ,
Required: False ,
}
string ,
name:
{
Description: ARM name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Type of resource. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the DeletedVault. ,
Required: False ,
}
{
vaultId:
{
Description: ARM Id of the Vault which was deleted. ,
Required: False ,
}
string ,
vaultDeletionTime:
{
Description: Time in UTC at which the Vault was deleted. ,
Format: date-time ,
Required: False ,
}
string ,
purgeAt:
{
Description: Time in UTC at which the DeletedVault will be purged. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
}
,
}
DeletedVaults_Undelete (new)
Description :  Undelete the DeletedVault.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.RecoveryServices/locations/{location}/deletedVaults/{deletedVaultName}/undelete
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
deletedVaultName:
{
Description: The name of the deleted recovery services vault. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
undeleteInput:
{
Description: Undelete input. ,
Required: True ,
}
{
properties:
{
Description: Undelete input properties. ,
Required: True ,
}
{
recoveryResourceGroupId:
{
Description: Recovery resource group Id. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
id:
{
Description: ARM ID of the resource. ,
Required: False ,
}
string ,
name:
{
Description: ARM name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Type of resource. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the DeletedVault. ,
Required: False ,
}
{
vaultId:
{
Description: ARM Id of the Vault which was deleted. ,
Required: False ,
}
string ,
vaultDeletionTime:
{
Description: Time in UTC at which the Vault was deleted. ,
Format: date-time ,
Required: False ,
}
string ,
purgeAt:
{
Description: Time in UTC at which the DeletedVault will be purged. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DeletedVaults_GetOperationStatus (new)
Description :  Gets the operation status for a DeletedVault.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.RecoveryServices/locations/{location}/deletedVaults/{deletedVaultName}/operations/{operationId}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
deletedVaultName:
{
Description: The name of the deleted recovery services vault. ,
Required: True ,
}
string ,
operationId:
{
Description: The ID of an ongoing async operation. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
endTime:
{
Description: End time of the operation ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Required if status == failed or status == canceled. This is the OData v4 error format, used by the RPC and will go into the v2.2 Azure REST API guidelines. ,
Required: False ,
}
{
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
}
,
id:
{
Description: It should match what is used to GET the operation result ,
Required: False ,
}
string ,
name:
{
Description: It must match the last segment of the "id" field, and will typically be a GUID / system generated value ,
Required: False ,
}
string ,
status:
{
Description: The status of the operation. (InProgress/Success/Failed/Cancelled) ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the operation ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
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 ID of the target subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
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 type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identities. ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user-assigned identities associated with the resource. The user-assigned identity dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
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 ,
}
,
groupIds:
{
Description: Group Ids for the Private Endpoint ,
Required: False ,
}
[
string ,
]
,
}
,
name:
{
Description: The name of the private Endpoint Connection ,
Required: False ,
}
string ,
type:
{
Description: The type, which will be of the format, Microsoft.RecoveryServices/vaults/privateEndpointConnections ,
Required: False ,
}
string ,
location:
{
Description: The location of the private Endpoint connection ,
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 ,
encryption:
{
Description: Customer Managed Key details of the resource. ,
Required: False ,
}
{
keyVaultProperties:
{
Description: The properties of the Key Vault which hosts CMK ,
Required: False ,
}
{
keyUri:
{
Description: The key uri of the Customer Managed Key ,
Required: False ,
}
string ,
}
,
kekIdentity:
{
Description: The details of the identity used for CMK ,
Required: False ,
}
{
useSystemAssignedIdentity:
{
Description: Indicate that system assigned identity should be used. Mutually exclusive with 'userAssignedIdentity' field ,
Required: False ,
}
boolean ,
userAssignedIdentity:
{
Description: The user assigned identity to be used to grant permissions in case the type of identity used is UserAssigned ,
Required: False ,
}
string ,
}
,
infrastructureEncryption:
{
Description: Enabling/Disabling the Double Encryption state ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
moveDetails:
{
Description: The details of the latest move operation performed on the Azure Resource ,
Required: False ,
}
{
operationId:
{
Description: OperationId of the Resource Move Operation ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: Start Time of the Resource Move Operation ,
Format: date-time ,
Required: False ,
}
string ,
completionTimeUtc:
{
Description: End Time of the Resource Move Operation ,
Format: date-time ,
Required: False ,
}
string ,
sourceResourceId:
{
Description: Source Resource of the Resource Move Operation ,
Required: False ,
}
string ,
targetResourceId:
{
Description: Target Resource of the Resource Move Operation ,
Required: False ,
}
string ,
}
,
moveState:
{
Description: The State of the Resource after the move operation ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
PrepareFailed: No description available. ,
CommitFailed: No description available. ,
PrepareTimedout: No description available. ,
CommitTimedout: No description available. ,
MoveSucceeded: No description available. ,
Failure: No description available. ,
CriticalFailure: No description available. ,
PartialSuccess: No description available. ,
}
,
Required: False ,
}
enum ,
backupStorageVersion:
{
Description: Backup storage version ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
Unassigned: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: property to enable or disable resource provider inbound network traffic from public clients ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
monitoringSettings:
{
Description: Monitoring Settings of the vault ,
Required: False ,
}
{
azureMonitorAlertSettings:
{
Description: Settings for Azure Monitor based alerts ,
Required: False ,
}
{
alertsForAllJobFailures:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
alertsForAllReplicationIssues:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
alertsForAllFailoverIssues:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
classicAlertSettings:
{
Description: Settings for classic alerts ,
Required: False ,
}
{
alertsForCriticalOperations:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
emailNotificationsForSiteRecovery:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
restoreSettings:
{
Description: Restore Settings of the vault ,
Required: False ,
}
{
crossSubscriptionRestoreSettings:
{
Description: Settings for CrossSubscriptionRestore ,
Required: False ,
}
{
crossSubscriptionRestoreState:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
PermanentlyDisabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
redundancySettings:
{
Description: The redundancy Settings of a Vault ,
Required: False ,
}
{
standardTierStorageRedundancy:
{
Description: The storage redundancy setting of a vault ,
Enum:
{
Invalid: No description available. ,
LocallyRedundant: No description available. ,
GeoRedundant: No description available. ,
ZoneRedundant: No description available. ,
}
,
Required: False ,
}
enum ,
crossRegionRestore:
{
Description: Flag to show if Cross Region Restore is enabled on the Vault or not ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
securitySettings:
{
Description: Security Settings of the vault ,
Required: False ,
}
{
immutabilitySettings:
{
Description: Immutability Settings of a vault ,
Required: False ,
}
{
state:
{
Enum:
{
Disabled: No description available. ,
Unlocked: No description available. ,
Locked: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
softDeleteSettings:
{
Description: Soft delete Settings of a vault ,
Required: False ,
}
{
softDeleteState:
{
Enum:
{
Invalid: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
AlwaysON: No description available. ,
}
,
Required: False ,
}
enum ,
softDeleteRetentionPeriodInDays:
{
Description: Soft delete retention period in days ,
Format: int32 ,
Required: False ,
}
integer ,
enhancedSecurityState:
{
Enum:
{
Invalid: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
AlwaysON: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
multiUserAuthorization:
{
Description: MUA Settings of a vault ,
Enum:
{
Invalid: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
secureScore:
{
Description: Secure Score of Recovery Services Vault ,
Enum:
{
None: No description available. ,
Minimum: No description available. ,
Adequate: No description available. ,
Maximum: No description available. ,
}
,
Required: False ,
}
enum ,
bcdrSecurityLevel:
{
Description: Security levels of Recovery Services Vault for business continuity and disaster recovery ,
Enum:
{
Poor: No description available. ,
Fair: No description available. ,
Good: No description available. ,
Excellent: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuardOperationRequests:
{
Description: ResourceGuardOperationRequests on which LAC check will be performed ,
Required: False ,
}
[
string ,
]
,
}
,
sku:
{
Description: Identifies the unique system identifier for each Azure resource. ,
Required: False ,
}
{
name:
{
Description: Name of SKU is RS0 (Recovery Services 0th version) and the tier is standard tier. They do not have affect on backend storage redundancy or any other vault settings. To manage storage redundancy, use the backupstorageconfig ,
Enum:
{
Standard: No description available. ,
RS0: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The Sku tier. ,
Required: False ,
}
string ,
family:
{
Description: The sku family ,
Required: False ,
}
string ,
size:
{
Description: The sku size ,
Required: False ,
}
string ,
capacity:
{
Description: The sku capacity ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
}
,
}
Operations_List (new)
Description :  Returns the list of available operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.RecoveryServices/operations
{
api-version:
{
Description: The API version to use for this operation. ,
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 ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
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 ID of the target subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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 type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identities. ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user-assigned identities associated with the resource. The user-assigned identity dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
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 ,
}
,
groupIds:
{
Description: Group Ids for the Private Endpoint ,
Required: False ,
}
[
string ,
]
,
}
,
name:
{
Description: The name of the private Endpoint Connection ,
Required: False ,
}
string ,
type:
{
Description: The type, which will be of the format, Microsoft.RecoveryServices/vaults/privateEndpointConnections ,
Required: False ,
}
string ,
location:
{
Description: The location of the private Endpoint connection ,
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 ,
encryption:
{
Description: Customer Managed Key details of the resource. ,
Required: False ,
}
{
keyVaultProperties:
{
Description: The properties of the Key Vault which hosts CMK ,
Required: False ,
}
{
keyUri:
{
Description: The key uri of the Customer Managed Key ,
Required: False ,
}
string ,
}
,
kekIdentity:
{
Description: The details of the identity used for CMK ,
Required: False ,
}
{
useSystemAssignedIdentity:
{
Description: Indicate that system assigned identity should be used. Mutually exclusive with 'userAssignedIdentity' field ,
Required: False ,
}
boolean ,
userAssignedIdentity:
{
Description: The user assigned identity to be used to grant permissions in case the type of identity used is UserAssigned ,
Required: False ,
}
string ,
}
,
infrastructureEncryption:
{
Description: Enabling/Disabling the Double Encryption state ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
moveDetails:
{
Description: The details of the latest move operation performed on the Azure Resource ,
Required: False ,
}
{
operationId:
{
Description: OperationId of the Resource Move Operation ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: Start Time of the Resource Move Operation ,
Format: date-time ,
Required: False ,
}
string ,
completionTimeUtc:
{
Description: End Time of the Resource Move Operation ,
Format: date-time ,
Required: False ,
}
string ,
sourceResourceId:
{
Description: Source Resource of the Resource Move Operation ,
Required: False ,
}
string ,
targetResourceId:
{
Description: Target Resource of the Resource Move Operation ,
Required: False ,
}
string ,
}
,
moveState:
{
Description: The State of the Resource after the move operation ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
PrepareFailed: No description available. ,
CommitFailed: No description available. ,
PrepareTimedout: No description available. ,
CommitTimedout: No description available. ,
MoveSucceeded: No description available. ,
Failure: No description available. ,
CriticalFailure: No description available. ,
PartialSuccess: No description available. ,
}
,
Required: False ,
}
enum ,
backupStorageVersion:
{
Description: Backup storage version ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
Unassigned: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: property to enable or disable resource provider inbound network traffic from public clients ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
monitoringSettings:
{
Description: Monitoring Settings of the vault ,
Required: False ,
}
{
azureMonitorAlertSettings:
{
Description: Settings for Azure Monitor based alerts ,
Required: False ,
}
{
alertsForAllJobFailures:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
alertsForAllReplicationIssues:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
alertsForAllFailoverIssues:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
classicAlertSettings:
{
Description: Settings for classic alerts ,
Required: False ,
}
{
alertsForCriticalOperations:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
emailNotificationsForSiteRecovery:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
restoreSettings:
{
Description: Restore Settings of the vault ,
Required: False ,
}
{
crossSubscriptionRestoreSettings:
{
Description: Settings for CrossSubscriptionRestore ,
Required: False ,
}
{
crossSubscriptionRestoreState:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
PermanentlyDisabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
redundancySettings:
{
Description: The redundancy Settings of a Vault ,
Required: False ,
}
{
standardTierStorageRedundancy:
{
Description: The storage redundancy setting of a vault ,
Enum:
{
Invalid: No description available. ,
LocallyRedundant: No description available. ,
GeoRedundant: No description available. ,
ZoneRedundant: No description available. ,
}
,
Required: False ,
}
enum ,
crossRegionRestore:
{
Description: Flag to show if Cross Region Restore is enabled on the Vault or not ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
securitySettings:
{
Description: Security Settings of the vault ,
Required: False ,
}
{
immutabilitySettings:
{
Description: Immutability Settings of a vault ,
Required: False ,
}
{
state:
{
Enum:
{
Disabled: No description available. ,
Unlocked: No description available. ,
Locked: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
softDeleteSettings:
{
Description: Soft delete Settings of a vault ,
Required: False ,
}
{
softDeleteState:
{
Enum:
{
Invalid: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
AlwaysON: No description available. ,
}
,
Required: False ,
}
enum ,
softDeleteRetentionPeriodInDays:
{
Description: Soft delete retention period in days ,
Format: int32 ,
Required: False ,
}
integer ,
enhancedSecurityState:
{
Enum:
{
Invalid: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
AlwaysON: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
multiUserAuthorization:
{
Description: MUA Settings of a vault ,
Enum:
{
Invalid: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
secureScore:
{
Description: Secure Score of Recovery Services Vault ,
Enum:
{
None: No description available. ,
Minimum: No description available. ,
Adequate: No description available. ,
Maximum: No description available. ,
}
,
Required: False ,
}
enum ,
bcdrSecurityLevel:
{
Description: Security levels of Recovery Services Vault for business continuity and disaster recovery ,
Enum:
{
Poor: No description available. ,
Fair: No description available. ,
Good: No description available. ,
Excellent: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuardOperationRequests:
{
Description: ResourceGuardOperationRequests on which LAC check will be performed ,
Required: False ,
}
[
string ,
]
,
}
,
sku:
{
Description: Identifies the unique system identifier for each Azure resource. ,
Required: False ,
}
{
name:
{
Description: Name of SKU is RS0 (Recovery Services 0th version) and the tier is standard tier. They do not have affect on backend storage redundancy or any other vault settings. To manage storage redundancy, use the backupstorageconfig ,
Enum:
{
Standard: No description available. ,
RS0: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The Sku tier. ,
Required: False ,
}
string ,
family:
{
Description: The sku family ,
Required: False ,
}
string ,
size:
{
Description: The sku size ,
Required: False ,
}
string ,
capacity:
{
Description: The sku capacity ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
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 ID of the target subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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 type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identities. ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user-assigned identities associated with the resource. The user-assigned identity dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
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 ,
}
,
groupIds:
{
Description: Group Ids for the Private Endpoint ,
Required: False ,
}
[
string ,
]
,
}
,
name:
{
Description: The name of the private Endpoint Connection ,
Required: False ,
}
string ,
type:
{
Description: The type, which will be of the format, Microsoft.RecoveryServices/vaults/privateEndpointConnections ,
Required: False ,
}
string ,
location:
{
Description: The location of the private Endpoint connection ,
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 ,
encryption:
{
Description: Customer Managed Key details of the resource. ,
Required: False ,
}
{
keyVaultProperties:
{
Description: The properties of the Key Vault which hosts CMK ,
Required: False ,
}
{
keyUri:
{
Description: The key uri of the Customer Managed Key ,
Required: False ,
}
string ,
}
,
kekIdentity:
{
Description: The details of the identity used for CMK ,
Required: False ,
}
{
useSystemAssignedIdentity:
{
Description: Indicate that system assigned identity should be used. Mutually exclusive with 'userAssignedIdentity' field ,
Required: False ,
}
boolean ,
userAssignedIdentity:
{
Description: The user assigned identity to be used to grant permissions in case the type of identity used is UserAssigned ,
Required: False ,
}
string ,
}
,
infrastructureEncryption:
{
Description: Enabling/Disabling the Double Encryption state ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
moveDetails:
{
Description: The details of the latest move operation performed on the Azure Resource ,
Required: False ,
}
{
operationId:
{
Description: OperationId of the Resource Move Operation ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: Start Time of the Resource Move Operation ,
Format: date-time ,
Required: False ,
}
string ,
completionTimeUtc:
{
Description: End Time of the Resource Move Operation ,
Format: date-time ,
Required: False ,
}
string ,
sourceResourceId:
{
Description: Source Resource of the Resource Move Operation ,
Required: False ,
}
string ,
targetResourceId:
{
Description: Target Resource of the Resource Move Operation ,
Required: False ,
}
string ,
}
,
moveState:
{
Description: The State of the Resource after the move operation ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
PrepareFailed: No description available. ,
CommitFailed: No description available. ,
PrepareTimedout: No description available. ,
CommitTimedout: No description available. ,
MoveSucceeded: No description available. ,
Failure: No description available. ,
CriticalFailure: No description available. ,
PartialSuccess: No description available. ,
}
,
Required: False ,
}
enum ,
backupStorageVersion:
{
Description: Backup storage version ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
Unassigned: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: property to enable or disable resource provider inbound network traffic from public clients ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
monitoringSettings:
{
Description: Monitoring Settings of the vault ,
Required: False ,
}
{
azureMonitorAlertSettings:
{
Description: Settings for Azure Monitor based alerts ,
Required: False ,
}
{
alertsForAllJobFailures:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
alertsForAllReplicationIssues:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
alertsForAllFailoverIssues:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
classicAlertSettings:
{
Description: Settings for classic alerts ,
Required: False ,
}
{
alertsForCriticalOperations:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
emailNotificationsForSiteRecovery:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
restoreSettings:
{
Description: Restore Settings of the vault ,
Required: False ,
}
{
crossSubscriptionRestoreSettings:
{
Description: Settings for CrossSubscriptionRestore ,
Required: False ,
}
{
crossSubscriptionRestoreState:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
PermanentlyDisabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
redundancySettings:
{
Description: The redundancy Settings of a Vault ,
Required: False ,
}
{
standardTierStorageRedundancy:
{
Description: The storage redundancy setting of a vault ,
Enum:
{
Invalid: No description available. ,
LocallyRedundant: No description available. ,
GeoRedundant: No description available. ,
ZoneRedundant: No description available. ,
}
,
Required: False ,
}
enum ,
crossRegionRestore:
{
Description: Flag to show if Cross Region Restore is enabled on the Vault or not ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
securitySettings:
{
Description: Security Settings of the vault ,
Required: False ,
}
{
immutabilitySettings:
{
Description: Immutability Settings of a vault ,
Required: False ,
}
{
state:
{
Enum:
{
Disabled: No description available. ,
Unlocked: No description available. ,
Locked: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
softDeleteSettings:
{
Description: Soft delete Settings of a vault ,
Required: False ,
}
{
softDeleteState:
{
Enum:
{
Invalid: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
AlwaysON: No description available. ,
}
,
Required: False ,
}
enum ,
softDeleteRetentionPeriodInDays:
{
Description: Soft delete retention period in days ,
Format: int32 ,
Required: False ,
}
integer ,
enhancedSecurityState:
{
Enum:
{
Invalid: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
AlwaysON: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
multiUserAuthorization:
{
Description: MUA Settings of a vault ,
Enum:
{
Invalid: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
secureScore:
{
Description: Secure Score of Recovery Services Vault ,
Enum:
{
None: No description available. ,
Minimum: No description available. ,
Adequate: No description available. ,
Maximum: No description available. ,
}
,
Required: False ,
}
enum ,
bcdrSecurityLevel:
{
Description: Security levels of Recovery Services Vault for business continuity and disaster recovery ,
Enum:
{
Poor: No description available. ,
Fair: No description available. ,
Good: No description available. ,
Excellent: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuardOperationRequests:
{
Description: ResourceGuardOperationRequests on which LAC check will be performed ,
Required: False ,
}
[
string ,
]
,
}
,
sku:
{
Description: Identifies the unique system identifier for each Azure resource. ,
Required: False ,
}
{
name:
{
Description: Name of SKU is RS0 (Recovery Services 0th version) and the tier is standard tier. They do not have affect on backend storage redundancy or any other vault settings. To manage storage redundancy, use the backupstorageconfig ,
Enum:
{
Standard: No description available. ,
RS0: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The Sku tier. ,
Required: False ,
}
string ,
family:
{
Description: The sku family ,
Required: False ,
}
string ,
size:
{
Description: The sku size ,
Required: False ,
}
string ,
capacity:
{
Description: The sku capacity ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
}
,
}
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 ID of the target subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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 type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identities. ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user-assigned identities associated with the resource. The user-assigned identity dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
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 ,
}
,
groupIds:
{
Description: Group Ids for the Private Endpoint ,
Required: False ,
}
[
string ,
]
,
}
,
name:
{
Description: The name of the private Endpoint Connection ,
Required: False ,
}
string ,
type:
{
Description: The type, which will be of the format, Microsoft.RecoveryServices/vaults/privateEndpointConnections ,
Required: False ,
}
string ,
location:
{
Description: The location of the private Endpoint connection ,
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 ,
encryption:
{
Description: Customer Managed Key details of the resource. ,
Required: False ,
}
{
keyVaultProperties:
{
Description: The properties of the Key Vault which hosts CMK ,
Required: False ,
}
{
keyUri:
{
Description: The key uri of the Customer Managed Key ,
Required: False ,
}
string ,
}
,
kekIdentity:
{
Description: The details of the identity used for CMK ,
Required: False ,
}
{
useSystemAssignedIdentity:
{
Description: Indicate that system assigned identity should be used. Mutually exclusive with 'userAssignedIdentity' field ,
Required: False ,
}
boolean ,
userAssignedIdentity:
{
Description: The user assigned identity to be used to grant permissions in case the type of identity used is UserAssigned ,
Required: False ,
}
string ,
}
,
infrastructureEncryption:
{
Description: Enabling/Disabling the Double Encryption state ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
moveDetails:
{
Description: The details of the latest move operation performed on the Azure Resource ,
Required: False ,
}
{
operationId:
{
Description: OperationId of the Resource Move Operation ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: Start Time of the Resource Move Operation ,
Format: date-time ,
Required: False ,
}
string ,
completionTimeUtc:
{
Description: End Time of the Resource Move Operation ,
Format: date-time ,
Required: False ,
}
string ,
sourceResourceId:
{
Description: Source Resource of the Resource Move Operation ,
Required: False ,
}
string ,
targetResourceId:
{
Description: Target Resource of the Resource Move Operation ,
Required: False ,
}
string ,
}
,
moveState:
{
Description: The State of the Resource after the move operation ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
PrepareFailed: No description available. ,
CommitFailed: No description available. ,
PrepareTimedout: No description available. ,
CommitTimedout: No description available. ,
MoveSucceeded: No description available. ,
Failure: No description available. ,
CriticalFailure: No description available. ,
PartialSuccess: No description available. ,
}
,
Required: False ,
}
enum ,
backupStorageVersion:
{
Description: Backup storage version ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
Unassigned: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: property to enable or disable resource provider inbound network traffic from public clients ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
monitoringSettings:
{
Description: Monitoring Settings of the vault ,
Required: False ,
}
{
azureMonitorAlertSettings:
{
Description: Settings for Azure Monitor based alerts ,
Required: False ,
}
{
alertsForAllJobFailures:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
alertsForAllReplicationIssues:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
alertsForAllFailoverIssues:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
classicAlertSettings:
{
Description: Settings for classic alerts ,
Required: False ,
}
{
alertsForCriticalOperations:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
emailNotificationsForSiteRecovery:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
restoreSettings:
{
Description: Restore Settings of the vault ,
Required: False ,
}
{
crossSubscriptionRestoreSettings:
{
Description: Settings for CrossSubscriptionRestore ,
Required: False ,
}
{
crossSubscriptionRestoreState:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
PermanentlyDisabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
redundancySettings:
{
Description: The redundancy Settings of a Vault ,
Required: False ,
}
{
standardTierStorageRedundancy:
{
Description: The storage redundancy setting of a vault ,
Enum:
{
Invalid: No description available. ,
LocallyRedundant: No description available. ,
GeoRedundant: No description available. ,
ZoneRedundant: No description available. ,
}
,
Required: False ,
}
enum ,
crossRegionRestore:
{
Description: Flag to show if Cross Region Restore is enabled on the Vault or not ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
securitySettings:
{
Description: Security Settings of the vault ,
Required: False ,
}
{
immutabilitySettings:
{
Description: Immutability Settings of a vault ,
Required: False ,
}
{
state:
{
Enum:
{
Disabled: No description available. ,
Unlocked: No description available. ,
Locked: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
softDeleteSettings:
{
Description: Soft delete Settings of a vault ,
Required: False ,
}
{
softDeleteState:
{
Enum:
{
Invalid: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
AlwaysON: No description available. ,
}
,
Required: False ,
}
enum ,
softDeleteRetentionPeriodInDays:
{
Description: Soft delete retention period in days ,
Format: int32 ,
Required: False ,
}
integer ,
enhancedSecurityState:
{
Enum:
{
Invalid: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
AlwaysON: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
multiUserAuthorization:
{
Description: MUA Settings of a vault ,
Enum:
{
Invalid: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
secureScore:
{
Description: Secure Score of Recovery Services Vault ,
Enum:
{
None: No description available. ,
Minimum: No description available. ,
Adequate: No description available. ,
Maximum: No description available. ,
}
,
Required: False ,
}
enum ,
bcdrSecurityLevel:
{
Description: Security levels of Recovery Services Vault for business continuity and disaster recovery ,
Enum:
{
Poor: No description available. ,
Fair: No description available. ,
Good: No description available. ,
Excellent: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuardOperationRequests:
{
Description: ResourceGuardOperationRequests on which LAC check will be performed ,
Required: False ,
}
[
string ,
]
,
}
,
sku:
{
Description: Identifies the unique system identifier for each Azure resource. ,
Required: False ,
}
{
name:
{
Description: Name of SKU is RS0 (Recovery Services 0th version) and the tier is standard tier. They do not have affect on backend storage redundancy or any other vault settings. To manage storage redundancy, use the backupstorageconfig ,
Enum:
{
Standard: No description available. ,
RS0: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The Sku tier. ,
Required: False ,
}
string ,
family:
{
Description: The sku family ,
Required: False ,
}
string ,
size:
{
Description: The sku size ,
Required: False ,
}
string ,
capacity:
{
Description: The sku capacity ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
x-ms-authorization-auxiliary:
{
Required: False ,
}
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 type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identities. ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user-assigned identities associated with the resource. The user-assigned identity dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
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 ,
}
,
groupIds:
{
Description: Group Ids for the Private Endpoint ,
Required: False ,
}
[
string ,
]
,
}
,
name:
{
Description: The name of the private Endpoint Connection ,
Required: False ,
}
string ,
type:
{
Description: The type, which will be of the format, Microsoft.RecoveryServices/vaults/privateEndpointConnections ,
Required: False ,
}
string ,
location:
{
Description: The location of the private Endpoint connection ,
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 ,
encryption:
{
Description: Customer Managed Key details of the resource. ,
Required: False ,
}
{
keyVaultProperties:
{
Description: The properties of the Key Vault which hosts CMK ,
Required: False ,
}
{
keyUri:
{
Description: The key uri of the Customer Managed Key ,
Required: False ,
}
string ,
}
,
kekIdentity:
{
Description: The details of the identity used for CMK ,
Required: False ,
}
{
useSystemAssignedIdentity:
{
Description: Indicate that system assigned identity should be used. Mutually exclusive with 'userAssignedIdentity' field ,
Required: False ,
}
boolean ,
userAssignedIdentity:
{
Description: The user assigned identity to be used to grant permissions in case the type of identity used is UserAssigned ,
Required: False ,
}
string ,
}
,
infrastructureEncryption:
{
Description: Enabling/Disabling the Double Encryption state ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
moveDetails:
{
Description: The details of the latest move operation performed on the Azure Resource ,
Required: False ,
}
{
operationId:
{
Description: OperationId of the Resource Move Operation ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: Start Time of the Resource Move Operation ,
Format: date-time ,
Required: False ,
}
string ,
completionTimeUtc:
{
Description: End Time of the Resource Move Operation ,
Format: date-time ,
Required: False ,
}
string ,
sourceResourceId:
{
Description: Source Resource of the Resource Move Operation ,
Required: False ,
}
string ,
targetResourceId:
{
Description: Target Resource of the Resource Move Operation ,
Required: False ,
}
string ,
}
,
moveState:
{
Description: The State of the Resource after the move operation ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
PrepareFailed: No description available. ,
CommitFailed: No description available. ,
PrepareTimedout: No description available. ,
CommitTimedout: No description available. ,
MoveSucceeded: No description available. ,
Failure: No description available. ,
CriticalFailure: No description available. ,
PartialSuccess: No description available. ,
}
,
Required: False ,
}
enum ,
backupStorageVersion:
{
Description: Backup storage version ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
Unassigned: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: property to enable or disable resource provider inbound network traffic from public clients ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
monitoringSettings:
{
Description: Monitoring Settings of the vault ,
Required: False ,
}
{
azureMonitorAlertSettings:
{
Description: Settings for Azure Monitor based alerts ,
Required: False ,
}
{
alertsForAllJobFailures:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
alertsForAllReplicationIssues:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
alertsForAllFailoverIssues:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
classicAlertSettings:
{
Description: Settings for classic alerts ,
Required: False ,
}
{
alertsForCriticalOperations:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
emailNotificationsForSiteRecovery:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
restoreSettings:
{
Description: Restore Settings of the vault ,
Required: False ,
}
{
crossSubscriptionRestoreSettings:
{
Description: Settings for CrossSubscriptionRestore ,
Required: False ,
}
{
crossSubscriptionRestoreState:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
PermanentlyDisabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
redundancySettings:
{
Description: The redundancy Settings of a Vault ,
Required: False ,
}
{
standardTierStorageRedundancy:
{
Description: The storage redundancy setting of a vault ,
Enum:
{
Invalid: No description available. ,
LocallyRedundant: No description available. ,
GeoRedundant: No description available. ,
ZoneRedundant: No description available. ,
}
,
Required: False ,
}
enum ,
crossRegionRestore:
{
Description: Flag to show if Cross Region Restore is enabled on the Vault or not ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
securitySettings:
{
Description: Security Settings of the vault ,
Required: False ,
}
{
immutabilitySettings:
{
Description: Immutability Settings of a vault ,
Required: False ,
}
{
state:
{
Enum:
{
Disabled: No description available. ,
Unlocked: No description available. ,
Locked: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
softDeleteSettings:
{
Description: Soft delete Settings of a vault ,
Required: False ,
}
{
softDeleteState:
{
Enum:
{
Invalid: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
AlwaysON: No description available. ,
}
,
Required: False ,
}
enum ,
softDeleteRetentionPeriodInDays:
{
Description: Soft delete retention period in days ,
Format: int32 ,
Required: False ,
}
integer ,
enhancedSecurityState:
{
Enum:
{
Invalid: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
AlwaysON: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
multiUserAuthorization:
{
Description: MUA Settings of a vault ,
Enum:
{
Invalid: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
secureScore:
{
Description: Secure Score of Recovery Services Vault ,
Enum:
{
None: No description available. ,
Minimum: No description available. ,
Adequate: No description available. ,
Maximum: No description available. ,
}
,
Required: False ,
}
enum ,
bcdrSecurityLevel:
{
Description: Security levels of Recovery Services Vault for business continuity and disaster recovery ,
Enum:
{
Poor: No description available. ,
Fair: No description available. ,
Good: No description available. ,
Excellent: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuardOperationRequests:
{
Description: ResourceGuardOperationRequests on which LAC check will be performed ,
Required: False ,
}
[
string ,
]
,
}
,
sku:
{
Description: Identifies the unique system identifier for each Azure resource. ,
Required: False ,
}
{
name:
{
Description: Name of SKU is RS0 (Recovery Services 0th version) and the tier is standard tier. They do not have affect on backend storage redundancy or any other vault settings. To manage storage redundancy, use the backupstorageconfig ,
Enum:
{
Standard: No description available. ,
RS0: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The Sku tier. ,
Required: False ,
}
string ,
family:
{
Description: The sku family ,
Required: False ,
}
string ,
size:
{
Description: The sku size ,
Required: False ,
}
string ,
capacity:
{
Description: The sku capacity ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ 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 type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identities. ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user-assigned identities associated with the resource. The user-assigned identity dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
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 ,
}
,
groupIds:
{
Description: Group Ids for the Private Endpoint ,
Required: False ,
}
[
string ,
]
,
}
,
name:
{
Description: The name of the private Endpoint Connection ,
Required: False ,
}
string ,
type:
{
Description: The type, which will be of the format, Microsoft.RecoveryServices/vaults/privateEndpointConnections ,
Required: False ,
}
string ,
location:
{
Description: The location of the private Endpoint connection ,
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 ,
encryption:
{
Description: Customer Managed Key details of the resource. ,
Required: False ,
}
{
keyVaultProperties:
{
Description: The properties of the Key Vault which hosts CMK ,
Required: False ,
}
{
keyUri:
{
Description: The key uri of the Customer Managed Key ,
Required: False ,
}
string ,
}
,
kekIdentity:
{
Description: The details of the identity used for CMK ,
Required: False ,
}
{
useSystemAssignedIdentity:
{
Description: Indicate that system assigned identity should be used. Mutually exclusive with 'userAssignedIdentity' field ,
Required: False ,
}
boolean ,
userAssignedIdentity:
{
Description: The user assigned identity to be used to grant permissions in case the type of identity used is UserAssigned ,
Required: False ,
}
string ,
}
,
infrastructureEncryption:
{
Description: Enabling/Disabling the Double Encryption state ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
moveDetails:
{
Description: The details of the latest move operation performed on the Azure Resource ,
Required: False ,
}
{
operationId:
{
Description: OperationId of the Resource Move Operation ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: Start Time of the Resource Move Operation ,
Format: date-time ,
Required: False ,
}
string ,
completionTimeUtc:
{
Description: End Time of the Resource Move Operation ,
Format: date-time ,
Required: False ,
}
string ,
sourceResourceId:
{
Description: Source Resource of the Resource Move Operation ,
Required: False ,
}
string ,
targetResourceId:
{
Description: Target Resource of the Resource Move Operation ,
Required: False ,
}
string ,
}
,
moveState:
{
Description: The State of the Resource after the move operation ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
PrepareFailed: No description available. ,
CommitFailed: No description available. ,
PrepareTimedout: No description available. ,
CommitTimedout: No description available. ,
MoveSucceeded: No description available. ,
Failure: No description available. ,
CriticalFailure: No description available. ,
PartialSuccess: No description available. ,
}
,
Required: False ,
}
enum ,
backupStorageVersion:
{
Description: Backup storage version ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
Unassigned: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: property to enable or disable resource provider inbound network traffic from public clients ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
monitoringSettings:
{
Description: Monitoring Settings of the vault ,
Required: False ,
}
{
azureMonitorAlertSettings:
{
Description: Settings for Azure Monitor based alerts ,
Required: False ,
}
{
alertsForAllJobFailures:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
alertsForAllReplicationIssues:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
alertsForAllFailoverIssues:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
classicAlertSettings:
{
Description: Settings for classic alerts ,
Required: False ,
}
{
alertsForCriticalOperations:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
emailNotificationsForSiteRecovery:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
restoreSettings:
{
Description: Restore Settings of the vault ,
Required: False ,
}
{
crossSubscriptionRestoreSettings:
{
Description: Settings for CrossSubscriptionRestore ,
Required: False ,
}
{
crossSubscriptionRestoreState:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
PermanentlyDisabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
redundancySettings:
{
Description: The redundancy Settings of a Vault ,
Required: False ,
}
{
standardTierStorageRedundancy:
{
Description: The storage redundancy setting of a vault ,
Enum:
{
Invalid: No description available. ,
LocallyRedundant: No description available. ,
GeoRedundant: No description available. ,
ZoneRedundant: No description available. ,
}
,
Required: False ,
}
enum ,
crossRegionRestore:
{
Description: Flag to show if Cross Region Restore is enabled on the Vault or not ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
securitySettings:
{
Description: Security Settings of the vault ,
Required: False ,
}
{
immutabilitySettings:
{
Description: Immutability Settings of a vault ,
Required: False ,
}
{
state:
{
Enum:
{
Disabled: No description available. ,
Unlocked: No description available. ,
Locked: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
softDeleteSettings:
{
Description: Soft delete Settings of a vault ,
Required: False ,
}
{
softDeleteState:
{
Enum:
{
Invalid: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
AlwaysON: No description available. ,
}
,
Required: False ,
}
enum ,
softDeleteRetentionPeriodInDays:
{
Description: Soft delete retention period in days ,
Format: int32 ,
Required: False ,
}
integer ,
enhancedSecurityState:
{
Enum:
{
Invalid: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
AlwaysON: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
multiUserAuthorization:
{
Description: MUA Settings of a vault ,
Enum:
{
Invalid: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
secureScore:
{
Description: Secure Score of Recovery Services Vault ,
Enum:
{
None: No description available. ,
Minimum: No description available. ,
Adequate: No description available. ,
Maximum: No description available. ,
}
,
Required: False ,
}
enum ,
bcdrSecurityLevel:
{
Description: Security levels of Recovery Services Vault for business continuity and disaster recovery ,
Enum:
{
Poor: No description available. ,
Fair: No description available. ,
Good: No description available. ,
Excellent: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuardOperationRequests:
{
Description: ResourceGuardOperationRequests on which LAC check will be performed ,
Required: False ,
}
[
string ,
]
,
}
,
sku:
{
Description: Identifies the unique system identifier for each Azure resource. ,
Required: False ,
}
{
name:
{
Description: Name of SKU is RS0 (Recovery Services 0th version) and the tier is standard tier. They do not have affect on backend storage redundancy or any other vault settings. To manage storage redundancy, use the backupstorageconfig ,
Enum:
{
Standard: No description available. ,
RS0: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The Sku tier. ,
Required: False ,
}
string ,
family:
{
Description: The sku family ,
Required: False ,
}
string ,
size:
{
Description: The sku size ,
Required: False ,
}
string ,
capacity:
{
Description: The sku capacity ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
}
,
}
Vaults_Delete (new)
Description :  Deletes a vault.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Vaults_Update (new)
Description :  Updates the vault.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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 ,
}
,
groupIds:
{
Description: Group Ids for the Private Endpoint ,
Required: False ,
}
[
string ,
]
,
}
,
name:
{
Description: The name of the private Endpoint Connection ,
Required: False ,
}
string ,
type:
{
Description: The type, which will be of the format, Microsoft.RecoveryServices/vaults/privateEndpointConnections ,
Required: False ,
}
string ,
location:
{
Description: The location of the private Endpoint connection ,
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 ,
encryption:
{
Description: Customer Managed Key details of the resource. ,
Required: False ,
}
{
keyVaultProperties:
{
Description: The properties of the Key Vault which hosts CMK ,
Required: False ,
}
{
keyUri:
{
Description: The key uri of the Customer Managed Key ,
Required: False ,
}
string ,
}
,
kekIdentity:
{
Description: The details of the identity used for CMK ,
Required: False ,
}
{
useSystemAssignedIdentity:
{
Description: Indicate that system assigned identity should be used. Mutually exclusive with 'userAssignedIdentity' field ,
Required: False ,
}
boolean ,
userAssignedIdentity:
{
Description: The user assigned identity to be used to grant permissions in case the type of identity used is UserAssigned ,
Required: False ,
}
string ,
}
,
infrastructureEncryption:
{
Description: Enabling/Disabling the Double Encryption state ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
moveDetails:
{
Description: The details of the latest move operation performed on the Azure Resource ,
Required: False ,
}
{
operationId:
{
Description: OperationId of the Resource Move Operation ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: Start Time of the Resource Move Operation ,
Format: date-time ,
Required: False ,
}
string ,
completionTimeUtc:
{
Description: End Time of the Resource Move Operation ,
Format: date-time ,
Required: False ,
}
string ,
sourceResourceId:
{
Description: Source Resource of the Resource Move Operation ,
Required: False ,
}
string ,
targetResourceId:
{
Description: Target Resource of the Resource Move Operation ,
Required: False ,
}
string ,
}
,
moveState:
{
Description: The State of the Resource after the move operation ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
PrepareFailed: No description available. ,
CommitFailed: No description available. ,
PrepareTimedout: No description available. ,
CommitTimedout: No description available. ,
MoveSucceeded: No description available. ,
Failure: No description available. ,
CriticalFailure: No description available. ,
PartialSuccess: No description available. ,
}
,
Required: False ,
}
enum ,
backupStorageVersion:
{
Description: Backup storage version ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
Unassigned: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: property to enable or disable resource provider inbound network traffic from public clients ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
monitoringSettings:
{
Description: Monitoring Settings of the vault ,
Required: False ,
}
{
azureMonitorAlertSettings:
{
Description: Settings for Azure Monitor based alerts ,
Required: False ,
}
{
alertsForAllJobFailures:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
alertsForAllReplicationIssues:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
alertsForAllFailoverIssues:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
classicAlertSettings:
{
Description: Settings for classic alerts ,
Required: False ,
}
{
alertsForCriticalOperations:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
emailNotificationsForSiteRecovery:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
restoreSettings:
{
Description: Restore Settings of the vault ,
Required: False ,
}
{
crossSubscriptionRestoreSettings:
{
Description: Settings for CrossSubscriptionRestore ,
Required: False ,
}
{
crossSubscriptionRestoreState:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
PermanentlyDisabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
redundancySettings:
{
Description: The redundancy Settings of a Vault ,
Required: False ,
}
{
standardTierStorageRedundancy:
{
Description: The storage redundancy setting of a vault ,
Enum:
{
Invalid: No description available. ,
LocallyRedundant: No description available. ,
GeoRedundant: No description available. ,
ZoneRedundant: No description available. ,
}
,
Required: False ,
}
enum ,
crossRegionRestore:
{
Description: Flag to show if Cross Region Restore is enabled on the Vault or not ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
securitySettings:
{
Description: Security Settings of the vault ,
Required: False ,
}
{
immutabilitySettings:
{
Description: Immutability Settings of a vault ,
Required: False ,
}
{
state:
{
Enum:
{
Disabled: No description available. ,
Unlocked: No description available. ,
Locked: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
softDeleteSettings:
{
Description: Soft delete Settings of a vault ,
Required: False ,
}
{
softDeleteState:
{
Enum:
{
Invalid: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
AlwaysON: No description available. ,
}
,
Required: False ,
}
enum ,
softDeleteRetentionPeriodInDays:
{
Description: Soft delete retention period in days ,
Format: int32 ,
Required: False ,
}
integer ,
enhancedSecurityState:
{
Enum:
{
Invalid: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
AlwaysON: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
multiUserAuthorization:
{
Description: MUA Settings of a vault ,
Enum:
{
Invalid: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
secureScore:
{
Description: Secure Score of Recovery Services Vault ,
Enum:
{
None: No description available. ,
Minimum: No description available. ,
Adequate: No description available. ,
Maximum: No description available. ,
}
,
Required: False ,
}
enum ,
bcdrSecurityLevel:
{
Description: Security levels of Recovery Services Vault for business continuity and disaster recovery ,
Enum:
{
Poor: No description available. ,
Fair: No description available. ,
Good: No description available. ,
Excellent: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuardOperationRequests:
{
Description: ResourceGuardOperationRequests on which LAC check will be performed ,
Required: False ,
}
[
string ,
]
,
}
,
sku:
{
Description: Identifies the unique system identifier for each Azure resource. ,
Required: False ,
}
{
name:
{
Description: Name of SKU is RS0 (Recovery Services 0th version) and the tier is standard tier. They do not have affect on backend storage redundancy or any other vault settings. To manage storage redundancy, use the backupstorageconfig ,
Enum:
{
Standard: No description available. ,
RS0: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The Sku tier. ,
Required: False ,
}
string ,
family:
{
Description: The sku family ,
Required: False ,
}
string ,
size:
{
Description: The sku size ,
Required: False ,
}
string ,
capacity:
{
Description: The sku capacity ,
Required: False ,
}
string ,
}
,
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 type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identities. ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user-assigned identities associated with the resource. The user-assigned identity dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}
,
x-ms-authorization-auxiliary:
{
Required: False ,
}
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 type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identities. ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user-assigned identities associated with the resource. The user-assigned identity dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
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 ,
}
,
groupIds:
{
Description: Group Ids for the Private Endpoint ,
Required: False ,
}
[
string ,
]
,
}
,
name:
{
Description: The name of the private Endpoint Connection ,
Required: False ,
}
string ,
type:
{
Description: The type, which will be of the format, Microsoft.RecoveryServices/vaults/privateEndpointConnections ,
Required: False ,
}
string ,
location:
{
Description: The location of the private Endpoint connection ,
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 ,
encryption:
{
Description: Customer Managed Key details of the resource. ,
Required: False ,
}
{
keyVaultProperties:
{
Description: The properties of the Key Vault which hosts CMK ,
Required: False ,
}
{
keyUri:
{
Description: The key uri of the Customer Managed Key ,
Required: False ,
}
string ,
}
,
kekIdentity:
{
Description: The details of the identity used for CMK ,
Required: False ,
}
{
useSystemAssignedIdentity:
{
Description: Indicate that system assigned identity should be used. Mutually exclusive with 'userAssignedIdentity' field ,
Required: False ,
}
boolean ,
userAssignedIdentity:
{
Description: The user assigned identity to be used to grant permissions in case the type of identity used is UserAssigned ,
Required: False ,
}
string ,
}
,
infrastructureEncryption:
{
Description: Enabling/Disabling the Double Encryption state ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
moveDetails:
{
Description: The details of the latest move operation performed on the Azure Resource ,
Required: False ,
}
{
operationId:
{
Description: OperationId of the Resource Move Operation ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: Start Time of the Resource Move Operation ,
Format: date-time ,
Required: False ,
}
string ,
completionTimeUtc:
{
Description: End Time of the Resource Move Operation ,
Format: date-time ,
Required: False ,
}
string ,
sourceResourceId:
{
Description: Source Resource of the Resource Move Operation ,
Required: False ,
}
string ,
targetResourceId:
{
Description: Target Resource of the Resource Move Operation ,
Required: False ,
}
string ,
}
,
moveState:
{
Description: The State of the Resource after the move operation ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
PrepareFailed: No description available. ,
CommitFailed: No description available. ,
PrepareTimedout: No description available. ,
CommitTimedout: No description available. ,
MoveSucceeded: No description available. ,
Failure: No description available. ,
CriticalFailure: No description available. ,
PartialSuccess: No description available. ,
}
,
Required: False ,
}
enum ,
backupStorageVersion:
{
Description: Backup storage version ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
Unassigned: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: property to enable or disable resource provider inbound network traffic from public clients ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
monitoringSettings:
{
Description: Monitoring Settings of the vault ,
Required: False ,
}
{
azureMonitorAlertSettings:
{
Description: Settings for Azure Monitor based alerts ,
Required: False ,
}
{
alertsForAllJobFailures:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
alertsForAllReplicationIssues:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
alertsForAllFailoverIssues:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
classicAlertSettings:
{
Description: Settings for classic alerts ,
Required: False ,
}
{
alertsForCriticalOperations:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
emailNotificationsForSiteRecovery:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
restoreSettings:
{
Description: Restore Settings of the vault ,
Required: False ,
}
{
crossSubscriptionRestoreSettings:
{
Description: Settings for CrossSubscriptionRestore ,
Required: False ,
}
{
crossSubscriptionRestoreState:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
PermanentlyDisabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
redundancySettings:
{
Description: The redundancy Settings of a Vault ,
Required: False ,
}
{
standardTierStorageRedundancy:
{
Description: The storage redundancy setting of a vault ,
Enum:
{
Invalid: No description available. ,
LocallyRedundant: No description available. ,
GeoRedundant: No description available. ,
ZoneRedundant: No description available. ,
}
,
Required: False ,
}
enum ,
crossRegionRestore:
{
Description: Flag to show if Cross Region Restore is enabled on the Vault or not ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
securitySettings:
{
Description: Security Settings of the vault ,
Required: False ,
}
{
immutabilitySettings:
{
Description: Immutability Settings of a vault ,
Required: False ,
}
{
state:
{
Enum:
{
Disabled: No description available. ,
Unlocked: No description available. ,
Locked: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
softDeleteSettings:
{
Description: Soft delete Settings of a vault ,
Required: False ,
}
{
softDeleteState:
{
Enum:
{
Invalid: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
AlwaysON: No description available. ,
}
,
Required: False ,
}
enum ,
softDeleteRetentionPeriodInDays:
{
Description: Soft delete retention period in days ,
Format: int32 ,
Required: False ,
}
integer ,
enhancedSecurityState:
{
Enum:
{
Invalid: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
AlwaysON: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
multiUserAuthorization:
{
Description: MUA Settings of a vault ,
Enum:
{
Invalid: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
secureScore:
{
Description: Secure Score of Recovery Services Vault ,
Enum:
{
None: No description available. ,
Minimum: No description available. ,
Adequate: No description available. ,
Maximum: No description available. ,
}
,
Required: False ,
}
enum ,
bcdrSecurityLevel:
{
Description: Security levels of Recovery Services Vault for business continuity and disaster recovery ,
Enum:
{
Poor: No description available. ,
Fair: No description available. ,
Good: No description available. ,
Excellent: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuardOperationRequests:
{
Description: ResourceGuardOperationRequests on which LAC check will be performed ,
Required: False ,
}
[
string ,
]
,
}
,
sku:
{
Description: Identifies the unique system identifier for each Azure resource. ,
Required: False ,
}
{
name:
{
Description: Name of SKU is RS0 (Recovery Services 0th version) and the tier is standard tier. They do not have affect on backend storage redundancy or any other vault settings. To manage storage redundancy, use the backupstorageconfig ,
Enum:
{
Standard: No description available. ,
RS0: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The Sku tier. ,
Required: False ,
}
string ,
family:
{
Description: The sku family ,
Required: False ,
}
string ,
size:
{
Description: The sku size ,
Required: False ,
}
string ,
capacity:
{
Description: The sku capacity ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
}
,
}
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 ID of the target subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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 ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
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 ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
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 ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
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 ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
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 ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
}
,
}
GetOperationStatus (new)
Description :  Gets the operation status for a resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/operationStatus/{operationId}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
operationId:
{
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
endTime:
{
Description: End time of the operation ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Required if status == failed or status == canceled. This is the OData v4 error format, used by the RPC and will go into the v2.2 Azure REST API guidelines. ,
Required: False ,
}
{
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
}
,
id:
{
Description: It should match what is used to GET the operation result ,
Required: False ,
}
string ,
name:
{
Description: It must match the last segment of the "id" field, and will typically be a GUID / system generated value ,
Required: False ,
}
string ,
status:
{
Description: The status of the operation. (InProgress/Success/Failed/Cancelled) ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the operation ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
}
,
}
GetOperationResult (new)
Description :  Gets the operation result for a resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/operationResults/{operationId}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
operationId:
{
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
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 type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identities. ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user-assigned identities associated with the resource. The user-assigned identity dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
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 ,
}
,
groupIds:
{
Description: Group Ids for the Private Endpoint ,
Required: False ,
}
[
string ,
]
,
}
,
name:
{
Description: The name of the private Endpoint Connection ,
Required: False ,
}
string ,
type:
{
Description: The type, which will be of the format, Microsoft.RecoveryServices/vaults/privateEndpointConnections ,
Required: False ,
}
string ,
location:
{
Description: The location of the private Endpoint connection ,
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 ,
encryption:
{
Description: Customer Managed Key details of the resource. ,
Required: False ,
}
{
keyVaultProperties:
{
Description: The properties of the Key Vault which hosts CMK ,
Required: False ,
}
{
keyUri:
{
Description: The key uri of the Customer Managed Key ,
Required: False ,
}
string ,
}
,
kekIdentity:
{
Description: The details of the identity used for CMK ,
Required: False ,
}
{
useSystemAssignedIdentity:
{
Description: Indicate that system assigned identity should be used. Mutually exclusive with 'userAssignedIdentity' field ,
Required: False ,
}
boolean ,
userAssignedIdentity:
{
Description: The user assigned identity to be used to grant permissions in case the type of identity used is UserAssigned ,
Required: False ,
}
string ,
}
,
infrastructureEncryption:
{
Description: Enabling/Disabling the Double Encryption state ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
moveDetails:
{
Description: The details of the latest move operation performed on the Azure Resource ,
Required: False ,
}
{
operationId:
{
Description: OperationId of the Resource Move Operation ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: Start Time of the Resource Move Operation ,
Format: date-time ,
Required: False ,
}
string ,
completionTimeUtc:
{
Description: End Time of the Resource Move Operation ,
Format: date-time ,
Required: False ,
}
string ,
sourceResourceId:
{
Description: Source Resource of the Resource Move Operation ,
Required: False ,
}
string ,
targetResourceId:
{
Description: Target Resource of the Resource Move Operation ,
Required: False ,
}
string ,
}
,
moveState:
{
Description: The State of the Resource after the move operation ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
PrepareFailed: No description available. ,
CommitFailed: No description available. ,
PrepareTimedout: No description available. ,
CommitTimedout: No description available. ,
MoveSucceeded: No description available. ,
Failure: No description available. ,
CriticalFailure: No description available. ,
PartialSuccess: No description available. ,
}
,
Required: False ,
}
enum ,
backupStorageVersion:
{
Description: Backup storage version ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
Unassigned: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: property to enable or disable resource provider inbound network traffic from public clients ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
monitoringSettings:
{
Description: Monitoring Settings of the vault ,
Required: False ,
}
{
azureMonitorAlertSettings:
{
Description: Settings for Azure Monitor based alerts ,
Required: False ,
}
{
alertsForAllJobFailures:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
alertsForAllReplicationIssues:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
alertsForAllFailoverIssues:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
classicAlertSettings:
{
Description: Settings for classic alerts ,
Required: False ,
}
{
alertsForCriticalOperations:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
emailNotificationsForSiteRecovery:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
restoreSettings:
{
Description: Restore Settings of the vault ,
Required: False ,
}
{
crossSubscriptionRestoreSettings:
{
Description: Settings for CrossSubscriptionRestore ,
Required: False ,
}
{
crossSubscriptionRestoreState:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
PermanentlyDisabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
redundancySettings:
{
Description: The redundancy Settings of a Vault ,
Required: False ,
}
{
standardTierStorageRedundancy:
{
Description: The storage redundancy setting of a vault ,
Enum:
{
Invalid: No description available. ,
LocallyRedundant: No description available. ,
GeoRedundant: No description available. ,
ZoneRedundant: No description available. ,
}
,
Required: False ,
}
enum ,
crossRegionRestore:
{
Description: Flag to show if Cross Region Restore is enabled on the Vault or not ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
securitySettings:
{
Description: Security Settings of the vault ,
Required: False ,
}
{
immutabilitySettings:
{
Description: Immutability Settings of a vault ,
Required: False ,
}
{
state:
{
Enum:
{
Disabled: No description available. ,
Unlocked: No description available. ,
Locked: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
softDeleteSettings:
{
Description: Soft delete Settings of a vault ,
Required: False ,
}
{
softDeleteState:
{
Enum:
{
Invalid: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
AlwaysON: No description available. ,
}
,
Required: False ,
}
enum ,
softDeleteRetentionPeriodInDays:
{
Description: Soft delete retention period in days ,
Format: int32 ,
Required: False ,
}
integer ,
enhancedSecurityState:
{
Enum:
{
Invalid: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
AlwaysON: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
multiUserAuthorization:
{
Description: MUA Settings of a vault ,
Enum:
{
Invalid: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
secureScore:
{
Description: Secure Score of Recovery Services Vault ,
Enum:
{
None: No description available. ,
Minimum: No description available. ,
Adequate: No description available. ,
Maximum: No description available. ,
}
,
Required: False ,
}
enum ,
bcdrSecurityLevel:
{
Description: Security levels of Recovery Services Vault for business continuity and disaster recovery ,
Enum:
{
Poor: No description available. ,
Fair: No description available. ,
Good: No description available. ,
Excellent: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuardOperationRequests:
{
Description: ResourceGuardOperationRequests on which LAC check will be performed ,
Required: False ,
}
[
string ,
]
,
}
,
sku:
{
Description: Identifies the unique system identifier for each Azure resource. ,
Required: False ,
}
{
name:
{
Description: Name of SKU is RS0 (Recovery Services 0th version) and the tier is standard tier. They do not have affect on backend storage redundancy or any other vault settings. To manage storage redundancy, use the backupstorageconfig ,
Enum:
{
Standard: No description available. ,
RS0: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The Sku tier. ,
Required: False ,
}
string ,
family:
{
Description: The sku family ,
Required: False ,
}
string ,
size:
{
Description: The sku size ,
Required: False ,
}
string ,
capacity:
{
Description: The sku capacity ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The resource management error response. ,
Required: False ,
}
{
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
}
,
]
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
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 ID of the target subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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 ,
}
,
}
,
]
,
}