Compartilhar via

az apic integration create

Note

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

Comandos

Nome Description Tipo Status
az apic integration create apim

Adicione Azure APIM como uma fonte de API.

 Extension GA
az apic integration create aws

Adicione o Gateway de API da Amazon como uma fonte de API.

 Extension GA

az apic integration create apim

Adicione Azure APIM como uma fonte de API.

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

Exemplos

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

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

Adicionar Azure APIM 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 Exigidos

--azure-apim

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

Propriedade Valor
Grupo de parâmetros: AzureApiManagementSource Arguments
--integration-name -i

O nome da integração.

--resource-group -g

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

--service-name -n

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

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--acquire-policy-token

Adquirir um token Azure Policy automaticamente para essa operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--change-reference

A ID de referência de alteração relacionada para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--import-specification

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

Propriedade Valor
Grupo de parâmetros: Properties Arguments
Valor padrão: always
Valores aceitos: always, never, ondemand
--msi-resource-id

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

Propriedade Valor
Grupo de parâmetros: AzureApiManagementSource Arguments
--target-environment-id

A ID do recurso de ambiente de destino.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
--target-lifecycle-stage

O estágio do ciclo de vida de destino.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
Valores aceitos: deprecated, design, development, preview, production, retired, testing
Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--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 a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

az apic integration create aws

Adicione o Gateway de API da Amazon 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
                               [--acquire-policy-token]
                               [--change-reference]
                               [--import-specification {always, never, ondemand}]
                               [--msi-resource-id]
                               [--target-environment-id]
                               [--target-lifecycle-stage {deprecated, design, development, preview, production, retired, testing}]

Exemplos

Adicionar o Gateway de API da Amazon 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 Exigidos

--aws-access-key-reference -a

Chave de Acesso do Gateway de API da Amazon. Deve ser uma referência secreta Azure Key Vault.

Propriedade Valor
Grupo de parâmetros: AmazonApiGatewaySource Arguments
--aws-region-name -r

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

Propriedade Valor
Grupo de parâmetros: AmazonApiGatewaySource Arguments
--aws-secret-access-key-reference -s

Chave de Acesso Secreto do Gateway de API da Amazon. Deve ser uma referência secreta Azure Key Vault.

Propriedade Valor
Grupo de parâmetros: AmazonApiGatewaySource Arguments
--integration-name -i

O nome da integração.

--resource-group -g

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

--service-name -n

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

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--acquire-policy-token

Adquirir um token Azure Policy automaticamente para essa operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--change-reference

A ID de referência de alteração relacionada para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--import-specification

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

Propriedade Valor
Grupo de parâmetros: Properties Arguments
Valor padrão: always
Valores aceitos: always, never, ondemand
--msi-resource-id

A ID do recurso da identidade gerenciada que tem acesso ao Azure Key Vault.

Propriedade Valor
Grupo de parâmetros: AmazonApiGatewaySource Arguments
--target-environment-id

A ID do recurso de ambiente de destino.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
--target-lifecycle-stage

O estágio do ciclo de vida de destino.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
Valores aceitos: deprecated, design, development, preview, production, retired, testing
Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--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 a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False