Backup Instances - Validate For Backup

サービス:: Data Protection

API バージョン:: 2025-07-01

アドホックバックアップが成功するかどうかを検証する

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/validateForBackup?api-version=2025-07-01

URI パラメーター

名前	/	必須	型	説明
resourceGroupName	path	True	string minLength: 1 maxLength: 90	リソースグループの名前。名前は大文字と小文字が区別されます。
subscriptionId	path	True	string (uuid)	ターゲットサブスクリプションの ID。値は UUID である必要があります。
vaultName	path	True	string	バックアップコンテナーの名前。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

要求本文

名前	必須	型	説明
backupInstance	True	BackupInstance	バックアップインスタンス

応答

名前	型	説明
200 OK	OperationJobExtendedInfo	ジョブ ID や非同期操作の操作ジョブ拡張情報などの追加情報が含まれ、状態を追跡します。
202 Accepted		操作は非同期的に完了します。ヘッダー Location: string Azure-AsyncOperation: string Retry-After: integer
Other Status Codes	CloudError	操作が失敗した理由を説明するエラー応答。

名前

型

説明

200 OK

OperationJobExtendedInfo

ジョブ ID や非同期操作の操作ジョブ拡張情報などの追加情報が含まれ、状態を追跡します。

202 Accepted

操作は非同期的に完了します。

ヘッダー

Location: string
Azure-AsyncOperation: string
Retry-After: integer

Other Status Codes

CloudError

操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザーアカウントを偽装します。

例

Validate For Backup

要求のサンプル

HTTP

POST https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/validateForBackup?api-version=2025-07-01

{
  "backupInstance": {
    "objectType": "BackupInstance",
    "friendlyName": "harshitbi2",
    "dataSourceSetInfo": {
      "objectType": "DatasourceSet",
      "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest",
      "resourceName": "viveksipgtest",
      "resourceType": "Microsoft.DBforPostgreSQL/servers",
      "resourceUri": "",
      "resourceLocation": "",
      "datasourceType": "OssDB"
    },
    "dataSourceInfo": {
      "objectType": "Datasource",
      "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb",
      "resourceName": "testdb",
      "resourceType": "Microsoft.DBforPostgreSQL/servers/databases",
      "resourceUri": "",
      "resourceLocation": "",
      "datasourceType": "OssDB"
    },
    "datasourceAuthCredentials": {
      "secretStoreResource": {
        "uri": "https://samplevault.vault.azure.net/secrets/credentials",
        "secretStoreType": "AzureKeyVault"
      },
      "objectType": "SecretStoreBasedAuthCredentials"
    },
    "policyInfo": {
      "policyId": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/Backupvaults/PratikPrivatePreviewVault1/backupPolicies/PratikPolicy1"
    },
    "identityDetails": {
      "useSystemAssignedIdentity": false,
      "userAssignedIdentityArmUrl": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourcegroups/rg-name/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testUami"
    }
  }
}

応答のサンプル

状態コード:: 202

Location: https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2025-07-01
Azure-AsyncOperation: https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2025-07-01
Retry-After: 60

状態コード:: 200

{
  "jobId": "c60cb49-63e8-4b21-b9bd-26277b3fdfae",
  "objectType": "OperationJobExtendedInfo"
}

定義

名前	説明
AdlsBlobBackupDatasourceParameters	Azure Data Lake Storage アカウント BLOB のバックアップの構成中に使用されるパラメーター
AKSVolumeTypes	インクルードボリュームの種類プロパティを取得または設定します。このプロパティは、バックアップ中に含めるボリュームの種類を設定します。
AzureOperationalStoreParameters	Operational-Tier データストアのパラメーター
BackupInstance	バックアップインスタンス
BlobBackupDatasourceParameters	BLOB のバックアップの構成時に使用するパラメーター
CloudError	クラウドエラー
CurrentProtectionState	リソースの現在の保護状態を指定します
Datasource	データソース
DatasourceSet	データソースセット
DataStoreTypes	データストアの種類。Operational/Vault/Archive
DefaultResourceProperties	既定のソースプロパティ
Error	リソース管理エラー応答。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
IdentityDetails
InnerError	インナーエラー
KubernetesClusterBackupDatasourceParameters	Kubernetes クラスターバックアップデータソースのパラメーター
NamespacedNameResource	名前空間名リソース
OperationJobExtendedInfo	OperationJobExtendedInfo (オペレーションジョブ拡張情報)
PolicyInfo	ポリシー情報
PolicyParameters	ポリシーのパラメーター
ProtectionStatusDetails	保護状態の詳細
SecretStoreBasedAuthCredentials	シークレットストアベースの認証資格情報。
SecretStoreResource	シークレットストアリソースを表すクラス。
SecretStoreType	シークレットストアの種類を取得または設定します。
Status	リソースの保護状態を指定します
UserFacingError	ローカライズされたコンテンツにアクセスし、ユーザーに伝達するレイヤーによって使用されるエラーオブジェクト
ValidateForBackupRequest	ValidateForBackupRequest (英語)
ValidationType	検証の種類を指定します。 DeepValidation の場合、/validateForBackup API のすべての検証が再度実行されます。

AdlsBlobBackupDatasourceParameters

Object

Azure Data Lake Storage アカウント BLOB のバックアップの構成中に使用されるパラメーター

名前	型	説明
containersList	string[]	BLOB のバックアップの構成中にバックアップするコンテナーの一覧
objectType	string: AdlsBlobBackupDatasourceParameters	特定のオブジェクトの型 - 逆シリアル化に使用されます

AKSVolumeTypes

列挙

インクルードボリュームの種類プロパティを取得または設定します。このプロパティは、バックアップ中に含めるボリュームの種類を設定します。

値	説明
AzureDisk
AzureFileShareSMB

AzureOperationalStoreParameters

Object

Operational-Tier データストアのパラメーター

名前	型	説明
dataStoreType	DataStoreTypes	データストアの種類。Operational/Vault/Archive
objectType	string: AzureOperationalStoreParameters	特定のオブジェクトの型 - 逆シリアル化に使用されます
resourceGroupId	string	スナップショットリソースグループ URI を取得または設定します。

BackupInstance

Object

バックアップインスタンス

名前	型	説明
currentProtectionState	CurrentProtectionState	リソースの現在の保護状態を指定します
dataSourceInfo	Datasource	データソースデータソース情報を取得または設定します。
dataSourceSetInfo	DatasourceSet	データソースセットデータソースセットの情報を取得または設定します。
datasourceAuthCredentials	AuthCredentials: SecretStoreBasedAuthCredentials	データソースプロバイダーでの認証に使用する資格情報。
friendlyName	string	バックアップインスタンスのフレンドリ名を取得または設定します。
identityDetails	IdentityDetails	BI の ID の詳細の情報が含まれています。 null の場合、既定値はシステム割り当て済みと見なされます。
objectType	string
policyInfo	PolicyInfo	ポリシー情報ポリシー情報を取得または設定します。
protectionErrorDetails	UserFacingError	リソースの保護エラーを指定します
protectionStatus	ProtectionStatusDetails	保護状態の詳細リソースの保護状態を指定します
provisioningState	string	リソースのプロビジョニング状態 (プロビジョニング/更新/成功/失敗) を指定します。
resourceGuardOperationRequests	string[]	LAC チェックが実行される ResourceGuardOperationRequests
validationType	ValidationType	検証の種類を指定します。 DeepValidation の場合、/validateForBackup API のすべての検証が再度実行されます。

BlobBackupDatasourceParameters

Object

BLOB のバックアップの構成時に使用するパラメーター

名前	型	説明
containersList	string[]	BLOB のバックアップの構成中にバックアップするコンテナーの一覧
objectType	string: BlobBackupDatasourceParameters	特定のオブジェクトの型 - 逆シリアル化に使用されます

CloudError

Object

クラウドエラー

名前	型	説明
error	Error	リソース管理エラー応答。

CurrentProtectionState

列挙

リソースの現在の保護状態を指定します

値	説明
BackupSchedulesSuspended
ConfiguringProtection
ConfiguringProtectionFailed
Invalid
NotProtected
ProtectionConfigured
ProtectionError
ProtectionStopped
RetentionSchedulesSuspended
SoftDeleted
SoftDeleting
UpdatingProtection

Datasource

Object

データソース

名前	型	説明
datasourceType	string	リソースの DatasourceType。
objectType	string	右の継承型を初期化するために使用される Datasource オブジェクトの型
resourceID	string	リソースの完全な ARM ID。 Azure リソースの場合、これは ARM ID です。 Azure 以外のリソースの場合、これは Fabric/Vault を介してバックアップサービスによって作成された ID になります。
resourceLocation	string	データソースの場所。
resourceName	string	親のコンテキストにおけるリソースの一意識別子。
resourceProperties	BaseResourceProperties: DefaultResourceProperties	データソースに固有のプロパティ
resourceType	string	データソースのリソースの種類。
resourceUri	string	リソースの URI。

DatasourceSet

Object

データソースセット

名前	型	説明
datasourceType	string	リソースの DatasourceType。
objectType	string	右の継承型を初期化するために使用される Datasource オブジェクトの型
resourceID	string	リソースの完全な ARM ID。 Azure リソースの場合、これは ARM ID です。 Azure 以外のリソースの場合、これは Fabric/Vault を介してバックアップサービスによって作成された ID になります。
resourceLocation	string	データソースの場所。
resourceName	string	親のコンテキストにおけるリソースの一意識別子。
resourceProperties	BaseResourceProperties: DefaultResourceProperties	データソースセットに固有のプロパティ
resourceType	string	データソースのリソースの種類。
resourceUri	string	リソースの URI。

DataStoreTypes

列挙

データストアの種類。Operational/Vault/Archive

値	説明
ArchiveStore
OperationalStore
VaultStore

DefaultResourceProperties

Object

既定のソースプロパティ

名前	型	説明
objectType	string: DefaultResourceProperties	特定のオブジェクトの型 - 逆シリアル化に使用されます

Error

Object

リソース管理エラー応答。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	Error[]	エラーの詳細。
message	string	エラーメッセージ。
target	string	エラーターゲット。

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

IdentityDetails

Object

名前	型	説明
useSystemAssignedIdentity	boolean	BI がシステム ID によって保護されているかどうかを指定します。
userAssignedIdentityArmUrl	string	ユーザー割り当て ID の ARM URL。

InnerError

Object

インナーエラー

名前	型	説明
additionalInfo	object	追加の詳細情報のためにクライアントに提供できる任意のキー値ペア。
code	string	このエラーの一意のコード
embeddedInnerError	InnerError	インナーエラー入れ子を許可する子内部エラー。

KubernetesClusterBackupDatasourceParameters

Object

Kubernetes クラスターバックアップデータソースのパラメーター

名前	型	説明
backupHookReferences	NamespacedNameResource[]	バックアップフック参照を取得または設定します。このプロパティは、バックアップ中に実行されるフック参照を設定します。
excludedNamespaces	string[]	名前空間の除外プロパティを取得または設定します。このプロパティは、バックアップ中に除外する名前空間を設定します。
excludedResourceTypes	string[]	リソースの種類の除外プロパティを取得または設定します。このプロパティは、バックアップ中に除外するリソースの種類を設定します。
includeClusterScopeResources	boolean	インクルードクラスターリソースプロパティを取得または設定します。このプロパティを有効にすると、バックアップ中にクラスタースコープリソースが含まれます。
includedNamespaces	string[]	include 名前空間プロパティを取得または設定します。このプロパティは、バックアップ中に含める名前空間を設定します。
includedResourceTypes	string[]	インクルードリソースの種類プロパティを取得または設定します。このプロパティは、バックアップ中に含めるリソースの種類を設定します。
includedVolumeTypes	AKSVolumeTypes[]	インクルードボリュームの種類プロパティを取得または設定します。このプロパティは、バックアップ中に含めるボリュームの種類を設定します。
labelSelectors	string[]	LabelSelectors プロパティを取得または設定します。このプロパティは、バックアップ中に含めるラベルセレクターを含むリソースを設定します。
objectType	string: KubernetesClusterBackupDatasourceParameters	特定のオブジェクトの型 - 逆シリアル化に使用されます
snapshotVolumes	boolean	ボリュームスナップショットプロパティを取得または設定します。このプロパティを有効にすると、バックアップ中にボリュームスナップショットが取得されます。

NamespacedNameResource

Object

名前空間名リソース

名前	型	説明
name	string	リソースの名前
namespace	string	リソースが存在する名前空間

OperationJobExtendedInfo

Object

OperationJobExtendedInfo (オペレーションジョブ拡張情報)

名前	型	説明
jobId	string	この操作用に作成されたジョブの名前または Arm ID。
objectType	string: OperationJobExtendedInfo	このプロパティは、型のポリモーフィックチェーン内の特定の型を決定するための識別子として使用されます。

PolicyInfo

Object

ポリシー情報

名前	型	説明
policyId	string
policyParameters	PolicyParameters	バックアップインスタンスのポリシーパラメーター
policyVersion	string

PolicyParameters

Object

ポリシーのパラメーター

名前	型	説明
backupDatasourceParametersList	BackupDatasourceParameters[]: AdlsBlobBackupDatasourceParameters[] BlobBackupDatasourceParameters[] KubernetesClusterBackupDatasourceParameters[]	バックアップデータソースパラメーターを取得または設定します。
dataStoreParametersList	DataStoreParameters[]: AzureOperationalStoreParameters[]	データストアパラメーターを取得または設定します。

ProtectionStatusDetails

Object

保護状態の詳細

名前	型	説明
errorDetails	UserFacingError	リソースの保護状態エラーを指定します
status	Status	リソースの保護状態を指定します

SecretStoreBasedAuthCredentials

Object

シークレットストアベースの認証資格情報。

名前	型	説明
objectType	string: SecretStoreBasedAuthCredentials	特定のオブジェクトの型 - 逆シリアル化に使用されます
secretStoreResource	SecretStoreResource	シークレットストアリソース

SecretStoreResource

Object

シークレットストアリソースを表すクラス。

名前	型	説明
secretStoreType	SecretStoreType	シークレットストアの種類を取得または設定します。
uri	string	リソースに取得する URI
value	string	シークレットストアリソースに格納されている値を取得または設定します。

SecretStoreType

列挙

シークレットストアの種類を取得または設定します。

値	説明
AzureKeyVault
Invalid

Status

列挙

リソースの保護状態を指定します

値	説明
ConfiguringProtection
ConfiguringProtectionFailed
ProtectionConfigured
ProtectionStopped
SoftDeleted
SoftDeleting

UserFacingError

Object

ローカライズされたコンテンツにアクセスし、ユーザーに伝達するレイヤーによって使用されるエラーオブジェクト

名前	型	説明
code	string	このエラーの一意のコード
details	UserFacingError[]	その他の関連エラー
innerError	InnerError	インナーエラー内部エラー
isRetryable	boolean	操作が再試行可能かどうか
isUserError	boolean	操作の原因がユーザーエラーかサービスエラーか
message	string
properties	object	エラーオブジェクト内に挿入できる任意のキー値ペア
recommendedAction	string[]	RecommendedAction がローカライズされました。
target	string	エラーのターゲットです。

ValidateForBackupRequest

Object

ValidateForBackupRequest (英語)

名前	型	説明
backupInstance	BackupInstance	バックアップインスタンス

ValidationType

列挙

検証の種類を指定します。 DeepValidation の場合、/validateForBackup API のすべての検証が再度実行されます。

値	説明
DeepValidation
ShallowValidation

次の方法で共有

Backup Instances - Validate For Backup

URI パラメーター

要求本文

応答

セキュリティ

azure_auth

スコープ

例

Validate For Backup

要求のサンプル

応答のサンプル

定義

AdlsBlobBackupDatasourceParameters

AKSVolumeTypes

AzureOperationalStoreParameters

BackupInstance

BlobBackupDatasourceParameters

CloudError

CurrentProtectionState

Datasource

DatasourceSet

DataStoreTypes

DefaultResourceProperties

Error

ErrorAdditionalInfo

IdentityDetails

InnerError

KubernetesClusterBackupDatasourceParameters

NamespacedNameResource

OperationJobExtendedInfo

PolicyInfo

PolicyParameters

ProtectionStatusDetails

SecretStoreBasedAuthCredentials

SecretStoreResource

SecretStoreType

Status

UserFacingError

ValidateForBackupRequest

ValidationType