CreateLocationAzureBlob - AWS DataSync

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

CreateLocationAzureBlob

Microsoft Azure Blob Storage コンテナの転送場所を作成します。この場所を転送元または転送先として AWS DataSync 使用できます。コンテナに接続する DataSync エージェントの有無にかかわらず、転送を行うことができます。

始める前に、必ず DataSync がどのように Azure Blob Storage にアクセスし、アクセス層BLOB タイプで動作するかを確認しておいてください。

リクエストの構文

{ "AccessTier": "string", "AgentArns": [ "string" ], "AuthenticationType": "string", "BlobType": "string", "CmkSecretConfig": { "KmsKeyArn": "string", "SecretArn": "string" }, "ContainerUrl": "string", "CustomSecretConfig": { "SecretAccessRoleArn": "string", "SecretArn": "string" }, "SasConfiguration": { "Token": "string" }, "Subdirectory": "string", "Tags": [ { "Key": "string", "Value": "string" } ] }

リクエストパラメーター

すべてのアクションに共通のパラメータの詳細については、「共通パラメータ」を参照してください。

リクエストは以下のデータを JSON 形式で受け入れます。

AccessTier

オブジェクトまたはファイルの転送先となるアクセス層を指定します。これは、その場所を転送先として使用する場合にのみ適用されます。詳細については、「アクセス層」を参照してください。

タイプ: 文字列

有効な値:HOT | COOL | ARCHIVE

必須:いいえ

AgentArns

(オプション) Azure Blob Storage コンテナに接続できる DataSync エージェントの Amazon リソースネーム (ARN) を指定します。エージェントレスクロスクラウド転送を設定する場合は、このパラメータの値を指定する必要はありません。

複数のエージェントを指定できます。詳細については、「複数のエージェントを転送に使用」を参照してください。

注記

このパラメータは、最初にストレージの場所を作成するときに正しく設定してください。作成後は、ストレージの場所からエージェントを追加または削除することはできません。

型: 文字列の配列

配列メンバー: 最小数は 1 項目です。最大数は 4 項目です。

長さの制約: 最大長は 128 です。

パターン: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$

必須: いいえ

AuthenticationType

DataSync が Azure Blob Storage にアクセスするために使用する認証方法を指定します。DataSync は、共有アクセス署名 (SAS) を使用して blob storage にアクセスできます。

タイプ: 文字列

有効な値:SAS | NONE

必須: はい

BlobType

オブジェクトまたはファイルを Azure Blob Storage に転送するときに使用する BLOB のタイプを指定します。現在、DataSync は、ブロック blobs としての Azure Blob Storage へのデータの移動のみをサポートしています。BLOB のタイプの詳細については、「Azure Blob Storage のドキュメント」を参照してください。

タイプ: 文字列

有効な値:BLOCK

必須:いいえ

CmkSecretConfig

DataSync が管理するシークレットの設定情報を指定します。これには、DataSync がカスタマー管理の特定の AzureBlob ストレージロケーションにアクセスするために使用する認証トークンが含まれます AWS KMS key。

このパラメータをCreateLocationAzureBlobリクエストの一部として含める場合は、KMS キー ARN のみを指定します。DataSync は、この KMS キーを、 に指定した認証トークンとともに使用SasConfigurationして、ロケーションアクセス認証情報を保存する DataSync マネージドシークレットを作成します。

DataSync に、指定した KMS キーへのアクセス許可があることを確認します。

注記

( CmkSecretConfigを使用SasConfiguration) または CustomSecretConfig ( を使用せずにSasConfiguration) を使用して、CreateLocationAzureBlobリクエストの認証情報を指定できます。同じリクエストに対して両方のパラメータを指定しないでください。

型: CmkSecretConfig オブジェクト

必須: いいえ

ContainerUrl

転送に含まれる Azure Blob Storage コンテナの URL を指定します。

タイプ: 文字列

長さの制約: 最大長は 325 です。

パターン: ^https:\/\/[A-Za-z0-9]((\.|-+)?[A-Za-z0-9]){0,252}\/[a-z0-9](-?[a-z0-9]){2,62}$

必須: はい

CustomSecretConfig

AzureBlob ストレージロケーションの認証トークンがプレーンテキストで保存される、カスタマー管理の Secrets Manager シークレットの設定情報を指定します。この設定には、シークレット ARN、およびシークレットへのアクセスを提供する IAM ロールの ARN が含まれます。

注記

( CmkSecretConfigを使用SasConfiguration) または CustomSecretConfig ( を使用せずにSasConfiguration) を使用して、CreateLocationAzureBlobリクエストの認証情報を指定できます。同じリクエストに対して両方のパラメータを指定しないでください。

型: CustomSecretConfig オブジェクト

必須: いいえ

SasConfiguration

DataSync を Azure Blob Storage にアクセスできるようにする SAS 設定を指定します。

注記

を使用して認証トークンを提供しSasConfigurationCmkSecretConfigまたは を使用してシークレット設定の詳細を指定しない場合CustomSecretConfig、DataSync は AWS アカウントのシークレットマネージャーシークレットを使用してトークンを保存します。

型: AzureBlobSasConfiguration オブジェクト

必須: いいえ

Subdirectory

転送をコンテナ内の仮想ディレクトリ (例: /my/images) に制限する場合は、パスセグメントを指定します。

タイプ: 文字列

長さの制約: 最大長は 1,024 です。

パターン: ^[\p{L}\p{M}\p{Z}\p{S}\p{N}\p{P}\p{C}]*$

必須: いいえ

Tags

AWS リソースの分類、フィルタリング、および検索に役立つラベルを指定します。少なくても転送場所の名前タグを作成することを推奨します。

タイプ: TagListEntry オブジェクトの配列

配列メンバー: 最小数は 0 項目です。最大数は 50 項目です。

必須: いいえ

レスポンスの構文

{ "LocationArn": "string" }

レスポンス要素

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

サービスから以下のデータが JSON 形式で返されます。

LocationArn

作成した Azure Blob Storage の転送場所の ARN。

タイプ: 文字列

長さの制約: 最大長は 128 です。

パターン: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$

エラー

すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。

InternalException

この例外は、 AWS DataSync サービスでエラーが発生した場合にスローされます。

HTTP ステータスコード: 500

InvalidRequestException

この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。

HTTP ステータスコード: 400

以下の資料も参照してください。

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。