Vaults - Create Or Update

Reference

Service:: Recovery Services

API Version:: 2024-10-01

Creates or updates a Recovery Services vault.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}?api-version=2024-10-01

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string	The ID of the target subscription.
vaultName	path	True	string	The name of the recovery services vault.
api-version	query	True	string	The API version to use for this operation.

Request Header

Name	Required	Type	Description
x-ms-authorization-auxiliary		string

Request Body

Name	Required	Type	Description
location	True	string	Resource location.
etag		string	Optional ETag.
identity		IdentityData	Identity for the resource.
properties		VaultProperties	Properties of the vault.
sku		Sku	Identifies the unique system identifier for each Azure resource.
tags		object	Resource tags.

Responses

Name	Type	Description
200 OK	Vault	OK
201 Created	Vault	Created
Other Status Codes	CloudError	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account.

Examples

Create or Update Recovery Services vault

Create or Update Vault performing critical operation With MUA

Create or Update Vault with CustomerManagedKeys

Create or Update Vault With Monitoring Setting

Create or Update Vault With Redundancy Setting

Create or Update Vault with User Assigned Identity

Create or Update Recovery Services vault

Sample request

HTTP

PUT https://management.azure.com/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/Default-RecoveryServices-ResourceGroup/providers/Microsoft.RecoveryServices/vaults/swaggerExample?api-version=2024-10-01

{
  "properties": {
    "publicNetworkAccess": "Enabled"
  },
  "sku": {
    "name": "Standard"
  },
  "location": "West US",
  "identity": {
    "type": "SystemAssigned"
  }
}

Sample response

Status code:: 200

{
  "location": "westus",
  "name": "swaggerExample",
  "etag": "W/\"datetime'2017-12-15T12%3A36%3A51.68Z'\"",
  "tags": {
    "TestUpdatedKey": "TestUpdatedValue"
  },
  "identity": {
    "tenantId": "d676e86e-2206-4a7c-999c-ece52c144b5b",
    "principalId": "3137d6c7-5d6c-411c-b934-7a2a729ee247",
    "type": "SystemAssigned"
  },
  "properties": {
    "publicNetworkAccess": "Enabled",
    "provisioningState": "Succeeded"
  },
  "id": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/Default-RecoveryServices-ResourceGroup/providers/Microsoft.RecoveryServices/vaults/swaggerExample",
  "type": "Microsoft.RecoveryServices/vaults",
  "sku": {
    "name": "RS0",
    "tier": "Standard"
  }
}

Status code:: 201

{
  "location": "westus",
  "name": "swaggerExample",
  "etag": "W/\"datetime'2017-12-15T12%3A36%3A51.68Z'\"",
  "tags": {
    "TestUpdatedKey": "TestUpdatedValue"
  },
  "identity": {
    "tenantId": "d676e86e-2206-4a7c-999c-ece52c144b5b",
    "principalId": "3137d6c7-5d6c-411c-b934-7a2a729ee247",
    "type": "SystemAssigned"
  },
  "properties": {
    "publicNetworkAccess": "Enabled",
    "provisioningState": "Succeeded"
  },
  "id": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/Default-RecoveryServices-ResourceGroup/providers/Microsoft.RecoveryServices/vaults/swaggerExample",
  "type": "Microsoft.RecoveryServices/vaults",
  "sku": {
    "name": "RS0",
    "tier": "Standard"
  }
}

Create or Update Vault performing critical operation With MUA

Sample request

HTTP

PUT https://management.azure.com/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/Default-RecoveryServices-ResourceGroup/providers/Microsoft.RecoveryServices/vaults/swaggerExample?api-version=2024-10-01

{
  "properties": {
    "publicNetworkAccess": "Enabled",
    "encryption": {
      "keyVaultProperties": {
        "keyUri": "https://cmk2xkv.vault.azure.net/keys/Key1/0767b348bb1a4c07baa6c4ec0055d2b3"
      },
      "kekIdentity": {
        "userAssignedIdentity": "/subscriptions/85bf5e8c-3084-4f42-add2-746ebb7e97b2/resourcegroups/defaultrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/examplemsi"
      },
      "infrastructureEncryption": "Enabled"
    },
    "resourceGuardOperationRequests": [
      "/subscriptions/38304e13-357e-405e-9e9a-220351dcce8c/resourcegroups/ankurResourceGuard1/providers/Microsoft.DataProtection/resourceGuards/ResourceGuard38-1/modifyEncryptionSettings/default"
    ]
  },
  "sku": {
    "name": "Standard"
  },
  "location": "West US",
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/85bf5e8c-3084-4f42-add2-746ebb7e97b2/resourcegroups/defaultrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/examplemsi": {}
    }
  }
}

Sample response

Status code:: 200

{
  "location": "westus",
  "name": "swaggerExample",
  "etag": "W/\"datetime'2017-12-15T12%3A36%3A51.68Z'\"",
  "tags": {
    "TestUpdatedKey": "TestUpdatedValue"
  },
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/85bf5e8c-3084-4f42-add2-746ebb7e97b2/resourcegroups/defaultrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/examplemsi": {
        "clientId": "fbe75b66-01c5-4f87-a220-233af3270436",
        "principalId": "075a0ca6-43f6-4434-9abf-c9b1b79f9219"
      }
    }
  },
  "properties": {
    "publicNetworkAccess": "Enabled",
    "provisioningState": "Succeeded",
    "encryption": {
      "keyVaultProperties": {
        "keyUri": "https://cmk2xkv.vault.azure.net/keys/Key1/0767b348bb1a4c07baa6c4ec0055d2b3"
      },
      "kekIdentity": {
        "userAssignedIdentity": "/subscriptions/85bf5e8c-3084-4f42-add2-746ebb7e97b2/resourcegroups/defaultrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/examplemsi",
        "useSystemAssignedIdentity": false
      },
      "infrastructureEncryption": "Enabled"
    }
  },
  "id": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/Default-RecoveryServices-ResourceGroup/providers/Microsoft.RecoveryServices/vaults/swaggerExample",
  "type": "Microsoft.RecoveryServices/vaults",
  "sku": {
    "name": "Standard"
  }
}

Status code:: 201

Retry-After: 10
Azure-AsyncOperation: /subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/Default-RecoveryServices-ResourceGroup/providers/Microsoft.RecoveryServices/vaults/swaggerExample/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2015-03-15

{
  "location": "westus",
  "name": "swaggerExample",
  "etag": "W/\"datetime'2017-12-15T12%3A36%3A51.68Z'\"",
  "tags": {
    "TestUpdatedKey": "TestUpdatedValue"
  },
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/85bf5e8c-3084-4f42-add2-746ebb7e97b2/resourcegroups/defaultrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/examplemsi": {}
    }
  },
  "properties": {
    "publicNetworkAccess": "Enabled",
    "provisioningState": "Provisioning",
    "encryption": {
      "keyVaultProperties": {
        "keyUri": "https://cmk2xkv.vault.azure.net/keys/Key1/0767b348bb1a4c07baa6c4ec0055d2b3"
      },
      "kekIdentity": {
        "userAssignedIdentity": "/subscriptions/85bf5e8c-3084-4f42-add2-746ebb7e97b2/resourcegroups/defaultrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/examplemsi",
        "useSystemAssignedIdentity": false
      },
      "infrastructureEncryption": "Enabled"
    }
  },
  "id": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/Default-RecoveryServices-ResourceGroup/providers/Microsoft.RecoveryServices/vaults/swaggerExample",
  "type": "Microsoft.RecoveryServices/vaults",
  "sku": {
    "name": "Standard"
  }
}

Create or Update Vault with CustomerManagedKeys

Sample request

HTTP

PUT https://management.azure.com/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/Default-RecoveryServices-ResourceGroup/providers/Microsoft.RecoveryServices/vaults/swaggerExample?api-version=2024-10-01

{
  "properties": {
    "publicNetworkAccess": "Enabled",
    "encryption": {
      "keyVaultProperties": {
        "keyUri": "https://cmk2xkv.vault.azure.net/keys/Key1/0767b348bb1a4c07baa6c4ec0055d2b3"
      },
      "kekIdentity": {
        "userAssignedIdentity": "/subscriptions/85bf5e8c-3084-4f42-add2-746ebb7e97b2/resourcegroups/defaultrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/examplemsi"
      },
      "infrastructureEncryption": "Enabled"
    }
  },
  "sku": {
    "name": "Standard"
  },
  "location": "West US",
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/85bf5e8c-3084-4f42-add2-746ebb7e97b2/resourcegroups/defaultrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/examplemsi": {}
    }
  }
}

Sample response

Status code:: 200

{
  "location": "westus",
  "name": "swaggerExample",
  "etag": "W/\"datetime'2017-12-15T12%3A36%3A51.68Z'\"",
  "tags": {
    "TestUpdatedKey": "TestUpdatedValue"
  },
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/85bf5e8c-3084-4f42-add2-746ebb7e97b2/resourcegroups/defaultrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/examplemsi": {
        "clientId": "fbe75b66-01c5-4f87-a220-233af3270436",
        "principalId": "075a0ca6-43f6-4434-9abf-c9b1b79f9219"
      }
    }
  },
  "properties": {
    "publicNetworkAccess": "Enabled",
    "provisioningState": "Succeeded",
    "encryption": {
      "keyVaultProperties": {
        "keyUri": "https://cmk2xkv.vault.azure.net/keys/Key1/0767b348bb1a4c07baa6c4ec0055d2b3"
      },
      "kekIdentity": {
        "userAssignedIdentity": "/subscriptions/85bf5e8c-3084-4f42-add2-746ebb7e97b2/resourcegroups/defaultrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/examplemsi",
        "useSystemAssignedIdentity": false
      },
      "infrastructureEncryption": "Enabled"
    }
  },
  "id": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/Default-RecoveryServices-ResourceGroup/providers/Microsoft.RecoveryServices/vaults/swaggerExample",
  "type": "Microsoft.RecoveryServices/vaults",
  "sku": {
    "name": "Standard"
  }
}

Status code:: 201

Retry-After: 10
Azure-AsyncOperation: /subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/Default-RecoveryServices-ResourceGroup/providers/Microsoft.RecoveryServices/vaults/swaggerExample/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2015-03-15

{
  "location": "westus",
  "name": "swaggerExample",
  "etag": "W/\"datetime'2017-12-15T12%3A36%3A51.68Z'\"",
  "tags": {
    "TestUpdatedKey": "TestUpdatedValue"
  },
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/85bf5e8c-3084-4f42-add2-746ebb7e97b2/resourcegroups/defaultrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/examplemsi": {}
    }
  },
  "properties": {
    "publicNetworkAccess": "Enabled",
    "provisioningState": "Provisioning",
    "encryption": {
      "keyVaultProperties": {
        "keyUri": "https://cmk2xkv.vault.azure.net/keys/Key1/0767b348bb1a4c07baa6c4ec0055d2b3"
      },
      "kekIdentity": {
        "userAssignedIdentity": "/subscriptions/85bf5e8c-3084-4f42-add2-746ebb7e97b2/resourcegroups/defaultrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/examplemsi",
        "useSystemAssignedIdentity": false
      },
      "infrastructureEncryption": "Enabled"
    }
  },
  "id": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/Default-RecoveryServices-ResourceGroup/providers/Microsoft.RecoveryServices/vaults/swaggerExample",
  "type": "Microsoft.RecoveryServices/vaults",
  "sku": {
    "name": "Standard"
  }
}

Create or Update Vault With Monitoring Setting

Sample request

HTTP

PUT https://management.azure.com/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/Default-RecoveryServices-ResourceGroup/providers/Microsoft.RecoveryServices/vaults/swaggerExample?api-version=2024-10-01

{
  "properties": {
    "publicNetworkAccess": "Enabled",
    "monitoringSettings": {
      "azureMonitorAlertSettings": {
        "alertsForAllJobFailures": "Enabled",
        "alertsForAllReplicationIssues": "Enabled",
        "alertsForAllFailoverIssues": "Disabled"
      },
      "classicAlertSettings": {
        "alertsForCriticalOperations": "Disabled",
        "emailNotificationsForSiteRecovery": "Enabled"
      }
    }
  },
  "sku": {
    "name": "Standard"
  },
  "location": "West US",
  "identity": {
    "type": "SystemAssigned"
  }
}

Sample response

Status code:: 200

{
  "location": "westus",
  "name": "swaggerExample",
  "etag": "W/\"datetime'2017-12-15T12%3A36%3A51.68Z'\"",
  "tags": {
    "TestUpdatedKey": "TestUpdatedValue"
  },
  "identity": {
    "tenantId": "d676e86e-2206-4a7c-999c-ece52c144b5b",
    "principalId": "3137d6c7-5d6c-411c-b934-7a2a729ee247",
    "type": "SystemAssigned"
  },
  "properties": {
    "publicNetworkAccess": "Enabled",
    "provisioningState": "Succeeded",
    "monitoringSettings": {
      "azureMonitorAlertSettings": {
        "alertsForAllJobFailures": "Enabled",
        "alertsForAllReplicationIssues": "Enabled",
        "alertsForAllFailoverIssues": "Disabled"
      },
      "classicAlertSettings": {
        "alertsForCriticalOperations": "Disabled",
        "emailNotificationsForSiteRecovery": "Enabled"
      }
    }
  },
  "id": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/Default-RecoveryServices-ResourceGroup/providers/Microsoft.RecoveryServices/vaults/swaggerExample",
  "type": "Microsoft.RecoveryServices/vaults",
  "sku": {
    "name": "RS0",
    "tier": "Standard"
  }
}

Status code:: 201

{
  "location": "westus",
  "name": "swaggerExample",
  "etag": "W/\"datetime'2017-12-15T12%3A36%3A51.68Z'\"",
  "tags": {
    "TestUpdatedKey": "TestUpdatedValue"
  },
  "identity": {
    "tenantId": "d676e86e-2206-4a7c-999c-ece52c144b5b",
    "principalId": "3137d6c7-5d6c-411c-b934-7a2a729ee247",
    "type": "SystemAssigned"
  },
  "properties": {
    "publicNetworkAccess": "Enabled",
    "provisioningState": "Succeeded",
    "monitoringSettings": {
      "azureMonitorAlertSettings": {
        "alertsForAllJobFailures": "Enabled",
        "alertsForAllReplicationIssues": "Enabled",
        "alertsForAllFailoverIssues": "Disabled"
      },
      "classicAlertSettings": {
        "alertsForCriticalOperations": "Disabled",
        "emailNotificationsForSiteRecovery": "Enabled"
      }
    }
  },
  "id": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/Default-RecoveryServices-ResourceGroup/providers/Microsoft.RecoveryServices/vaults/swaggerExample",
  "type": "Microsoft.RecoveryServices/vaults",
  "sku": {
    "name": "RS0",
    "tier": "Standard"
  }
}

Create or Update Vault With Redundancy Setting

Sample request

HTTP

PUT https://management.azure.com/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/Default-RecoveryServices-ResourceGroup/providers/Microsoft.RecoveryServices/vaults/swaggerExample?api-version=2024-10-01

{
  "properties": {
    "publicNetworkAccess": "Enabled",
    "redundancySettings": {
      "standardTierStorageRedundancy": "GeoRedundant",
      "crossRegionRestore": "Enabled"
    }
  },
  "sku": {
    "name": "Standard"
  },
  "location": "West US",
  "identity": {
    "type": "SystemAssigned"
  }
}

Sample response

Status code:: 200

{
  "location": "westus",
  "name": "swaggerExample",
  "etag": "W/\"datetime'2017-12-15T12%3A36%3A51.68Z'\"",
  "tags": {
    "TestUpdatedKey": "TestUpdatedValue"
  },
  "identity": {
    "tenantId": "d676e86e-2206-4a7c-999c-ece52c144b5b",
    "principalId": "3137d6c7-5d6c-411c-b934-7a2a729ee247",
    "type": "SystemAssigned"
  },
  "properties": {
    "publicNetworkAccess": "Enabled",
    "provisioningState": "Succeeded",
    "redundancySettings": {
      "standardTierStorageRedundancy": "GeoRedundant",
      "crossRegionRestore": "Enabled"
    }
  },
  "id": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/Default-RecoveryServices-ResourceGroup/providers/Microsoft.RecoveryServices/vaults/swaggerExample",
  "type": "Microsoft.RecoveryServices/vaults",
  "sku": {
    "name": "RS0",
    "tier": "Standard"
  }
}

Status code:: 201

{
  "location": "westus",
  "name": "swaggerExample",
  "etag": "W/\"datetime'2017-12-15T12%3A36%3A51.68Z'\"",
  "tags": {
    "TestUpdatedKey": "TestUpdatedValue"
  },
  "identity": {
    "tenantId": "d676e86e-2206-4a7c-999c-ece52c144b5b",
    "principalId": "3137d6c7-5d6c-411c-b934-7a2a729ee247",
    "type": "SystemAssigned"
  },
  "properties": {
    "publicNetworkAccess": "Enabled",
    "provisioningState": "Succeeded",
    "redundancySettings": {
      "standardTierStorageRedundancy": "GeoRedundant",
      "crossRegionRestore": "Enabled"
    }
  },
  "id": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/Default-RecoveryServices-ResourceGroup/providers/Microsoft.RecoveryServices/vaults/swaggerExample",
  "type": "Microsoft.RecoveryServices/vaults",
  "sku": {
    "name": "RS0",
    "tier": "Standard"
  }
}

Create or Update Vault with User Assigned Identity

Sample request

HTTP

PUT https://management.azure.com/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/Default-RecoveryServices-ResourceGroup/providers/Microsoft.RecoveryServices/vaults/swaggerExample?api-version=2024-10-01

{
  "properties": {
    "publicNetworkAccess": "Enabled"
  },
  "sku": {
    "name": "Standard"
  },
  "location": "West US",
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/85bf5e8c-3084-4f42-add2-746ebb7e97b2/resourcegroups/defaultrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/examplemsi": {}
    }
  }
}

Sample response

Status code:: 200

{
  "location": "westus",
  "name": "swaggerExample",
  "etag": "W/\"datetime'2017-12-15T12%3A36%3A51.68Z'\"",
  "tags": {
    "TestUpdatedKey": "TestUpdatedValue"
  },
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/85bf5e8c-3084-4f42-add2-746ebb7e97b2/resourcegroups/defaultrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/examplemsi": {
        "clientId": "fbe75b66-01c5-4f87-a220-233af3270436",
        "principalId": "075a0ca6-43f6-4434-9abf-c9b1b79f9219"
      }
    }
  },
  "properties": {
    "publicNetworkAccess": "Enabled",
    "provisioningState": "Succeeded"
  },
  "id": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/Default-RecoveryServices-ResourceGroup/providers/Microsoft.RecoveryServices/vaults/swaggerExample",
  "type": "Microsoft.RecoveryServices/vaults",
  "sku": {
    "name": "Standard"
  }
}

Status code:: 201

Retry-After: 10
Azure-AsyncOperation: /subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/Default-RecoveryServices-ResourceGroup/providers/Microsoft.RecoveryServices/vaults/swaggerExample/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2015-03-15

{
  "location": "westus",
  "name": "swaggerExample",
  "etag": "W/\"datetime'2017-12-15T12%3A36%3A51.68Z'\"",
  "tags": {
    "TestUpdatedKey": "TestUpdatedValue"
  },
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/85bf5e8c-3084-4f42-add2-746ebb7e97b2/resourcegroups/defaultrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/examplemsi": {}
    }
  },
  "properties": {
    "publicNetworkAccess": "Enabled",
    "provisioningState": "Provisioning"
  },
  "id": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/Default-RecoveryServices-ResourceGroup/providers/Microsoft.RecoveryServices/vaults/swaggerExample",
  "type": "Microsoft.RecoveryServices/vaults",
  "sku": {
    "name": "Standard"
  }
}

Definitions

Name	Description
AlertsState
AzureMonitorAlertSettings	Settings for Azure Monitor based alerts
BackupStorageVersion	Backup storage version
BCDRSecurityLevel	Security levels of Recovery Services Vault for business continuity and disaster recovery
ClassicAlertSettings	Settings for classic alerts
CloudError	CloudError
CmkKekIdentity	The details of the identity used for CMK
CmkKeyVaultProperties	The properties of the Key Vault which hosts CMK
createdByType	The type of identity that created the resource.
crossRegionRestore	Flag to show if Cross Region Restore is enabled on the Vault or not
CrossSubscriptionRestoreSettings	Settings for Cross Subscription Restore Settings
crossSubscriptionRestoreState
Encryption	Customer Managed Key details of the resource.
EnhancedSecurityState
Error	The resource management error response.
ErrorAdditionalInfo	The resource management error additional info.
IdentityData	Identity for the resource.
ImmutabilitySettings	Immutability Settings of vault
ImmutabilityState
InfrastructureEncryptionState	Enabling/Disabling the Double Encryption state
MonitoringSettings	Monitoring Settings of the vault
MoveDetails	The details of the latest move operation performed on the Azure Resource
MultiUserAuthorization	MUA Settings of vault
PrivateEndpoint	The Private Endpoint network resource that is linked to the Private Endpoint connection.
PrivateEndpointConnection	Private Endpoint Connection Response Properties.
PrivateEndpointConnectionStatus	Gets or sets the status.
PrivateEndpointConnectionVaultProperties	Information to be stored in Vault properties as an element of privateEndpointConnections List.
PrivateLinkServiceConnectionState	Gets or sets private link service connection state.
ProvisioningState	Gets or sets provisioning state of the private endpoint connection.
PublicNetworkAccess	property to enable or disable resource provider inbound network traffic from public clients
RedundancySettings	The redundancy Settings of a Vault
ResourceIdentityType	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.
ResourceMoveState	The State of the Resource after the move operation
RestoreSettings	Restore Settings of the vault
SecureScoreLevel	Secure Score of Recovery Services Vault
SecuritySettings	Security Settings of the vault
Sku	Identifies the unique system identifier for each Azure resource.
SkuName	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
SoftDeleteSettings	Soft delete Settings of vault
SoftDeleteState
standardTierStorageRedundancy	The storage redundancy setting of a vault
systemData	Metadata pertaining to creation and last modification of the resource.
TriggerType	The way the vault upgrade was triggered.
UpgradeDetails	Details for upgrading vault.
UserIdentity	A resource identity that is managed by the user of the service.
Vault	Resource information, as returned by the resource provider.
VaultPrivateEndpointState	Private endpoint state for backup.
VaultProperties	Properties of the vault.
VaultSubResourceType	Subresource type for vault AzureBackup, AzureBackup_secondary or AzureSiteRecovery
VaultUpgradeState	Status of the vault upgrade operation.

AlertsState

Name	Type	Description
Disabled	string
Enabled	string

AzureMonitorAlertSettings

Settings for Azure Monitor based alerts

Name	Type	Description
alertsForAllFailoverIssues	AlertsState
alertsForAllJobFailures	AlertsState
alertsForAllReplicationIssues	AlertsState

BackupStorageVersion

Backup storage version

Name	Type	Description
Unassigned	string
V1	string
V2	string

BCDRSecurityLevel

Security levels of Recovery Services Vault for business continuity and disaster recovery

Name	Type	Description
Excellent	string
Fair	string
Good	string
Poor	string

ClassicAlertSettings

Settings for classic alerts

Name	Type	Description
alertsForCriticalOperations	AlertsState
emailNotificationsForSiteRecovery	AlertsState

CloudError

Name	Type	Description
error	Error	The resource management error response.

CmkKekIdentity

The details of the identity used for CMK

Name	Type	Description
useSystemAssignedIdentity	boolean	Indicate that system assigned identity should be used. Mutually exclusive with 'userAssignedIdentity' field
userAssignedIdentity	string	The user assigned identity to be used to grant permissions in case the type of identity used is UserAssigned

CmkKeyVaultProperties

The properties of the Key Vault which hosts CMK

Name	Type	Description
keyUri	string	The key uri of the Customer Managed Key

createdByType

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

crossRegionRestore

Flag to show if Cross Region Restore is enabled on the Vault or not

Name	Type	Description
Disabled	string
Enabled	string

CrossSubscriptionRestoreSettings

Settings for Cross Subscription Restore Settings

Name	Type	Description
crossSubscriptionRestoreState	crossSubscriptionRestoreState

crossSubscriptionRestoreState

Name	Type	Description
Disabled	string
Enabled	string
PermanentlyDisabled	string

Encryption

Customer Managed Key details of the resource.

Name	Type	Description
infrastructureEncryption	InfrastructureEncryptionState	Enabling/Disabling the Double Encryption state
kekIdentity	CmkKekIdentity	The details of the identity used for CMK
keyVaultProperties	CmkKeyVaultProperties	The properties of the Key Vault which hosts CMK

EnhancedSecurityState

Name	Type	Description
AlwaysON	string
Disabled	string
Enabled	string
Invalid	string

Error

The resource management error response.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	Error[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

IdentityData

Identity for the resource.

Name	Type	Description
principalId	string	The principal ID of resource identity.
tenantId	string	The tenant ID of resource.
type	ResourceIdentityType	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.
userAssignedIdentities	<string, UserIdentity>	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}'.

ImmutabilitySettings

Immutability Settings of vault

Name	Type	Description
state	ImmutabilityState

ImmutabilityState

Name	Type	Description
Disabled	string
Locked	string
Unlocked	string

InfrastructureEncryptionState

Enabling/Disabling the Double Encryption state

Name	Type	Description
Disabled	string
Enabled	string

MonitoringSettings

Monitoring Settings of the vault

Name	Type	Description
azureMonitorAlertSettings	AzureMonitorAlertSettings	Settings for Azure Monitor based alerts
classicAlertSettings	ClassicAlertSettings	Settings for classic alerts

MoveDetails

The details of the latest move operation performed on the Azure Resource

Name	Type	Description
completionTimeUtc	string	End Time of the Resource Move Operation
operationId	string	OperationId of the Resource Move Operation
sourceResourceId	string	Source Resource of the Resource Move Operation
startTimeUtc	string	Start Time of the Resource Move Operation
targetResourceId	string	Target Resource of the Resource Move Operation

MultiUserAuthorization

MUA Settings of vault

Name	Type	Description
Disabled	string
Enabled	string
Invalid	string

PrivateEndpoint

The Private Endpoint network resource that is linked to the Private Endpoint connection.

Name	Type	Description
id	string	Gets or sets id.

PrivateEndpointConnection

Private Endpoint Connection Response Properties.

Name	Type	Description
groupIds	VaultSubResourceType[]	Group Ids for the Private Endpoint
privateEndpoint	PrivateEndpoint	The Private Endpoint network resource that is linked to the Private Endpoint connection.
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Gets or sets private link service connection state.
provisioningState	ProvisioningState	Gets or sets provisioning state of the private endpoint connection.

PrivateEndpointConnectionStatus

Gets or sets the status.

Name	Type	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

PrivateEndpointConnectionVaultProperties

Information to be stored in Vault properties as an element of privateEndpointConnections List.

Name	Type	Description
id	string	Format of id subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.[Service]/{resource}/{resourceName}/privateEndpointConnections/{connectionName}.
location	string	The location of the private Endpoint connection
name	string	The name of the private Endpoint Connection
properties	PrivateEndpointConnection	Private Endpoint Connection Response Properties.
type	string	The type, which will be of the format, Microsoft.RecoveryServices/vaults/privateEndpointConnections

PrivateLinkServiceConnectionState

Gets or sets private link service connection state.

Name	Type	Description
actionsRequired	string	Gets or sets actions required.
description	string	Gets or sets description.
status	PrivateEndpointConnectionStatus	Gets or sets the status.

ProvisioningState

Gets or sets provisioning state of the private endpoint connection.

Name	Type	Description
Deleting	string
Failed	string
Pending	string
Succeeded	string

PublicNetworkAccess

property to enable or disable resource provider inbound network traffic from public clients

Name	Type	Description
Disabled	string
Enabled	string

RedundancySettings

The redundancy Settings of a Vault

Name	Type	Description
crossRegionRestore	crossRegionRestore	Flag to show if Cross Region Restore is enabled on the Vault or not
standardTierStorageRedundancy	standardTierStorageRedundancy	The storage redundancy setting of a vault

ResourceIdentityType

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.

Name	Type	Description
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

ResourceMoveState

The State of the Resource after the move operation

Name	Type	Description
CommitFailed	string
CommitTimedout	string
CriticalFailure	string
Failure	string
InProgress	string
MoveSucceeded	string
PartialSuccess	string
PrepareFailed	string
PrepareTimedout	string
Unknown	string

RestoreSettings

Restore Settings of the vault

Name	Type	Description
crossSubscriptionRestoreSettings	CrossSubscriptionRestoreSettings	Settings for CrossSubscriptionRestore

SecureScoreLevel

Secure Score of Recovery Services Vault

Name	Type	Description
Adequate	string
Maximum	string
Minimum	string
None	string

SecuritySettings

Security Settings of the vault

Name	Type	Description
immutabilitySettings	ImmutabilitySettings	Immutability Settings of a vault
multiUserAuthorization	MultiUserAuthorization	MUA Settings of a vault
softDeleteSettings	SoftDeleteSettings	Soft delete Settings of a vault

Sku

Identifies the unique system identifier for each Azure resource.

Name	Type	Description
capacity	string	The sku capacity
family	string	The sku family
name	SkuName	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
size	string	The sku size
tier	string	The Sku tier.

SkuName

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

Name	Type	Description
RS0	string
Standard	string

SoftDeleteSettings

Soft delete Settings of vault

Name	Type	Description
enhancedSecurityState	EnhancedSecurityState
softDeleteRetentionPeriodInDays	integer	Soft delete retention period in days
softDeleteState	SoftDeleteState

SoftDeleteState

Name	Type	Description
AlwaysON	string
Disabled	string
Enabled	string
Invalid	string

standardTierStorageRedundancy

The storage redundancy setting of a vault

Name	Type	Description
GeoRedundant	string
Invalid	string
LocallyRedundant	string
ZoneRedundant	string

systemData

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string	The type of identity that last modified the resource.
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

TriggerType

The way the vault upgrade was triggered.

Name	Type	Description
ForcedUpgrade	string
UserTriggered	string

UpgradeDetails

Details for upgrading vault.

Name	Type	Description
endTimeUtc	string	UTC time at which the upgrade operation has ended.
lastUpdatedTimeUtc	string	UTC time at which the upgrade operation status was last updated.
message	string	Message to the user containing information about the upgrade operation.
operationId	string	ID of the vault upgrade operation.
previousResourceId	string	Resource ID of the vault before the upgrade.
startTimeUtc	string	UTC time at which the upgrade operation has started.
status	VaultUpgradeState	Status of the vault upgrade operation.
triggerType	TriggerType	The way the vault upgrade was triggered.
upgradedResourceId	string	Resource ID of the upgraded vault.

UserIdentity

A resource identity that is managed by the user of the service.

Name	Type	Description
clientId	string	The client ID of the user-assigned identity.
principalId	string	The principal ID of the user-assigned identity.

Vault

Resource information, as returned by the resource provider.

Name	Type	Description
etag	string	Optional ETag.
id	string	Resource Id represents the complete path to the resource.
identity	IdentityData	Identity for the resource.
location	string	Resource location.
name	string	Resource name associated with the resource.
properties	VaultProperties	Properties of the vault.
sku	Sku	Identifies the unique system identifier for each Azure resource.
systemData	systemData	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags.
type	string	Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...

VaultPrivateEndpointState

Private endpoint state for backup.

Name	Type	Description
Enabled	string
None	string

VaultProperties

Properties of the vault.

Name	Type	Description
backupStorageVersion	BackupStorageVersion	Backup storage version
bcdrSecurityLevel	BCDRSecurityLevel	Security levels of Recovery Services Vault for business continuity and disaster recovery
encryption	Encryption	Customer Managed Key details of the resource.
monitoringSettings	MonitoringSettings	Monitoring Settings of the vault
moveDetails	MoveDetails	The details of the latest move operation performed on the Azure Resource
moveState	ResourceMoveState	The State of the Resource after the move operation
privateEndpointConnections	PrivateEndpointConnectionVaultProperties[]	List of private endpoint connection.
privateEndpointStateForBackup	VaultPrivateEndpointState	Private endpoint state for backup.
privateEndpointStateForSiteRecovery	VaultPrivateEndpointState	Private endpoint state for site recovery.
provisioningState	string	Provisioning State.
publicNetworkAccess	PublicNetworkAccess	property to enable or disable resource provider inbound network traffic from public clients
redundancySettings	RedundancySettings	The redundancy Settings of a Vault
resourceGuardOperationRequests	string[]	ResourceGuardOperationRequests on which LAC check will be performed
restoreSettings	RestoreSettings	Restore Settings of the vault
secureScore	SecureScoreLevel	Secure Score of Recovery Services Vault
securitySettings	SecuritySettings	Security Settings of the vault
upgradeDetails	UpgradeDetails	Details for upgrading vault.

VaultSubResourceType

Subresource type for vault AzureBackup, AzureBackup_secondary or AzureSiteRecovery

Name	Type	Description
AzureBackup	string
AzureBackup_secondary	string
AzureSiteRecovery	string

VaultUpgradeState

Status of the vault upgrade operation.

Name	Type	Description
Failed	string
InProgress	string
Unknown	string
Upgraded	string

Share via

Vaults - Create Or Update

URI Parameters

Request Header

Request Body

Responses

Security

azure_auth

Scopes

Examples

Create or Update Recovery Services vault

Sample request

Sample response

Create or Update Vault performing critical operation With MUA

Sample request

Sample response

Create or Update Vault with CustomerManagedKeys

Sample request

Sample response

Create or Update Vault With Monitoring Setting

Sample request

Sample response

Create or Update Vault With Redundancy Setting

Sample request

Sample response

Create or Update Vault with User Assigned Identity

Sample request

Sample response

Definitions

AlertsState

AzureMonitorAlertSettings

BackupStorageVersion

BCDRSecurityLevel

ClassicAlertSettings

CloudError

CmkKekIdentity

CmkKeyVaultProperties

createdByType

crossRegionRestore

CrossSubscriptionRestoreSettings

crossSubscriptionRestoreState

Encryption

EnhancedSecurityState

Error

ErrorAdditionalInfo

IdentityData

ImmutabilitySettings

ImmutabilityState

InfrastructureEncryptionState

MonitoringSettings

MoveDetails

MultiUserAuthorization

PrivateEndpoint

PrivateEndpointConnection

PrivateEndpointConnectionStatus

PrivateEndpointConnectionVaultProperties

PrivateLinkServiceConnectionState

ProvisioningState

PublicNetworkAccess

RedundancySettings

ResourceIdentityType

ResourceMoveState

RestoreSettings

SecureScoreLevel

SecuritySettings

Sku

SkuName

SoftDeleteSettings

SoftDeleteState

standardTierStorageRedundancy

systemData

TriggerType

UpgradeDetails

UserIdentity

Vault

VaultPrivateEndpointState

VaultProperties

VaultSubResourceType

VaultUpgradeState

Additional resources