Поделиться через


Vaults - Get

Получение сведений о хранилище.

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

Параметры URI

Имя В Обязательно Тип Описание
resourceGroupName
path True

string

minLength: 1
maxLength: 90

Имя группы ресурсов. Имя регистронезависимо.

subscriptionId
path True

string

minLength: 1

Идентификатор целевой подписки.

vaultName
path True

string

Название Убежища

api-version
query True

string

minLength: 1

Версия API, используемая для данной операции.

Ответы

Имя Тип Описание
200 OK

Vault

Операция Azure успешно завершена.

Other Status Codes

CloudError

Непредвиденное сообщение об ошибке.

Безопасность

azure_auth

Azure Active Directory OAuth2 Flow.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя Описание
user_impersonation Выдача себя за свою учетную запись пользователя

Примеры

Get Recovery Services Resource

Образец запроса

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

Пример ответа

{
  "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"
      }
    },
    "costManagementSettings": {
      "granularityLevel": "ProtectedItemLevel"
    },
    "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"
  }
}

Определения

Имя Описание
AlertsState
AssociatedIdentity

Сведения об удостоверениях, которые будут использоваться для операции

AzureMonitorAlertSettings

Параметры оповещений на основе Azure Monitor

BackupStorageVersion

Версия хранилища резервных копий

BCDRSecurityLevel

Уровни безопасности хранилища служб восстановления для обеспечения непрерывности бизнес-процессов и аварийного восстановления

ClassicAlertSettings

Параметры классических оповещений

CloudError

Ответ об ошибке из Azure Backup.

CmkKekIdentity

Сведения об идентификаторе, используемом для CMK

CmkKeyVaultProperties

Свойства Key Vault, в котором размещается CMK

CostManagementSettings

Настройки управления затратами в хранилище

createdByType

Тип удостоверения, создавшего ресурс.

CrossRegionRestore

Пометка, чтобы показать, включена ли восстановление между регионами в хранилище или нет

CrossSubscriptionRestoreSettings

Параметры для параметров восстановления между подписками

CrossSubscriptionRestoreState
EnhancedSecurityState
Error

Ответ об ошибке управления ресурсами.

ErrorAdditionalInfo

Ошибка управления ресурсами дополнительная информация.

GranularityLevel
IdentityData

Удостоверение ресурса.

IdentityType

Тип удостоверения, который следует использовать для операции.

ImmutabilitySettings

Параметры неизменяемости хранилища

ImmutabilityState
InfrastructureEncryptionState

Включение и отключение состояния двойного шифрования

MonitoringSettings

Параметры мониторинга хранилища

MultiUserAuthorization

Параметры muA хранилища

PrivateEndpoint

Сетевой ресурс частной конечной точки, связанный с подключением к частной конечной точке.

PrivateEndpointConnection

Свойства ответа подключения к частной конечной точке.

PrivateEndpointConnectionStatus

Возвращает или задает состояние.

PrivateEndpointConnectionVaultProperties

Сведения, хранящиеся в свойствах Vault в качестве элемента privateEndpointConnections List.

PrivateLinkServiceConnectionState

Возвращает или задает состояние подключения службы приватного канала.

ProvisioningState

Возвращает или задает состояние подготовки подключения к частной конечной точке.

PublicNetworkAccess

свойство для включения или отключения входящего сетевого трафика поставщика ресурсов от общедоступных клиентов

ResourceIdentityType

Тип управляемого удостоверения, используемого. Тип SystemAssigned, UserAssigned включает как неявное созданное удостоверение, так и набор удостоверений, назначенных пользователем. Тип "Нет" приведет к удалению удостоверений.

ResourceMoveState

Состояние ресурса после операции перемещения

RestoreSettings

Восстановление параметров хранилища

SecureScoreLevel

Оценка безопасности хранилища служб восстановления

SecuritySettings

Параметры безопасности хранилища

Sku

Определяет уникальный системный идентификатор для каждого ресурса Azure.

SkuName

Имя номера SKU — RS0 (версия служб восстановления 0-го), а уровень — стандартный. Они не влияют на избыточность внутреннего хранилища или другие параметры хранилища. Чтобы управлять избыточностью хранилища, используйте backupstorageconfig

SoftDeleteSettings

Обратимое удаление параметров хранилища

SoftDeleteState
SourceScanConfiguration

Конфигурация проверки источника хранилища

StandardTierStorageRedundancy

Параметр избыточности хранилища хранилища

State
systemData

Метаданные, относящиеся к созданию и последнему изменении ресурса.

TriggerType

Способ запуска обновления хранилища.

UpgradeDetails

Сведения об обновлении хранилища.

UserIdentity

Удостоверение ресурса, управляемое пользователем службы.

Vault

Сведения о ресурсах, возвращаемые поставщиком ресурсов.

VaultPrivateEndpointState

Состояние частной конечной точки для резервного копирования.

VaultProperties

Свойства хранилища.

VaultPropertiesEncryption

Сведения о управляемом клиентом ключе ресурса.

VaultPropertiesMoveDetails

Сведения о последней операции перемещения, выполняемой в ресурсе Azure

VaultPropertiesRedundancySettings

Параметры избыточности хранилища

VaultSubResourceType

Тип subresource для хранилища AzureBackup, AzureBackup_secondary или AzureSiteRecovery

VaultUpgradeState

Состояние операции обновления хранилища.

AlertsState

Значение Описание
Enabled
Disabled

AssociatedIdentity

Сведения об удостоверениях, которые будут использоваться для операции

Имя Тип Описание
operationIdentityType

IdentityType

Тип удостоверения, который следует использовать для операции.

userAssignedIdentity

string

Назначаемое пользователем удостоверение, используемое для операции, если operationIdentityType — UserAssigned.

AzureMonitorAlertSettings

Параметры оповещений на основе Azure Monitor

Имя Тип Описание
alertsForAllFailoverIssues

AlertsState

alertsForAllJobFailures

AlertsState

alertsForAllReplicationIssues

AlertsState

BackupStorageVersion

Версия хранилища резервных копий

Значение Описание
V1
V2
Unassigned

BCDRSecurityLevel

Уровни безопасности хранилища служб восстановления для обеспечения непрерывности бизнес-процессов и аварийного восстановления

Значение Описание
Poor
Fair
Good
Excellent

ClassicAlertSettings

Параметры классических оповещений

Имя Тип Описание
alertsForCriticalOperations

AlertsState

emailNotificationsForSiteRecovery

AlertsState

CloudError

Ответ об ошибке из Azure Backup.

Имя Тип Описание
error

Error

Ответ об ошибке управления ресурсами.

CmkKekIdentity

Сведения об идентификаторе, используемом для CMK

Имя Тип Описание
useSystemAssignedIdentity

boolean

Укажите, что необходимо использовать назначенное системой удостоверение. Взаимоисключающая с полем userAssignedIdentity

userAssignedIdentity

string

Назначенное пользователем удостоверение для предоставления разрешений в случае, если используется тип удостоверения UserAssigned

CmkKeyVaultProperties

Свойства Key Vault, в котором размещается CMK

Имя Тип Описание
keyUri

string

Универсальный код ресурса (URI) управляемого клиентом ключа

CostManagementSettings

Настройки управления затратами в хранилище

Имя Тип Описание
granularityLevel

GranularityLevel

Настройки уровня детализации

createdByType

Тип удостоверения, создавшего ресурс.

Значение Описание
User
Application
ManagedIdentity
Key

CrossRegionRestore

Пометка, чтобы показать, включена ли восстановление между регионами в хранилище или нет

Значение Описание
Enabled
Disabled

CrossSubscriptionRestoreSettings

Параметры для параметров восстановления между подписками

Имя Тип Описание
crossSubscriptionRestoreState

CrossSubscriptionRestoreState

CrossSubscriptionRestoreState

Значение Описание
Enabled
Disabled
PermanentlyDisabled

EnhancedSecurityState

Значение Описание
Invalid
Enabled
Disabled
AlwaysON

Error

Ответ об ошибке управления ресурсами.

Имя Тип Описание
additionalInfo

ErrorAdditionalInfo[]

Ошибка дополнительная информация.

code

string

Код ошибки.

details

Error[]

Сведения об ошибке.

message

string

Сообщение об ошибке.

target

string

Целевой объект ошибки.

ErrorAdditionalInfo

Ошибка управления ресурсами дополнительная информация.

Имя Тип Описание
info

object

Дополнительная информация.

type

string

Тип дополнительной информации.

GranularityLevel

Значение Описание
VaultLevel
ProtectedItemLevel
ProtectedItemWithParentTag

IdentityData

Удостоверение ресурса.

Имя Тип Описание
principalId

string

Идентификатор субъекта удостоверения ресурса.

tenantId

string

Идентификатор клиента ресурса.

type

ResourceIdentityType

Тип управляемого удостоверения, используемого. Тип SystemAssigned, UserAssigned включает как неявное созданное удостоверение, так и набор удостоверений, назначенных пользователем. Тип "Нет" приведет к удалению удостоверений.

userAssignedIdentities

<string,  UserIdentity>

Список удостоверений, назначенных пользователем, связанных с ресурсом. Ключи словаря удостоверения, назначаемые пользователем, будут идентификаторами ресурсов ARM в форме: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

IdentityType

Тип удостоверения, который следует использовать для операции.

Значение Описание
SystemAssigned
UserAssigned

ImmutabilitySettings

Параметры неизменяемости хранилища

Имя Тип Описание
state

ImmutabilityState

ImmutabilityState

Значение Описание
Disabled
Unlocked
Locked

InfrastructureEncryptionState

Включение и отключение состояния двойного шифрования

Значение Описание
Enabled
Disabled

MonitoringSettings

Параметры мониторинга хранилища

Имя Тип Описание
azureMonitorAlertSettings

AzureMonitorAlertSettings

Параметры оповещений на основе Azure Monitor

classicAlertSettings

ClassicAlertSettings

Параметры классических оповещений

MultiUserAuthorization

Параметры muA хранилища

Значение Описание
Invalid
Enabled
Disabled

PrivateEndpoint

Сетевой ресурс частной конечной точки, связанный с подключением к частной конечной точке.

Имя Тип Описание
id

string

Возвращает или задает идентификатор.

PrivateEndpointConnection

Свойства ответа подключения к частной конечной точке.

Имя Тип Описание
groupIds

VaultSubResourceType[]

Идентификаторы групп для частной конечной точки

privateEndpoint

PrivateEndpoint

Сетевой ресурс частной конечной точки, связанный с подключением к частной конечной точке.

privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

Возвращает или задает состояние подключения службы приватного канала.

provisioningState

ProvisioningState

Возвращает или задает состояние подготовки подключения к частной конечной точке.

PrivateEndpointConnectionStatus

Возвращает или задает состояние.

Значение Описание
Pending
Approved
Rejected
Disconnected

PrivateEndpointConnectionVaultProperties

Сведения, хранящиеся в свойствах Vault в качестве элемента privateEndpointConnections List.

Имя Тип Описание
id

string

Формат подписок идентификаторов/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft. [Служба]/{resource}/{resourceName}/privateEndpointConnections/{connectionName}.

location

string

Расположение подключения частной конечной точки

name

string

Имя подключения частной конечной точки

properties

PrivateEndpointConnection

Свойства ответа подключения к частной конечной точке.

type

string

Тип, который будет иметь формат, Microsoft.RecoveryServices/vaults/privateEndpointConnections

PrivateLinkServiceConnectionState

Возвращает или задает состояние подключения службы приватного канала.

Имя Тип Описание
actionsRequired

string

Возвращает или задает необходимые действия.

description

string

Возвращает или задает описание.

status

PrivateEndpointConnectionStatus

Возвращает или задает состояние.

ProvisioningState

Возвращает или задает состояние подготовки подключения к частной конечной точке.

Значение Описание
Succeeded
Deleting
Failed
Pending

PublicNetworkAccess

свойство для включения или отключения входящего сетевого трафика поставщика ресурсов от общедоступных клиентов

Значение Описание
Enabled
Disabled

ResourceIdentityType

Тип управляемого удостоверения, используемого. Тип SystemAssigned, UserAssigned включает как неявное созданное удостоверение, так и набор удостоверений, назначенных пользователем. Тип "Нет" приведет к удалению удостоверений.

Значение Описание
SystemAssigned
None
UserAssigned
SystemAssigned, UserAssigned

ResourceMoveState

Состояние ресурса после операции перемещения

Значение Описание
Unknown
InProgress
PrepareFailed
CommitFailed
PrepareTimedout
CommitTimedout
MoveSucceeded
Failure
CriticalFailure
PartialSuccess

RestoreSettings

Восстановление параметров хранилища

Имя Тип Описание
crossSubscriptionRestoreSettings

CrossSubscriptionRestoreSettings

Параметры для CrossSubscriptionRestore

SecureScoreLevel

Оценка безопасности хранилища служб восстановления

Значение Описание
None
Minimum
Adequate
Maximum

SecuritySettings

Параметры безопасности хранилища

Имя Тип Описание
immutabilitySettings

ImmutabilitySettings

Параметры неизменяемости хранилища

multiUserAuthorization

MultiUserAuthorization

Параметры MUA хранилища

softDeleteSettings

SoftDeleteSettings

Параметры обратимого удаления хранилища

sourceScanConfiguration

SourceScanConfiguration

Конфигурация проверки источника хранилища

Sku

Определяет уникальный системный идентификатор для каждого ресурса Azure.

Имя Тип Описание
capacity

string

Емкость SKU

family

string

Семья SKU

name

SkuName

Имя номера SKU — RS0 (версия служб восстановления 0-го), а уровень — стандартный. Они не влияют на избыточность внутреннего хранилища или другие параметры хранилища. Чтобы управлять избыточностью хранилища, используйте backupstorageconfig

size

string

Размер SKU

tier

string

Уровень SKU.

SkuName

Имя номера SKU — RS0 (версия служб восстановления 0-го), а уровень — стандартный. Они не влияют на избыточность внутреннего хранилища или другие параметры хранилища. Чтобы управлять избыточностью хранилища, используйте backupstorageconfig

Значение Описание
Standard
RS0

SoftDeleteSettings

Обратимое удаление параметров хранилища

Имя Тип Описание
enhancedSecurityState

EnhancedSecurityState

softDeleteRetentionPeriodInDays

integer (int32)

Период хранения обратимого удаления в днях

softDeleteState

SoftDeleteState

SoftDeleteState

Значение Описание
Invalid
Enabled
Disabled
AlwaysON

SourceScanConfiguration

Конфигурация проверки источника хранилища

Имя Тип Описание
sourceScanIdentity

AssociatedIdentity

Сведения об удостоверениях, которые будут использоваться для операции

state

State

StandardTierStorageRedundancy

Параметр избыточности хранилища хранилища

Значение Описание
Invalid
LocallyRedundant
GeoRedundant
ZoneRedundant

State

Значение Описание
Invalid
Enabled
Disabled

systemData

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Имя Тип Описание
createdAt

string (date-time)

Метка времени создания ресурса (UTC).

createdBy

string

Удостоверение, создающее ресурс.

createdByType

createdByType

Тип удостоверения, создавшего ресурс.

lastModifiedAt

string (date-time)

Временная метка последнего изменения ресурса (UTC)

lastModifiedBy

string

Идентификатор, который последний раз изменил ресурс.

lastModifiedByType

createdByType

Тип удостоверения, который последний раз изменил ресурс.

TriggerType

Способ запуска обновления хранилища.

Значение Описание
UserTriggered
ForcedUpgrade

UpgradeDetails

Сведения об обновлении хранилища.

Имя Тип Описание
endTimeUtc

string (date-time)

Время в формате UTC, в течение которого завершена операция обновления.

lastUpdatedTimeUtc

string (date-time)

Время в формате UTC, в течение которого состояние операции обновления было обновлено в последний раз.

message

string

Сообщение пользователю, содержащее сведения об операции обновления.

operationId

string

Идентификатор операции обновления хранилища.

previousResourceId

string

Идентификатор ресурса хранилища перед обновлением.

startTimeUtc

string (date-time)

Время в формате UTC, с которого запущена операция обновления.

status

VaultUpgradeState

Состояние операции обновления хранилища.

triggerType

TriggerType

Способ запуска обновления хранилища.

upgradedResourceId

string

Идентификатор ресурса обновленного хранилища.

UserIdentity

Удостоверение ресурса, управляемое пользователем службы.

Имя Тип Описание
clientId

string

Идентификатор клиента назначаемого пользователем удостоверения.

principalId

string

Основной идентификатор удостоверения, назначаемого пользователем.

Vault

Сведения о ресурсах, возвращаемые поставщиком ресурсов.

Имя Тип Описание
etag

string

etag для ресурса.

id

string

Полный идентификатор ресурса для ресурса. Пример - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

identity

IdentityData

Удостоверение ресурса.

location

string

Географическое расположение, в котором находится ресурс

name

string

Имя ресурса.

properties

VaultProperties

Свойства хранилища.

sku

Sku

Определяет уникальный системный идентификатор для каждого ресурса Azure.

systemData

systemData

Метаданные Azure Resource Manager, содержащие данные createdBy и modifiedBy.

tags

object

Теги ресурсов.

type

string

Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

VaultPrivateEndpointState

Состояние частной конечной точки для резервного копирования.

Значение Описание
None
Enabled

VaultProperties

Свойства хранилища.

Имя Тип Описание
backupStorageVersion

BackupStorageVersion

Версия хранилища резервных копий

bcdrSecurityLevel

BCDRSecurityLevel

Уровни безопасности хранилища служб восстановления для обеспечения непрерывности бизнес-процессов и аварийного восстановления

costManagementSettings

CostManagementSettings

Настройки управления затратами в хранилище

encryption

VaultPropertiesEncryption

Сведения о управляемом клиентом ключе ресурса.

monitoringSettings

MonitoringSettings

Параметры мониторинга хранилища

moveDetails

VaultPropertiesMoveDetails

Сведения о последней операции перемещения, выполняемой в ресурсе Azure

moveState

ResourceMoveState

Состояние ресурса после операции перемещения

privateEndpointConnections

PrivateEndpointConnectionVaultProperties[]

Список подключений к частной конечной точке.

privateEndpointStateForBackup

VaultPrivateEndpointState

Состояние частной конечной точки для резервного копирования.

privateEndpointStateForSiteRecovery

VaultPrivateEndpointState

Состояние частной конечной точки для восстановления сайта.

provisioningState

string

Состояние подготовки.

publicNetworkAccess

PublicNetworkAccess

свойство для включения или отключения входящего сетевого трафика поставщика ресурсов от общедоступных клиентов

redundancySettings

VaultPropertiesRedundancySettings

Параметры избыточности хранилища

resourceGuardOperationRequests

string[]

ResourceGuardOperationRequests, на котором будет выполнена проверка LAC

restoreSettings

RestoreSettings

Восстановление параметров хранилища

secureScore

SecureScoreLevel

Оценка безопасности хранилища служб восстановления

securitySettings

SecuritySettings

Параметры безопасности хранилища

upgradeDetails

UpgradeDetails

Сведения об обновлении хранилища.

VaultPropertiesEncryption

Сведения о управляемом клиентом ключе ресурса.

Имя Тип Описание
infrastructureEncryption

InfrastructureEncryptionState

Включение и отключение состояния двойного шифрования

kekIdentity

CmkKekIdentity

Сведения об идентификаторе, используемом для CMK

keyVaultProperties

CmkKeyVaultProperties

Свойства Key Vault, в котором размещается CMK

VaultPropertiesMoveDetails

Сведения о последней операции перемещения, выполняемой в ресурсе Azure

Имя Тип Описание
completionTimeUtc

string (date-time)

Время окончания операции перемещения ресурсов

operationId

string

OperationId операции перемещения ресурсов

sourceResourceId

string

Исходный ресурс операции перемещения ресурсов

startTimeUtc

string (date-time)

Время начала операции перемещения ресурсов

targetResourceId

string

Целевой ресурс операции перемещения ресурсов

VaultPropertiesRedundancySettings

Параметры избыточности хранилища

Имя Тип Описание
crossRegionRestore

CrossRegionRestore

Пометка, чтобы показать, включена ли восстановление между регионами в хранилище или нет

standardTierStorageRedundancy

StandardTierStorageRedundancy

Параметр избыточности хранилища хранилища

VaultSubResourceType

Тип subresource для хранилища AzureBackup, AzureBackup_secondary или AzureSiteRecovery

Значение Описание
AzureBackup
AzureBackup_secondary
AzureSiteRecovery

VaultUpgradeState

Состояние операции обновления хранилища.

Значение Описание
Unknown
InProgress
Upgraded
Failed