Compartilhar via

az datafactory linked-service

  • Referência

Observação

Essa referência faz parte da extensão datafactory para a CLI do Azure (versão 2.15.0 ou superior). A extensão será instalada automaticamente na primeira vez que você executar um comando az datafactory linked-service . Saiba mais sobre extensões.

Gerencie o serviço vinculado com o datafactory.

Comandos

Nome Description Tipo Status
az datafactory linked-service create

Crie um serviço vinculado.

 Extensão GA
az datafactory linked-service delete

Exclui um serviço vinculado.

 Extensão GA
az datafactory linked-service list

Lista os serviços vinculados.

 Extensão GA
az datafactory linked-service show

Obtém um serviço vinculado.

 Extensão GA
az datafactory linked-service update

Atualizar um serviço vinculado.

 Extensão GA

az datafactory linked-service create

Crie um serviço vinculado.

az datafactory linked-service create --factory-name
                                     --linked-service-name
                                     --properties
                                     --resource-group
                                     [--if-match]

Exemplos

LinkedServices_Create

az datafactory linked-service create --factory-name "exampleFactoryName" --properties "{\"type\":\"AzureStorage\",\"typeProperties\":{\"connectionString\":{\"type\":\"SecureString\",\"value\":\"DefaultEndpointsProtocol=https;AccountName=examplestorageaccount;AccountKey=<storage key>\"}}}" --name "exampleLinkedService" --resource-group "exampleResourceGroup"

Parâmetros Exigidos

--factory-name

O nome da fábrica.

--linked-service-name --name -n

O nome do serviço vinculado.

--properties

Propriedades do serviço vinculado. Valor esperado: json-string/json-file/@json-file.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Opcionais

--if-match

ETag da entidade linkedService. Deve ser especificado apenas para atualização, para a qual deve corresponder à entidade existente ou pode ser * para atualização incondicional.

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az datafactory linked-service delete

Exclui um serviço vinculado.

az datafactory linked-service delete [--factory-name]
                                     [--ids]
                                     [--linked-service-name]
                                     [--resource-group]
                                     [--subscription]
                                     [--yes]

Exemplos

LinkedServices_Delete

az datafactory linked-service delete --factory-name "exampleFactoryName" --name "exampleLinkedService" --resource-group "exampleResourceGroup"

Parâmetros Opcionais

--factory-name

O nome da fábrica.

--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'Resource Id'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

--linked-service-name --name -n

O nome do serviço vinculado.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--yes -y

Não solicite confirmação.

valor padrão: False
Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az datafactory linked-service list

Lista os serviços vinculados.

az datafactory linked-service list --factory-name
                                   --resource-group

Exemplos

LinkedServices_ListByFactory

az datafactory linked-service list --factory-name "exampleFactoryName" --resource-group "exampleResourceGroup"

Parâmetros Exigidos

--factory-name

O nome da fábrica.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az datafactory linked-service show

Obtém um serviço vinculado.

az datafactory linked-service show [--factory-name]
                                   [--ids]
                                   [--if-none-match]
                                   [--linked-service-name]
                                   [--resource-group]
                                   [--subscription]

Exemplos

LinkedServices_Get

az datafactory linked-service show --factory-name "exampleFactoryName" --name "exampleLinkedService" --resource-group "exampleResourceGroup"

Parâmetros Opcionais

--factory-name

O nome da fábrica.

--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'Resource Id'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

--if-none-match

ETag da entidade de serviço vinculada. Só deve ser especificado para obter. Se o ETag corresponder à tag de entidade existente, ou se * foi fornecido, nenhum conteúdo será retornado.

--linked-service-name --name -n

O nome do serviço vinculado.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az datafactory linked-service update

Atualizar um serviço vinculado.

az datafactory linked-service update [--add]
                                     [--annotations]
                                     [--connect-via]
                                     [--description]
                                     [--factory-name]
                                     [--force-string]
                                     [--ids]
                                     [--if-match]
                                     [--if-none-match]
                                     [--linked-service-name]
                                     [--parameters]
                                     [--remove]
                                     [--resource-group]
                                     [--set]
                                     [--subscription]

Parâmetros Opcionais

--add

Adicione um objeto a uma lista de objetos especificando um caminho e pares de valores de chave. Exemplo: --add property.listProperty <key=value, string or JSON string>.

valor padrão: []
--annotations

Lista de tags que podem ser usadas para descrever o serviço vinculado. Valor esperado: json-string/json-file/@json-file.

--connect-via

A referência de runtime de integração. Valor esperado: json-string/json-file/@json-file.

--description

Descrição do serviço vinculado.

--factory-name

O nome da fábrica.

--force-string

Ao usar 'set' ou 'add', preserve literais de cadeia de caracteres em vez de tentar converter para JSON.

valor padrão: False
--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'Resource Id'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

--if-match

ETag da entidade linkedService. Deve ser especificado apenas para atualização, para a qual deve corresponder à entidade existente ou pode ser * para atualização incondicional.

--if-none-match

ETag da entidade de serviço vinculada. Só deve ser especificado para obter. Se o ETag corresponder à tag de entidade existente, ou se * foi fornecido, nenhum conteúdo será retornado. O valor padrão é Nenhum.

--linked-service-name --name -n

O nome do serviço vinculado.

--parameters

Parâmetros para serviço vinculado. Valor esperado: json-string/json-file/@json-file.

--remove

Remova uma propriedade ou um elemento de uma lista. Exemplo: --remove property.list <indexToRemove> OU --remove propertyToRemove.

valor padrão: []
--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--set

Atualize um objeto especificando um caminho de propriedade e um valor a serem definidos. Exemplo: --set property1.property2=<value>.

valor padrão: []
--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.