次の方法で共有


REST API を使用して Azure Backup コンテナーを作成する

この記事では、REST API を使用して Backup コンテナー を作成する方法について説明します。 Azure portal を使用して Backup コンテナーを作成することもできます。

Azure Backup の新しい Data Protection プラットフォームでは、ストレージ アカウント内の BLOB、マネージド ディスク、PostgreSQL サーバーの PaaS プラットフォームなど、より新しいワークロードのバックアップと復元の機能が強化されています。 バックアップの整理を容易にしながら、管理オーバーヘッドを最小限に抑えることを目的としています。 "バックアップ コンテナー" は Data Protection プラットフォームの基盤であり、"Recovery Services" コンテナーとは異なります。

REST API を使用して Azure Backup コンテナーを作成する手順の概要は、コンテナー作成 REST API に関するドキュメントで説明されています。 このドキュメントを参考にして、West USTestBkpVaultRG リソース グループの下に testBkpVault という名前のコンテナーを作成してみましょう。

Azure Backup コンテナーを作成または更新するには、次の PUT 操作を使用します。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/testBkpVault?api-version=2021-01-01

要求を作成する

PUT 要求を作成するには、{subscription-id} パラメーターが必要です。 複数のサブスクリプションをお持ちの場合は、Working with multiple subscriptionsを参照してください。 リソースの {resourceGroupName}{vaultName}api-version パラメーターと共に定義します。 この記事では、api-version=2021-01-01 を使用します。

次のヘッダーは必須です。

要求ヘッダー 説明
Content-Type: 必須。 application/json を設定します。
認証: 必須。 有効な Bearer アクセス トークンを設定します。

要求の作成方法の詳細については、「Components of a REST API request/response」(REST API 要求/応答のコンポーネント) を参照してください。

要求本文を作成する

要求本文を作成するには、以下の一般的な定義が使用されます。

名前 必須 タイプ 説明
eタグ 省略可能な eTag
位置 ほんとう リソースの場所
プロパティ ほんとう BackupVault コンテナーのプロパティ
ID DPPIdentityDetails 各 Azure リソースの一意のシステム ID を示します
tags オブジェクト リソース タグ

コンテナー名とリソース グループ名は PUT URI で提供することに注意してください。 要求本文では場所を定義します。

要求本文の例

次の例の本文は、"West US" にコンテナーを作成するために使用されています。 場所を指定します。

{
  "location": "WestUS",
  "tags": {
    "key1": "val1"
  },
  "identity": {
    "type": "None"
  },
  "properties": {
    "storageSettings": [
      {
        "datastoreType": "VaultStore",
        "type": "LocallyRedundant"
      }
    ]
  }
}

バックアップ コンテナーを作成し、システム割り当て ID も生成する場合は、次の要求本文を指定する必要があります。

{
  "location": "WestUS",
  "tags": {
    "key1": "val1"
  },
  "identity": {
    "type": "systemAssigned"
  },
  "properties": {
    "storageSettings": [
      {
        "datastoreType": "VaultStore",
        "type": "LocallyRedundant"
      }
    ]
  }
}

Responses

バックアップ コンテナーの作成は、非同期操作です。 つまり、この操作では、個別に追跡する必要がある別の操作が作成されます。 バックアップ コンテナーの作成または更新操作には、次の 2 種類の成功応答があります。

名前 タイプ 説明
200 OK(正常に処理されました) BackupVaultResource [OK]
201 作成済み BackupVaultResource 作成済み
その他の状態コード CloudError

REST API の応答の詳細については、「Process the response message」(応答メッセージを処理する) を参照してください。

応答の例

前の要求本文の例からの圧縮された 201 Created 応答では、id が割り当てられ、provisioningStateSucceeded であることが示されています。

{
    "eTag": null,
    "id": "/subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/TestBkpVaultRG/providers/Microsoft.DataProtection/BackupVaults/testBkpVault",
    "identity": {
      "principalId": "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "tenantId": "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "type": "SystemAssigned"
    },
    "location": "westUS",
    "name": "testBkpVault",
    "properties": {
      "provisioningState": "Succeeded",
      "storageSettings": [
        {
          "datastoreType": "VaultStore",
          "type": "GeoRedundant"
        }
      ]
    },
    "resourceGroup": "TestBkpVaultRG",
    "systemData": null,
    "tags": {},
    "type": "Microsoft.DataProtection/backupVaults"
  }

次のステップ

このコンテナー内の BLOB をバックアップするためのバックアップ ポリシーを作成します

Azure REST API について詳しくは、次のドキュメントをご覧ください。