Partilhar via

az apic integration create

  • Pré-visualizar
  • Referência

Observação

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

O grupo de comando 'az apic integration' está em pré-visualização e em desenvolvimento. Níveis de referência e apoio: https://aka.ms/CLI_refstatus

Comandos

Name Description Tipo Status
az apic integration create apim

Adicione a API do Azure como uma fonte de API.

 Extensão Previsualizar
az apic integration create aws

Adicione o Amazon API Gateway como uma fonte de API.

 Extensão Previsualizar

az apic integration create apim

Pré-visualizar

O grupo de comando 'az apic integration' está em pré-visualização e em desenvolvimento. Níveis de referência e apoio: https://aka.ms/CLI_refstatus

Adicione a API do Azure como uma fonte de API.

az apic integration create apim --azure-apim
                                --integration-name
                                --resource-group
                                --service-name
                                [--import-specification {always, never, ondemand}]
                                [--msi-resource-id]
                                [--target-environment-id]
                                [--target-lifecycle-stage {deprecated, design, development, preview, production, retired, testing}]

Exemplos

Adicionar a API do Azure no mesmo grupo de recursos que a instância do Centro de API do Azure como uma fonte de API

az apic integration create apim -g contoso-resources -n contoso -i sync-from-my-apim --azure-apim myapim

Adicionar API do Azure em outro grupo de recursos como uma fonte de API

az apic integration create apim -g contoso-resources -n contoso -i sync-from-my-apim --azure-apim /subscriptions/12345678-1234-1234-1234-123456789abc/resourceGroups/samplegroup/providers/Microsoft.ApiManagement/service/sampleapim

Parâmetros Obrigatórios

--azure-apim

O nome ou id do recurso da instância APIM de origem.

--integration-name -i

O nome da integração.

--resource-group -g

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

--service-name -n

O nome do serviço Central de API do Azure.

Parâmetros Opcionais

--import-specification

Indica se a especificação deve ser importada junto com metadados.

Valores aceites: always, never, ondemand
Default value: always
--msi-resource-id

A ID do recurso da identidade gerenciada que tem acesso à instância de Gerenciamento de API.

--target-environment-id

O ID do recurso do ambiente de destino.

--target-lifecycle-stage

O estágio do ciclo de vida de destino.

Valores aceites: deprecated, design, development, preview, production, retired, testing
Parâmetros de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

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

--subscription

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

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az apic integration create aws

Pré-visualizar

O grupo de comando 'az apic integration' está em pré-visualização e em desenvolvimento. Níveis de referência e apoio: https://aka.ms/CLI_refstatus

Adicione o Amazon API Gateway como uma fonte de API.

az apic integration create aws --aws-access-key-reference
                               --aws-region-name
                               --aws-secret-access-key-reference
                               --integration-name
                               --resource-group
                               --service-name
                               [--import-specification {always, never, ondemand}]
                               [--msi-resource-id]
                               [--target-environment-id]
                               [--target-lifecycle-stage {deprecated, design, development, preview, production, retired, testing}]

Exemplos

Adicionar o Amazon API Gateway como uma fonte de API

az apic integration create aws -g contoso-resources -n contoso -i sync-from-my-amazon-api-gateway -a https://{keyvaultName}.vault.azure.net/secrets/{secretName1} -s https://{keyvaultName}.vault.azure.net/secrets/{secretName2} -r us-east-2

Parâmetros Obrigatórios

--aws-access-key-reference -a

Chave de acesso do Amazon API Gateway. Deve ser uma referência secreta do Cofre da Chave do Azure.

--aws-region-name -r

Região do Amazon API Gateway (ex. us-east-2).

--aws-secret-access-key-reference -s

Chave de acesso secreta do Amazon API Gateway. Deve ser uma referência secreta do Cofre da Chave do Azure.

--integration-name -i

O nome da integração.

--resource-group -g

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

--service-name -n

O nome do serviço Central de API do Azure.

Parâmetros Opcionais

--import-specification

Indica se a especificação deve ser importada junto com metadados.

Valores aceites: always, never, ondemand
Default value: always
--msi-resource-id

A ID de recurso da identidade gerenciada que tem acesso ao Cofre da Chave do Azure.

--target-environment-id

O ID do recurso do ambiente de destino.

--target-lifecycle-stage

O estágio do ciclo de vida de destino.

Valores aceites: deprecated, design, development, preview, production, retired, testing
Parâmetros de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

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

--subscription

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

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.