Compartir a través de

az apic integration create

Note

Esta referencia forma parte de la extensión apic-extension para la CLI de Azure (versión 2.57.0 o posterior). La extensión instalará automáticamente la primera vez que ejecute un comando az apic integration create. Obtenga más información sobre las extensiones.

Comandos

Nombre Description Tipo Estado
az apic integration create apim

Agregue Azure APIM como origen de API.

 Extension Disponibilidad general
az apic integration create aws

Agregue Amazon API Gateway como origen de API.

 Extension Disponibilidad general

az apic integration create apim

Agregue Azure APIM como origen 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}]

Ejemplos

Incorporación de Azure APIM en el mismo grupo de recursos que la instancia del Centro de API de Azure que un origen de API

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

Incorporación de Azure APIM en otro grupo de recursos como origen 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 requeridos

--azure-apim

El nombre o el identificador de recurso de la instancia de APIM de origen.

Propiedad Valor
Grupo de parámetros: AzureApiManagementSource Arguments
--integration-name -i

Nombre de la integración.

--resource-group -g

Nombre del grupo de recursos del Centro de API de Azure. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

--service-name -n

Nombre del servicio Azure API Center.

Parámetros opcionales

Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.

--import-specification

Indica si la especificación se debe importar junto con los metadatos.

Propiedad Valor
Grupo de parámetros: Properties Arguments
Valor predeterminado: always
Valores aceptados: always, never, ondemand
--msi-resource-id

Identificador de recurso de la identidad administrada que tiene acceso a la instancia de API Management.

Propiedad Valor
Grupo de parámetros: AzureApiManagementSource Arguments
--target-environment-id

Identificador de recurso del entorno de destino.

Propiedad Valor
Grupo de parámetros: Properties Arguments
--target-lifecycle-stage

Fase del ciclo de vida de destino.

Propiedad Valor
Grupo de parámetros: Properties Arguments
Valores aceptados: deprecated, design, development, preview, production, retired, testing
Parámetros globales
--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad Valor
Valor predeterminado: False
--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad Valor
Valor predeterminado: False
--output -o

Formato de salida.

Propiedad Valor
Valor predeterminado: json
Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad Valor
Valor predeterminado: False

az apic integration create aws

Agregue Amazon API Gateway como origen 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}]

Ejemplos

Adición de Amazon API Gateway como origen 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 requeridos

--aws-access-key-reference -a

Clave de acceso de La puerta de enlace de Api de Amazon. Debe ser una referencia de secreto de Azure Key Vault.

Propiedad Valor
Grupo de parámetros: AmazonApiGatewaySource Arguments
--aws-region-name -r

Región de puerta de enlace de Amazon API (por ejemplo, us-east-2).

Propiedad Valor
Grupo de parámetros: AmazonApiGatewaySource Arguments
--aws-secret-access-key-reference -s

Clave de acceso secreta de Amazon API Gateway. Debe ser una referencia de secreto de Azure Key Vault.

Propiedad Valor
Grupo de parámetros: AmazonApiGatewaySource Arguments
--integration-name -i

Nombre de la integración.

--resource-group -g

Nombre del grupo de recursos del Centro de API de Azure. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

--service-name -n

Nombre del servicio Azure API Center.

Parámetros opcionales

Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.

--import-specification

Indica si la especificación se debe importar junto con los metadatos.

Propiedad Valor
Grupo de parámetros: Properties Arguments
Valor predeterminado: always
Valores aceptados: always, never, ondemand
--msi-resource-id

Identificador de recurso de la identidad administrada que tiene acceso a Azure Key Vault.

Propiedad Valor
Grupo de parámetros: AmazonApiGatewaySource Arguments
--target-environment-id

Identificador de recurso del entorno de destino.

Propiedad Valor
Grupo de parámetros: Properties Arguments
--target-lifecycle-stage

Fase del ciclo de vida de destino.

Propiedad Valor
Grupo de parámetros: Properties Arguments
Valores aceptados: deprecated, design, development, preview, production, retired, testing
Parámetros globales
--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad Valor
Valor predeterminado: False
--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad Valor
Valor predeterminado: False
--output -o

Formato de salida.

Propiedad Valor
Valor predeterminado: json
Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad Valor
Valor predeterminado: False