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


Backup Vaults - Get In Resource Group

Возвращает коллекцию ресурсов, принадлежащую группе ресурсов.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults?api-version=2024-04-01

Параметры URI

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

string

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

subscriptionId
path True

string

uuid

Идентификатор целевой подписки. Значение должно быть UUID.

api-version
query True

string

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

Ответы

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

BackupVaultResourceList

ХОРОШО

Other Status Codes

CloudError

Ответ на ошибку, описывающий причину сбоя операции.

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

azure_auth

Поток OAuth2 Azure Active Directory

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

Области

Имя Описание
user_impersonation олицетворения учетной записи пользователя.

Примеры

Get BackupVaults in ResourceGroup

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

GET https://management.azure.com/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/backupVaults?api-version=2024-04-01

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

{
  "value": [
    {
      "identity": {
        "type": "None"
      },
      "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/BackupVaults/ExampleVault1",
      "name": "ExampleVault1",
      "type": "Microsoft.DataProtection/BackupVaults",
      "location": "WestUS",
      "tags": {
        "key1": "val1"
      },
      "properties": {
        "provisioningState": "Succeeded",
        "storageSettings": [
          {
            "datastoreType": "VaultStore",
            "type": "LocallyRedundant"
          }
        ],
        "featureSettings": {
          "crossRegionRestoreSettings": {
            "state": "Enabled"
          }
        },
        "securitySettings": {
          "softDeleteSettings": {
            "state": "Enabled",
            "retentionDurationInDays": 14
          }
        },
        "secureScore": "Adequate",
        "bcdrSecurityLevel": "Good"
      }
    },
    {
      "identity": {
        "principalId": "c009b9a0-0024-417c-83cd-025d3776045d",
        "tenantId": "83abe5cd-bcc3-441a-bd86-e6a75360cecc",
        "type": "SystemAssigned"
      },
      "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/BackupVaults/ExampleVault2",
      "name": "ExampleVault2",
      "type": "Microsoft.DataProtection/BackupVaults",
      "location": "WestUS",
      "tags": {
        "key1": "val1"
      },
      "properties": {
        "monitoringSettings": {
          "azureMonitorAlertSettings": {
            "alertsForAllJobFailures": "Enabled"
          }
        },
        "provisioningState": "Succeeded",
        "storageSettings": [
          {
            "datastoreType": "VaultStore",
            "type": "LocallyRedundant"
          }
        ],
        "featureSettings": {
          "crossRegionRestoreSettings": {
            "state": "Enabled"
          }
        },
        "securitySettings": {
          "softDeleteSettings": {
            "state": "Enabled",
            "retentionDurationInDays": 14
          }
        },
        "secureScore": "Adequate",
        "bcdrSecurityLevel": "Good"
      }
    }
  ]
}

Определения

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

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

BackupVault

BackupVault

BackupVaultResource

Ресурс BackupVault

BackupVaultResourceList

BackupVaultResourceList

BCDRSecurityLevel

Уровень безопасности хранилища резервных копий

CloudError

CloudError

CmkKekIdentity

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

CmkKeyVaultProperties

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

createdByType

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

CrossRegionRestoreSettings
CrossRegionRestoreState

Состояние CrossRegionRestore

CrossSubscriptionRestoreSettings

Параметры CrossSubscriptionRestore

CrossSubscriptionRestoreState

Состояние CrossSubscriptionRestore

DppIdentityDetails

DppIdentityDetails

encryptionSettings

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

EncryptionState

Состояние шифрования хранилища резервных копий.

Error

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

ErrorAdditionalInfo

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

FeatureSettings

Класс, содержащий параметры компонентов хранилища

IdentityType

Тип удостоверения. SystemAssigned и UserAssigned являются взаимоисключающими. SystemAssigned будет использовать неявно созданное управляемое удостоверение.

ImmutabilitySettings

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

ImmutabilityState

Состояние неизменяемости

InfrastructureEncryptionState

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

MonitoringSettings

Параметры мониторинга

ProvisioningState

Состояние подготовки ресурса BackupVault

ResourceMoveDetails

ResourceMoveDetails будет возвращен в ответ на вызов GetResource из ARM

ResourceMoveState

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

SecureScoreLevel

Оценка безопасности хранилища резервных копий

SecuritySettings

Класс, содержащий параметры безопасности хранилища

SoftDeleteSettings

Обратимое удаление связанных параметров

SoftDeleteState

Состояние обратимого удаления

StorageSetting

StorageSetting

StorageSettingStoreTypes

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

StorageSettingTypes

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

systemData

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

UserAssignedIdentity

Свойства назначаемого пользователем удостоверения

AlertsState

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

string

Enabled

string

AzureMonitorAlertSettings

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

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

AlertsState

BackupVault

BackupVault

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

BCDRSecurityLevel

Уровень безопасности хранилища резервных копий

featureSettings

FeatureSettings

Параметры компонентов

isVaultProtectedByResourceGuard

boolean

Хранилище, защищенное с помощью resource guard

monitoringSettings

MonitoringSettings

Параметры мониторинга

provisioningState

ProvisioningState

Состояние подготовки ресурса BackupVault

replicatedRegions

string[]

Список реплицированных регионов для Backup Vault

resourceGuardOperationRequests

string[]

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

resourceMoveDetails

ResourceMoveDetails

Сведения о перемещении ресурсов для хранилища резервных копий

resourceMoveState

ResourceMoveState

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

secureScore

SecureScoreLevel

Оценка безопасности хранилища резервных копий

securitySettings

SecuritySettings

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

storageSettings

StorageSetting[]

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

BackupVaultResource

Ресурс BackupVault

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

string

Необязательный ETag.

id

string

Идентификатор ресурса представляет полный путь к ресурсу.

identity

DppIdentityDetails

DppIdentityDetails
Сведения о входных управляемых удостоверениях

location

string

Расположение ресурса.

name

string

Имя ресурса, связанное с ресурсом.

properties

BackupVault

BackupVault
Свойства BackupVaultResource

systemData

systemData

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

tags

object

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

type

string

Тип ресурса представляет полный путь к пространству имен формы/ResourceType/ResourceType/...

BackupVaultResourceList

BackupVaultResourceList

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

string

URI для получения следующей страницы ресурсов. Вызов ListNext() извлекает следующую страницу ресурсов.

value

BackupVaultResource[]

Список ресурсов.

BCDRSecurityLevel

Уровень безопасности хранилища резервных копий

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

string

Fair

string

Good

string

NotSupported

string

Poor

string

CloudError

CloudError

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

Error

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

CmkKekIdentity

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

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

string

Управляемое удостоверение, используемое с разрешениями на доступ к Key Vault. Укажите здесь значение, если типы удостоверений: "UserAssigned" только.

identityType

IdentityType

Тип удостоверения. SystemAssigned и UserAssigned являются взаимоисключающими. SystemAssigned будет использовать неявно созданное управляемое удостоверение.

CmkKeyVaultProperties

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

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

string

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

createdByType

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

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

string

Key

string

ManagedIdentity

string

User

string

CrossRegionRestoreSettings

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

CrossRegionRestoreState

Состояние CrossRegionRestore

CrossRegionRestoreState

Состояние CrossRegionRestore

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

string

Enabled

string

CrossSubscriptionRestoreSettings

Параметры CrossSubscriptionRestore

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

CrossSubscriptionRestoreState

Состояние CrossSubscriptionRestore

CrossSubscriptionRestoreState

Состояние CrossSubscriptionRestore

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

string

Enabled

string

PermanentlyDisabled

string

DppIdentityDetails

DppIdentityDetails

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

string

Идентификатор объекта субъекта-службы для управляемого удостоверения, используемого для предоставления доступа на основе ролей ресурсу Azure.

tenantId

string

Глобальный уникальный идентификатор (GUID), представляющий клиент Azure AD, в котором ресурс теперь является членом.

type

string

IdentityType, который может быть systemAssigned, UserAssigned, SystemAssigned, SystemAssigned, UserAssigned или None

userAssignedIdentities

<string,  UserAssignedIdentity>

Возвращает или задает назначенные пользователем удостоверения.

encryptionSettings

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

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

InfrastructureEncryptionState

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

kekIdentity

CmkKekIdentity

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

keyVaultProperties

CmkKeyVaultProperties

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

state

EncryptionState

Состояние шифрования хранилища резервных копий.

EncryptionState

Состояние шифрования хранилища резервных копий.

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

string

Шифрование CMK отключено в хранилище резервных копий. Пользователь не может задать это состояние после включения состояния шифрования.

Enabled

string

Шифрование CMK в хранилище резервных копий включено

Inconsistent

string

Шифрование CMK находится в несогласованном состоянии в Хранилище резервных копий. Это состояние указывает, что пользователю необходимо повторить операцию параметров шифрования немедленно, чтобы исправить состояние.

Error

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

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

ErrorAdditionalInfo[]

Дополнительные сведения об ошибке.

code

string

Код ошибки.

details

Error[]

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

message

string

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

target

string

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

ErrorAdditionalInfo

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

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

object

Дополнительные сведения.

type

string

Дополнительный тип сведений.

FeatureSettings

Класс, содержащий параметры компонентов хранилища

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

CrossRegionRestoreSettings

crossSubscriptionRestoreSettings

CrossSubscriptionRestoreSettings

Параметры CrossSubscriptionRestore

IdentityType

Тип удостоверения. SystemAssigned и UserAssigned являются взаимоисключающими. SystemAssigned будет использовать неявно созданное управляемое удостоверение.

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

string

UserAssigned

string

ImmutabilitySettings

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

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

ImmutabilityState

Состояние неизменяемости

ImmutabilityState

Состояние неизменяемости

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

string

Locked

string

Unlocked

string

InfrastructureEncryptionState

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

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

string

Enabled

string

MonitoringSettings

Параметры мониторинга

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

AzureMonitorAlertSettings

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

ProvisioningState

Состояние подготовки ресурса BackupVault

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

string

Provisioning

string

Succeeded

string

Unknown

string

Updating

string

ResourceMoveDetails

ResourceMoveDetails будет возвращен в ответ на вызов GetResource из ARM

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

string

Время завершения в формате UTC последней операции ResourceMove. Формат ISO 8601.

operationId

string

CorrelationId последней операции ResourceMove, предпринятой

sourceResourcePath

string

Путь к ресурсам ARM исходного ресурса

startTimeUtc

string

Время начала в формате UTC последней попытки операции ResourceMove. Формат ISO 8601.

targetResourcePath

string

Путь к ресурсу ARM целевого ресурса, используемого в последней операции ResourceMove

ResourceMoveState

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

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

string

CommitTimedout

string

CriticalFailure

string

Failed

string

InProgress

string

MoveSucceeded

string

PartialSuccess

string

PrepareFailed

string

PrepareTimedout

string

Unknown

string

SecureScoreLevel

Оценка безопасности хранилища резервных копий

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

string

Maximum

string

Minimum

string

None

string

NotSupported

string

SecuritySettings

Класс, содержащий параметры безопасности хранилища

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

encryptionSettings

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

immutabilitySettings

ImmutabilitySettings

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

softDeleteSettings

SoftDeleteSettings

Обратимое удаление связанных параметров

SoftDeleteSettings

Обратимое удаление связанных параметров

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

number

Длительность хранения обратимого удаления

state

SoftDeleteState

Состояние обратимого удаления

SoftDeleteState

Состояние обратимого удаления

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

string

Обратимое удаление окончательно включено для BackupVault, а параметр не может быть изменен

Off

string

Обратимое удаление отключено для BackupVault

On

string

Обратимое удаление включено для BackupVault, но его можно отключить.

StorageSetting

StorageSetting

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

StorageSettingStoreTypes

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

type

StorageSettingTypes

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

StorageSettingStoreTypes

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

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

string

OperationalStore

string

VaultStore

string

StorageSettingTypes

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

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

string

LocallyRedundant

string

ZoneRedundant

string

systemData

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

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

string

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

createdBy

string

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

createdByType

createdByType

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

lastModifiedAt

string

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

lastModifiedBy

string

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

lastModifiedByType

createdByType

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

UserAssignedIdentity

Свойства назначаемого пользователем удостоверения

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

string

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

principalId

string

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