Backup Instances - Validate For Backup

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

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

URI パラメーター

名前 / 必須 説明
resourceGroupName
path True

string

リソース グループの名前。 名前の大文字と小文字は区別されます。

subscriptionId
path True

string

uuid

ターゲット サブスクリプションの ID。 値は UUID である必要があります。

vaultName
path True

string

バックアップ コンテナーの名前。

api-version
query True

string

この操作に使用する API バージョン。

要求本文

名前 必須 説明
backupInstance True

BackupInstance

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

応答

名前 説明
200 OK

OperationJobExtendedInfo

ジョブ ID などの追加情報が含まれています

202 Accepted

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

Headers

  • Location: string
  • Azure-AsyncOperation: string
  • Retry-After: integer
Other Status Codes

CloudError

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

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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

Scopes

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

Validate For Backup

Sample Request

POST https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/validateForBackup?api-version=2023-01-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"
    }
  }
}

Sample Response

Location: https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-01-01
Azure-AsyncOperation: https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-01-01
Retry-After: 60
{
  "jobId": "c60cb49-63e8-4b21-b9bd-26277b3fdfae",
  "objectType": "OperationJobExtendedInfo"
}

定義

名前 説明
AzureOperationalStoreParameters

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

BackupInstance

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

BlobBackupDatasourceParameters

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

CloudError

CloudError

CurrentProtectionState

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

Datasource

データソース

DatasourceSet

DatasourceSet

DataStoreTypes

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

Error

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

ErrorAdditionalInfo

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

InnerError

InnerError

KubernetesClusterBackupDatasourceParameters

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

OperationJobExtendedInfo

OperationJobExtendedInfo

PolicyInfo

PolicyInfo

PolicyParameters

Policy のパラメーター

ProtectionStatusDetails

保護の状態の詳細

SecretStoreBasedAuthCredentials

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

SecretStoreResource

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

SecretStoreType

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

Status

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

UserFacingError

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

ValidateForBackupRequest

ValidateForBackupRequest

ValidationType

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

AzureOperationalStoreParameters

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

名前 説明
dataStoreType

DataStoreTypes

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

objectType string:

AzureOperationalStoreParameters

特定のオブジェクトの型 - 逆シリアル化に使用されます

resourceGroupId

string

スナップショット リソース グループ URI を取得または設定します。

BackupInstance

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

名前 説明
currentProtectionState

CurrentProtectionState

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

dataSourceInfo

Datasource

データソース
データ ソース情報を取得または設定します。

dataSourceSetInfo

DatasourceSet

DatasourceSet
データ ソース セットの情報を取得または設定します。

datasourceAuthCredentials AuthCredentials:

SecretStoreBasedAuthCredentials

データ ソース プロバイダーでの認証に使用する資格情報。

friendlyName

string

バックアップ インスタンスのフレンドリ名を取得または設定します。

objectType

string

policyInfo

PolicyInfo

PolicyInfo
ポリシー情報を取得または設定します。

protectionErrorDetails

UserFacingError

リソースの保護エラーを指定します

protectionStatus

ProtectionStatusDetails

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

provisioningState

string

リソースのプロビジョニング状態 (プロビジョニング/更新/成功/失敗) を指定します

validationType

ValidationType

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

BlobBackupDatasourceParameters

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

名前 説明
containersList

string[]

BLOB のバックアップの構成中にバックアップするコンテナーの一覧

objectType string:

BlobBackupDatasourceParameters

特定のオブジェクトの型 - 逆シリアル化に使用されます

CloudError

CloudError

名前 説明
error

Error

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

CurrentProtectionState

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

名前 説明
BackupSchedulesSuspended

string

ConfiguringProtection

string

ConfiguringProtectionFailed

string

Invalid

string

NotProtected

string

ProtectionConfigured

string

ProtectionError

string

ProtectionStopped

string

RetentionSchedulesSuspended

string

SoftDeleted

string

SoftDeleting

string

UpdatingProtection

string

Datasource

データソース

名前 説明
datasourceType

string

リソースの DatasourceType。

objectType

string

右の継承された型を初期化するために使用される Datasource オブジェクトの型

resourceID

string

リソースの完全な ARM ID。 Azure リソースの場合、これは ARM ID です。 Azure 以外のリソースの場合、これは Fabric/Vault を介してバックアップ サービスによって作成された ID になります。

resourceLocation

string

データソースの場所。

resourceName

string

親のコンテキスト内のリソースの一意識別子。

resourceType

string

データソースのリソースの種類。

resourceUri

string

リソースの URI。

DatasourceSet

DatasourceSet

名前 説明
datasourceType

string

リソースの DatasourceType。

objectType

string

右の継承された型を初期化するために使用される Datasource オブジェクトの型

resourceID

string

リソースの完全な ARM ID。 Azure リソースの場合、これは ARM ID です。 Azure 以外のリソースの場合、これは Fabric/Vault を介してバックアップ サービスによって作成された ID になります。

resourceLocation

string

データソースの場所。

resourceName

string

親のコンテキスト内のリソースの一意識別子。

resourceType

string

データソースのリソースの種類。

resourceUri

string

リソースの URI。

DataStoreTypes

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

名前 説明
ArchiveStore

string

OperationalStore

string

VaultStore

string

Error

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

名前 説明
additionalInfo

ErrorAdditionalInfo[]

エラーの追加情報。

code

string

エラー コード。

details

Error[]

エラーの詳細です。

message

string

エラー メッセージ。

target

string

エラーのターゲット。

ErrorAdditionalInfo

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

名前 説明
info

object

追加情報。

type

string

追加情報の種類。

InnerError

InnerError

名前 説明
additionalInfo

object

詳細な情報を追加するためにクライアントに提供できる任意のキー値ペア。

code

string

このエラーの一意のコード

embeddedInnerError

InnerError

InnerError
入れ子を許可する子内部エラー。

KubernetesClusterBackupDatasourceParameters

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

名前 説明
excludedNamespaces

string[]

名前空間の除外プロパティを取得または設定します。 このプロパティは、復元時に除外する名前空間を設定します。

excludedResourceTypes

string[]

リソースの種類を除外するプロパティを取得または設定します。 このプロパティは、復元中に除外するリソースの種類を設定します。

includeClusterScopeResources

boolean

インクルード クラスター リソース プロパティを取得または設定します。 このプロパティを有効にすると、復元中にクラスター スコープ リソースが含まれます。

includedNamespaces

string[]

include namespaces プロパティを取得または設定します。 このプロパティは、復元時に含める名前空間を設定します。

includedResourceTypes

string[]

インクルード リソースの種類プロパティを取得または設定します。 このプロパティは、復元時に含めるリソースの種類を設定します。

labelSelectors

string[]

LabelSelectors プロパティを取得または設定します。 このプロパティは、復元時に含めるラベル セレクターを含むリソースを設定します。

objectType string:

KubernetesClusterBackupDatasourceParameters

特定のオブジェクトの型 - 逆シリアル化に使用されます

snapshotVolumes

boolean

ボリューム スナップショット プロパティを取得または設定します。 このプロパティを有効にすると、復元中にボリューム スナップショットが取得されます。

OperationJobExtendedInfo

OperationJobExtendedInfo

名前 説明
jobId

string

この操作用に作成されたジョブの Arm ID。

objectType string:

OperationJobExtendedInfo

このプロパティは、型のポリモーフィック チェーン内の特定の型を決定するための識別子として使用されます。

PolicyInfo

PolicyInfo

名前 説明
policyId

string

policyParameters

PolicyParameters

バックアップ インスタンスのポリシー パラメーター

policyVersion

string

PolicyParameters

Policy のパラメーター

名前 説明
backupDatasourceParametersList BackupDatasourceParameters[]:

バックアップ データ ソース パラメーターを取得または設定します

dataStoreParametersList DataStoreParameters[]:

AzureOperationalStoreParameters[]

DataStore パラメーターを取得または設定します

ProtectionStatusDetails

保護の状態の詳細

名前 説明
errorDetails

UserFacingError

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

status

Status

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

SecretStoreBasedAuthCredentials

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

名前 説明
objectType string:

SecretStoreBasedAuthCredentials

特定のオブジェクトの型 - 逆シリアル化に使用されます

secretStoreResource

SecretStoreResource

シークレット ストア リソース

SecretStoreResource

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

名前 説明
secretStoreType

SecretStoreType

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

uri

string

リソースに取得する URI

value

string

シークレット ストア リソースに格納されている値を取得または設定します

SecretStoreType

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

名前 説明
AzureKeyVault

string

Invalid

string

Status

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

名前 説明
ConfiguringProtection

string

ConfiguringProtectionFailed

string

ProtectionConfigured

string

ProtectionStopped

string

SoftDeleted

string

SoftDeleting

string

UserFacingError

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

名前 説明
code

string

このエラーの一意のコード

details

UserFacingError[]

その他の関連エラー

innerError

InnerError

InnerError
内部エラー

isRetryable

boolean

操作が再試行可能かどうか

isUserError

boolean

操作がユーザー エラーまたはサービス エラーによるものかどうか

message

string

properties

object

エラー オブジェクト内に挿入できるキー値のペア

recommendedAction

string[]

RecommendedAction がローカライズされました。

target

string

エラーのターゲット。

ValidateForBackupRequest

ValidateForBackupRequest

名前 説明
backupInstance

BackupInstance

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

ValidationType

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

名前 説明
DeepValidation

string

ShallowValidation

string