CreateLocationAzureBlob - DataSync AWS
Sintaxe da SolicitaçãoParâmetros da solicitaçãoSintaxe da RespostaElementos de RespostaErrosConsulte Também

CreateLocationAzureBlob

Cria um local de transferência para um contêiner do Microsoft Azure Blob Storage. O AWS DataSync pode usar esse local como origem ou destino da transferência. Você pode fazer transferências com ou sem um atendente do DataSync que se conecta ao contêiner.

Antes de começar, certifique-se de saber como o DataSync acessa o Azure Blob Storage e trabalha com níveis de acesso e tipos de blob

Sintaxe da Solicitação

{
   "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"
      }
   ]
}

Parâmetros da solicitação

Para obter informações sobre os parâmetros que são comuns em todas as ações, consulte Parâmetros comuns.

A solicitação aceita os dados a seguir no formato JSON.

AccessTier

Especifica o nível de acesso para o qual deseja que seus objetos ou arquivos sejam transferidos. Isso só se aplica ao usar o local como destino de transferência. Para obter mais informações, consulte Níveis de acesso.

Tipo: String

Valores válidos: HOT | COOL | ARCHIVE

Obrigatório: Não

AgentArns

(Opcional) Especifica o nome do recurso da Amazon (ARN) do agente do DataSync que pode se conectar ao contêiner do Azure Blob Storage. Se você estiver configurando uma transferência entre nuvens sem atendente, não precisará especificar um valor para esse parâmetro.

Você pode especificar mais de um atendente. Para obter mais informações, consulte Utilizar vários agentes para sua transferência.

nota

Certifique-se de configurar esse parâmetro corretamente ao criar ao local de armazenamento pela primeira vez. Você não pode adicionar ou remover atendentes de um local de armazenamento depois de criá-lo.

Tipo: matriz de strings

Membros da matriz: número mínimo de 1 item. Número máximo de 4 itens.

Restrições de Tamanho: Tamanho máximo de 128.

Padrão: : ^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}$

Obrigatório: Não

AuthenticationType

Especifica o método de autenticação que o DataSync usa para acessar o Armazenamento de Blobs do Azure. O DataSync pode acessar o armazenamento de blobs usando uma assinatura de acesso compartilhado (SAS).

Tipo: String

Valores Válidos: SAS | NONE

Obrigatório: Sim

BlobType

Especifica o tipo de blob que você deseja que seus objetos ou arquivos sejam ao transferi-los para o Armazenamento de Blobs do Azure. Atualmente, o DataSync só dá suporte à movimentação de dados para o Armazenamento de Blobs do Azure como blobs de blocos. Para obter mais informações sobre os tipos de blob, consulte a Documentação do armazenamento de blobs do Azure.

Tipo: String

Valores válidos: BLOCK

Obrigatório: Não

CmkSecretConfig

Especifica as informações de configuração para um segredo gerenciado pelo DataSync, que inclui o token de autenticação que o DataSync usa para acessar um local de armazenamento específico do AzureBlob, com um AWS KMS key gerenciado pelo cliente.

Ao incluir esse parâmetro como parte de uma solicitação CreateLocationAzureBlob, você fornece somente o ARN da chave KMS. O DataSync usa essa chave KMS junto com o token de autenticação que você especificou para SasConfiguration ao criar um segredo gerenciado pelo DataSync para armazenar as credenciais de acesso ao local.

Certifique-se de que o DataSync tenha permissão para acessar a chave KMS que você especificar.

nota

Você pode usar CmkSecretConfig (com SasConfiguration) ou CustomSecretConfig (sem SasConfiguration) para fornecer credenciais para uma solicitação CreateLocationAzureBlob. Não forneça os dois parâmetros para a mesma solicitação.

Tipo: objeto CmkSecretConfig

Obrigatório: Não

ContainerUrl

Especifica a URL do contêiner de Armazenamento de Blobs do Azure envolvido na transferência.

Tipo: String

Restrições de tamanho: tamanho máximo de 325.

Padrão: : ^https:\/\/[A-Za-z0-9]((\.|-+)?[A-Za-z0-9]){0,252}\/[a-z0-9](-?[a-z0-9]){2,62}$

Exigido: Sim

CustomSecretConfig

Especifica as informações de configuração para um segredo do Secrets Manager gerenciado pelo cliente em que o token de autenticação de um local de armazenamento do AzureBlob é armazenado em texto simples. Essa configuração inclui o ARN secreto e o ARN de um perfil do IAM que fornece acesso ao segredo.

nota

Você pode usar CmkSecretConfig (com SasConfiguration) ou CustomSecretConfig (sem SasConfiguration) para fornecer credenciais para uma solicitação CreateLocationAzureBlob. Não forneça os dois parâmetros para a mesma solicitação.

Tipo: objeto CustomSecretConfig

Obrigatório: Não

SasConfiguration

Especifica a configuração SAS que permite que o DataSync acesse o Armazenamento de Blobs do Azure.

nota

Se você fornecer um token de autenticação usando SasConfiguration, mas não fornecer detalhes de configuração secreta usando CmkSecretConfig ouCustomSecretConfig, o DataSync armazenará o token usando o segredo do Secrets Manager da conta AWS.

Tipo: objeto AzureBlobSasConfiguration

Obrigatório: Não

Subdirectory

Especifica segmentos de caminho se você quiser limitar a transferência para um diretório virtual no contêiner (por exemplo, /my/images).

Tipo: String

Restrições de comprimento: comprimento máximo de 1024.

Padrão: : ^[\p{L}\p{M}\p{Z}\p{S}\p{N}\p{P}\p{C}]*$

Obrigatório: Não

Tags

Especifica rótulos que ajudam você a categorizar, filtrar e pesquisar seus recursos da AWS. Recomendamos criar pelo menos uma etiqueta de nome para seu local de transferência.

Tipo: matriz de objetos TagListEntry

Membros da Matriz: número mínimo de 0 itens. Número máximo de 50 itens.

Obrigatório: Não

Sintaxe da Resposta

{
   "LocationArn": "string"
}

Elementos de Resposta

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

LocationArn

O ARN do local de transferência do Armazenamento de Blobs do Azure que você criou.

Tipo: String

Restrições de tamanho: tamanho máximo de 128.

Padrão: : ^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}$

Erros

Para obter informações sobre os erros comuns que todas as ações retornam, consulte Erros comuns.

InternalException

Essa exceção é lançada quando ocorre um erro no serviço AWS DataSync.

Código de Status HTTP: 500

InvalidRequestException

Essa exceção é lançada quando o cliente envia uma solicitação malformada.

Código de Status HTTP: 400

Consulte Também

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte: