Vaults - Get

Service:: Recovery Services

API Version:: 2025-02-01

Get the Vault details.

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

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string minLength: 1	The ID of the target subscription.
vaultName	path	True	string	The name of the Vault
api-version	query	True	string minLength: 1	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	Vault	Azure operation completed successfully.
Other Status Codes	CloudError	An unexpected error response.

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

Get Recovery Services Resource

Sample request

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


/**
 * Samples for Vaults GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2025-02-01/examples/GETVault.
     * json
     */
    /**
     * Sample code: Get Recovery Services Resource.
     * 
     * @param manager Entry point to RecoveryServicesManager.
     */
    public static void
        getRecoveryServicesResource(com.azure.resourcemanager.recoveryservices.RecoveryServicesManager manager) {
        manager.vaults().getByResourceGroupWithResponse("Default-RecoveryServices-ResourceGroup", "swaggerExample",
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.recoveryservices import RecoveryServicesClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-recoveryservices
# USAGE
    python get_vault.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = RecoveryServicesClient(
        credential=DefaultAzureCredential(),
        subscription_id="77777777-b0c6-47a2-b37c-d8e65a629c18",
    )

    response = client.vaults.get(
        resource_group_name="Default-RecoveryServices-ResourceGroup",
        vault_name="swaggerExample",
    )
    print(response)


# x-ms-original-file: specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2025-02-01/examples/GETVault.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armrecoveryservices_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/recoveryservices/armrecoveryservices/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/82e9c6f9fbfa2d6d47d5e2a6a11c0ad2eb345c43/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2025-02-01/examples/GETVault.json
func ExampleVaultsClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armrecoveryservices.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewVaultsClient().Get(ctx, "Default-RecoveryServices-ResourceGroup", "swaggerExample", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Vault = armrecoveryservices.Vault{
	// 	Name: to.Ptr("swaggerExample"),
	// 	Type: to.Ptr("Microsoft.RecoveryServices/vaults"),
	// 	Etag: to.Ptr("W/\"datetime'2017-12-15T12%3A36%3A51.68Z'\""),
	// 	ID: to.Ptr("/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/Default-RecoveryServices-ResourceGroup/providers/Microsoft.RecoveryServices/vaults/swaggerExample"),
	// 	Location: to.Ptr("westus"),
	// 	Tags: map[string]*string{
	// 		"TestUpdatedKey": to.Ptr("TestUpdatedValue"),
	// 	},
	// 	Identity: &armrecoveryservices.IdentityData{
	// 		Type: to.Ptr(armrecoveryservices.ResourceIdentityTypeSystemAssigned),
	// 		PrincipalID: to.Ptr("3137d6c7-5d6c-411c-b934-7a2a729ee247"),
	// 		TenantID: to.Ptr("d676e86e-2206-4a7c-999c-ece52c144b5b"),
	// 	},
	// 	Properties: &armrecoveryservices.VaultProperties{
	// 		BcdrSecurityLevel: to.Ptr(armrecoveryservices.BCDRSecurityLevelPoor),
	// 		MonitoringSettings: &armrecoveryservices.MonitoringSettings{
	// 			AzureMonitorAlertSettings: &armrecoveryservices.AzureMonitorAlertSettings{
	// 				AlertsForAllFailoverIssues: to.Ptr(armrecoveryservices.AlertsStateDisabled),
	// 				AlertsForAllJobFailures: to.Ptr(armrecoveryservices.AlertsStateEnabled),
	// 				AlertsForAllReplicationIssues: to.Ptr(armrecoveryservices.AlertsStateEnabled),
	// 			},
	// 			ClassicAlertSettings: &armrecoveryservices.ClassicAlertSettings{
	// 				AlertsForCriticalOperations: to.Ptr(armrecoveryservices.AlertsStateDisabled),
	// 				EmailNotificationsForSiteRecovery: to.Ptr(armrecoveryservices.AlertsStateEnabled),
	// 			},
	// 		},
	// 		PrivateEndpointConnections: []*armrecoveryservices.PrivateEndpointConnectionVaultProperties{
	// 			{
	// 				ID: to.Ptr("/subscriptions/6c48fa17-39c7-45f1-90ac-47a587128ace/resourceGroups/Default-RecoveryServices-ResourceGroup/providers/Microsoft.RecoveryServices/Vaults/pemsi-ecy-rsv2/privateEndpointConnections/pe114-pemsi-ecy-rsv.5944358949303501042.backup.75061caa-cba4-4849-8e09-608da4914aad"),
	// 				Properties: &armrecoveryservices.PrivateEndpointConnection{
	// 					GroupIDs: []*armrecoveryservices.VaultSubResourceType{
	// 						to.Ptr(armrecoveryservices.VaultSubResourceTypeAzureBackup)},
	// 						PrivateEndpoint: &armrecoveryservices.PrivateEndpoint{
	// 							ID: to.Ptr("/subscriptions/6c48fa17-39c7-45f1-90ac-47a587128ace/resourceGroups/Default-RecoveryServices-ResourceGroup/providers/Microsoft.Network/privateEndpoints/pe114-pemsi-ecy-rsv"),
	// 						},
	// 						PrivateLinkServiceConnectionState: &armrecoveryservices.PrivateLinkServiceConnectionState{
	// 							Description: to.Ptr("None"),
	// 							ActionsRequired: to.Ptr("None"),
	// 							Status: to.Ptr(armrecoveryservices.PrivateEndpointConnectionStatusApproved),
	// 						},
	// 						ProvisioningState: to.Ptr(armrecoveryservices.ProvisioningStateSucceeded),
	// 					},
	// 			}},
	// 			PrivateEndpointStateForBackup: to.Ptr(armrecoveryservices.VaultPrivateEndpointStateEnabled),
	// 			PrivateEndpointStateForSiteRecovery: to.Ptr(armrecoveryservices.VaultPrivateEndpointStateNone),
	// 			ProvisioningState: to.Ptr("Succeeded"),
	// 			PublicNetworkAccess: to.Ptr(armrecoveryservices.PublicNetworkAccessEnabled),
	// 			RedundancySettings: &armrecoveryservices.VaultPropertiesRedundancySettings{
	// 				CrossRegionRestore: to.Ptr(armrecoveryservices.CrossRegionRestoreEnabled),
	// 				StandardTierStorageRedundancy: to.Ptr(armrecoveryservices.StandardTierStorageRedundancyGeoRedundant),
	// 			},
	// 			SecureScore: to.Ptr(armrecoveryservices.SecureScoreLevelNone),
	// 			SecuritySettings: &armrecoveryservices.SecuritySettings{
	// 				ImmutabilitySettings: &armrecoveryservices.ImmutabilitySettings{
	// 					State: to.Ptr(armrecoveryservices.ImmutabilityStateDisabled),
	// 				},
	// 				MultiUserAuthorization: to.Ptr(armrecoveryservices.MultiUserAuthorizationDisabled),
	// 				SoftDeleteSettings: &armrecoveryservices.SoftDeleteSettings{
	// 					EnhancedSecurityState: to.Ptr(armrecoveryservices.EnhancedSecurityStateEnabled),
	// 					SoftDeleteRetentionPeriodInDays: to.Ptr[int32](14),
	// 					SoftDeleteState: to.Ptr(armrecoveryservices.SoftDeleteStateEnabled),
	// 				},
	// 				SourceScanConfiguration: &armrecoveryservices.SourceScanConfiguration{
	// 					SourceScanIdentity: &armrecoveryservices.AssociatedIdentity{
	// 						OperationIdentityType: to.Ptr(armrecoveryservices.IdentityTypeSystemAssigned),
	// 					},
	// 					State: to.Ptr(armrecoveryservices.StateEnabled),
	// 				},
	// 			},
	// 		},
	// 		SKU: &armrecoveryservices.SKU{
	// 			Name: to.Ptr(armrecoveryservices.SKUNameStandard),
	// 		},
	// 	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { RecoveryServicesClient } = require("@azure/arm-recoveryservices");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Get the Vault details.
 *
 * @summary Get the Vault details.
 * x-ms-original-file: specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2025-02-01/examples/GETVault.json
 */
async function getRecoveryServicesResource() {
  const subscriptionId =
    process.env["RECOVERYSERVICES_SUBSCRIPTION_ID"] || "77777777-b0c6-47a2-b37c-d8e65a629c18";
  const resourceGroupName =
    process.env["RECOVERYSERVICES_RESOURCE_GROUP"] || "Default-RecoveryServices-ResourceGroup";
  const vaultName = "swaggerExample";
  const credential = new DefaultAzureCredential();
  const client = new RecoveryServicesClient(credential, subscriptionId);
  const result = await client.vaults.get(resourceGroupName, vaultName);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:: 200

{
  "name": "swaggerExample",
  "type": "Microsoft.RecoveryServices/vaults",
  "etag": "W/\"datetime'2017-12-15T12%3A36%3A51.68Z'\"",
  "id": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/Default-RecoveryServices-ResourceGroup/providers/Microsoft.RecoveryServices/vaults/swaggerExample",
  "identity": {
    "type": "SystemAssigned",
    "principalId": "3137d6c7-5d6c-411c-b934-7a2a729ee247",
    "tenantId": "d676e86e-2206-4a7c-999c-ece52c144b5b"
  },
  "location": "westus",
  "properties": {
    "bcdrSecurityLevel": "Poor",
    "monitoringSettings": {
      "azureMonitorAlertSettings": {
        "alertsForAllFailoverIssues": "Disabled",
        "alertsForAllJobFailures": "Enabled",
        "alertsForAllReplicationIssues": "Enabled"
      },
      "classicAlertSettings": {
        "alertsForCriticalOperations": "Disabled",
        "emailNotificationsForSiteRecovery": "Enabled"
      }
    },
    "privateEndpointConnections": [
      {
        "id": "/subscriptions/6c48fa17-39c7-45f1-90ac-47a587128ace/resourceGroups/Default-RecoveryServices-ResourceGroup/providers/Microsoft.RecoveryServices/Vaults/pemsi-ecy-rsv2/privateEndpointConnections/pe114-pemsi-ecy-rsv.5944358949303501042.backup.75061caa-cba4-4849-8e09-608da4914aad",
        "properties": {
          "groupIds": [
            "AzureBackup"
          ],
          "privateEndpoint": {
            "id": "/subscriptions/6c48fa17-39c7-45f1-90ac-47a587128ace/resourceGroups/Default-RecoveryServices-ResourceGroup/providers/Microsoft.Network/privateEndpoints/pe114-pemsi-ecy-rsv"
          },
          "privateLinkServiceConnectionState": {
            "description": "None",
            "actionsRequired": "None",
            "status": "Approved"
          },
          "provisioningState": "Succeeded"
        }
      }
    ],
    "privateEndpointStateForBackup": "Enabled",
    "privateEndpointStateForSiteRecovery": "None",
    "provisioningState": "Succeeded",
    "publicNetworkAccess": "Enabled",
    "redundancySettings": {
      "crossRegionRestore": "Enabled",
      "standardTierStorageRedundancy": "GeoRedundant"
    },
    "secureScore": "None",
    "securitySettings": {
      "immutabilitySettings": {
        "state": "Disabled"
      },
      "multiUserAuthorization": "Disabled",
      "softDeleteSettings": {
        "enhancedSecurityState": "Enabled",
        "softDeleteRetentionPeriodInDays": 14,
        "softDeleteState": "Enabled"
      },
      "sourceScanConfiguration": {
        "sourceScanIdentity": {
          "operationIdentityType": "SystemAssigned"
        },
        "state": "Enabled"
      }
    }
  },
  "sku": {
    "name": "Standard"
  },
  "tags": {
    "TestUpdatedKey": "TestUpdatedValue"
  }
}

Definitions

Name	Description
AlertsState
AssociatedIdentity	Identity details to be used for an operation
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	An error response from Azure Backup.
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
EnhancedSecurityState
Error	The resource management error response.
ErrorAdditionalInfo	The resource management error additional info.
IdentityData	Identity for the resource.
IdentityType	Identity type that should be used for an operation.
ImmutabilitySettings	Immutability Settings of vault
ImmutabilityState
InfrastructureEncryptionState	Enabling/Disabling the Double Encryption state
MonitoringSettings	Monitoring Settings of the vault
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
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
SourceScanConfiguration	Source scan configuration of vault
StandardTierStorageRedundancy	The storage redundancy setting of a vault
State
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.
VaultPropertiesEncryption	Customer Managed Key details of the resource.
VaultPropertiesMoveDetails	The details of the latest move operation performed on the Azure Resource
VaultPropertiesRedundancySettings	The redundancy Settings of a Vault
VaultSubResourceType	Subresource type for vault AzureBackup, AzureBackup_secondary or AzureSiteRecovery
VaultUpgradeState	Status of the vault upgrade operation.

AlertsState

Enumeration

Value	Description
Enabled
Disabled

AssociatedIdentity

Object

Identity details to be used for an operation

Name	Type	Description
operationIdentityType	IdentityType	Identity type that should be used for an operation.
userAssignedIdentity	string	User assigned identity to be used for an operation if operationIdentityType is UserAssigned.

AzureMonitorAlertSettings

Object

Settings for Azure Monitor based alerts

Name	Type	Description
alertsForAllFailoverIssues	AlertsState
alertsForAllJobFailures	AlertsState
alertsForAllReplicationIssues	AlertsState

BackupStorageVersion

Enumeration

Backup storage version

Value	Description
V1
V2
Unassigned

BCDRSecurityLevel

Enumeration

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

Value	Description
Poor
Fair
Good
Excellent

ClassicAlertSettings

Object

Settings for classic alerts

Name	Type	Description
alertsForCriticalOperations	AlertsState
emailNotificationsForSiteRecovery	AlertsState

CloudError

Object

An error response from Azure Backup.

Name	Type	Description
error	Error	The resource management error response.

CmkKekIdentity

Object

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

Object

The properties of the Key Vault which hosts CMK

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

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

CrossRegionRestore

Enumeration

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

Value	Description
Enabled
Disabled

CrossSubscriptionRestoreSettings

Object

Settings for Cross Subscription Restore Settings

Name	Type	Description
crossSubscriptionRestoreState	CrossSubscriptionRestoreState

CrossSubscriptionRestoreState

Enumeration

Value	Description
Enabled
Disabled
PermanentlyDisabled

EnhancedSecurityState

Enumeration

Value	Description
Invalid
Enabled
Disabled
AlwaysON

Error

Object

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

Object

The resource management error additional info.

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

IdentityData

Object

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}'.

IdentityType

Enumeration

Identity type that should be used for an operation.

Value	Description
SystemAssigned
UserAssigned

ImmutabilitySettings

Object

Immutability Settings of vault

Name	Type	Description
state	ImmutabilityState

ImmutabilityState

Enumeration

Value	Description
Disabled
Unlocked
Locked

InfrastructureEncryptionState

Enumeration

Enabling/Disabling the Double Encryption state

Value	Description
Enabled
Disabled

MonitoringSettings

Object

Monitoring Settings of the vault

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

MultiUserAuthorization

Enumeration

MUA Settings of vault

Value	Description
Invalid
Enabled
Disabled

PrivateEndpoint

Object

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

Name	Type	Description
id	string	Gets or sets id.

PrivateEndpointConnection

Object

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

Enumeration

Gets or sets the status.

Value	Description
Pending
Approved
Rejected
Disconnected

PrivateEndpointConnectionVaultProperties

Object

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

Object

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

Enumeration

Gets or sets provisioning state of the private endpoint connection.

Value	Description
Succeeded
Deleting
Failed
Pending

PublicNetworkAccess

Enumeration

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

Value	Description
Enabled
Disabled

ResourceIdentityType

Enumeration

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.

Value	Description
SystemAssigned
None
UserAssigned
SystemAssigned, UserAssigned

ResourceMoveState

Enumeration

The State of the Resource after the move operation

Value	Description
Unknown
InProgress
PrepareFailed
CommitFailed
PrepareTimedout
CommitTimedout
MoveSucceeded
Failure
CriticalFailure
PartialSuccess

RestoreSettings

Object

Restore Settings of the vault

Name	Type	Description
crossSubscriptionRestoreSettings	CrossSubscriptionRestoreSettings	Settings for CrossSubscriptionRestore

SecureScoreLevel

Enumeration

Secure Score of Recovery Services Vault

Value	Description
None
Minimum
Adequate
Maximum

SecuritySettings

Object

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
sourceScanConfiguration	SourceScanConfiguration	Source scan configuration of vault

Sku

Object

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

Enumeration

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

Value	Description
Standard
RS0

SoftDeleteSettings

Object

Soft delete Settings of vault

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

SoftDeleteState

Enumeration

Value	Description
Invalid
Enabled
Disabled
AlwaysON

SourceScanConfiguration

Object

Source scan configuration of vault

Name	Type	Description
sourceScanIdentity	AssociatedIdentity	Identity details to be used for an operation
state	State

StandardTierStorageRedundancy

Enumeration

The storage redundancy setting of a vault

Value	Description
Invalid
LocallyRedundant
GeoRedundant
ZoneRedundant

State

Enumeration

Value	Description
Invalid
Enabled
Disabled

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	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 (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

TriggerType

Enumeration

The way the vault upgrade was triggered.

Value	Description
UserTriggered
ForcedUpgrade

UpgradeDetails

Object

Details for upgrading vault.

Name	Type	Description
endTimeUtc	string (date-time)	UTC time at which the upgrade operation has ended.
lastUpdatedTimeUtc	string (date-time)	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 (date-time)	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

Object

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

Object

Resource information, as returned by the resource provider.

Name	Type	Description
etag	string	etag for the resource.
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	IdentityData	Identity for the resource.
location	string	The geo-location where the resource lives
name	string	The name of the resource
properties	VaultProperties	Properties of the vault.
sku	Sku	Identifies the unique system identifier for each Azure resource.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

VaultPrivateEndpointState

Enumeration

Private endpoint state for backup.

Value	Description
None
Enabled

VaultProperties

Object

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	VaultPropertiesEncryption	Customer Managed Key details of the resource.
monitoringSettings	MonitoringSettings	Monitoring Settings of the vault
moveDetails	VaultPropertiesMoveDetails	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	VaultPropertiesRedundancySettings	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.

VaultPropertiesEncryption

Object

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

VaultPropertiesMoveDetails

Object

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

Name	Type	Description
completionTimeUtc	string (date-time)	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 (date-time)	Start Time of the Resource Move Operation
targetResourceId	string	Target Resource of the Resource Move Operation

VaultPropertiesRedundancySettings

Object

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

VaultSubResourceType

Enumeration

Subresource type for vault AzureBackup, AzureBackup_secondary or AzureSiteRecovery

Value	Description
AzureBackup
AzureBackup_secondary
AzureSiteRecovery

VaultUpgradeState

Enumeration

Status of the vault upgrade operation.

Value	Description
Unknown
InProgress
Upgraded
Failed

Share via

Vaults - Get

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

Get Recovery Services Resource

Sample request

Sample response

Definitions

AlertsState

AssociatedIdentity

AzureMonitorAlertSettings

BackupStorageVersion

BCDRSecurityLevel

ClassicAlertSettings

CloudError

CmkKekIdentity

CmkKeyVaultProperties

createdByType

CrossRegionRestore

CrossSubscriptionRestoreSettings

CrossSubscriptionRestoreState

EnhancedSecurityState

Error

ErrorAdditionalInfo

IdentityData

IdentityType

ImmutabilitySettings

ImmutabilityState

InfrastructureEncryptionState

MonitoringSettings

MultiUserAuthorization

PrivateEndpoint

PrivateEndpointConnection

PrivateEndpointConnectionStatus

PrivateEndpointConnectionVaultProperties

PrivateLinkServiceConnectionState

ProvisioningState

PublicNetworkAccess

ResourceIdentityType

ResourceMoveState

RestoreSettings

SecureScoreLevel

SecuritySettings

Sku

SkuName

SoftDeleteSettings

SoftDeleteState

SourceScanConfiguration

StandardTierStorageRedundancy

State

systemData

TriggerType

UpgradeDetails

UserIdentity

Vault

VaultPrivateEndpointState

VaultProperties

VaultPropertiesEncryption

VaultPropertiesMoveDetails

VaultPropertiesRedundancySettings

VaultSubResourceType

VaultUpgradeState