az apic integration create

Note

This reference is part of the apic-extension extension for the Azure CLI (version 2.57.0 or higher). The extension will automatically install the first time you run an az apic integration create command. Learn more about extensions.

Command group 'az apic integration' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Commands

Name	Description	Type	Status
az apic integration create apim	Add Azure APIM as an API source.	Extension	Preview
az apic integration create aws	Add Amazon API Gateway as an API source.	Extension	Preview

az apic integration create apim

Preview

Command group 'az apic integration' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Add Azure APIM as an API source.

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

Examples

Add Azure APIM in the same resource group as the Azure API Center instance as an API source

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

Add Azure APIM in another resource group as an API source

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

Required Parameters

--azure-apim

The name or resource id of the source APIM instance.

--integration-name -i

The name of the integration.

--resource-group -g

Name of Azure API Center resource group. You can configure the default group using az configure --defaults group=<name>.

--service-name -n

The name of Azure API Center service.

Optional Parameters

--import-specification

Indicates if the specification should be imported along with metadata.

Accepted values: always, never, ondemand

Default value: always

--msi-resource-id

The resource ID of the managed identity that has access to the API Management instance.

--target-environment-id

The target environment resource ID.

--target-lifecycle-stage

The target lifecycle stage.

Accepted values: deprecated, design, development, preview, production, retired, testing

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az apic integration create aws

Preview

Command group 'az apic integration' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Add Amazon API Gateway as an API source.

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

Examples

Add Amazon API Gateway as an API source

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

Required Parameters

--aws-access-key-reference -a

Amazon API Gateway Access Key. Must be an Azure Key Vault secret reference.

--aws-region-name -r

Amazon API Gateway Region (ex. us-east-2).

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

Amazon API Gateway Secret Access Key. Must be an Azure Key Vault secret reference.

--integration-name -i

The name of the integration.

--resource-group -g

Name of Azure API Center resource group. You can configure the default group using az configure --defaults group=<name>.

--service-name -n

The name of Azure API Center service.

Optional Parameters

--import-specification

Indicates if the specification should be imported along with metadata.

Accepted values: always, never, ondemand

Default value: always

--msi-resource-id

The resource ID of the managed identity that has access to the Azure Key Vault.

--target-environment-id

The target environment resource ID.

--target-lifecycle-stage

The target lifecycle stage.

Accepted values: deprecated, design, development, preview, production, retired, testing

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.