Share via

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.

Commands

Name Description Type Status
az apic integration create apim

Add Azure APIM as an API source.

 Extension GA
az apic integration create aws

Add Amazon API Gateway as an API source.

 Extension GA

az apic integration create apim

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.

Property Value
Parameter group: AzureApiManagementSource Arguments
--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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--import-specification

Indicates if the specification should be imported along with metadata.

Property Value
Parameter group: Properties Arguments
Default value: always
Accepted values: always, never, ondemand
--msi-resource-id

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

Property Value
Parameter group: AzureApiManagementSource Arguments
--target-environment-id

The target environment resource ID.

Property Value
Parameter group: Properties Arguments
--target-lifecycle-stage

The target lifecycle stage.

Property Value
Parameter group: Properties Arguments
Accepted values: deprecated, design, development, preview, production, retired, testing
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az apic integration create aws

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.

Property Value
Parameter group: AmazonApiGatewaySource Arguments
--aws-region-name -r

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

Property Value
Parameter group: AmazonApiGatewaySource Arguments
--aws-secret-access-key-reference -s

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

Property Value
Parameter group: AmazonApiGatewaySource Arguments
--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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--import-specification

Indicates if the specification should be imported along with metadata.

Property Value
Parameter group: Properties Arguments
Default value: always
Accepted values: always, never, ondemand
--msi-resource-id

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

Property Value
Parameter group: AmazonApiGatewaySource Arguments
--target-environment-id

The target environment resource ID.

Property Value
Parameter group: Properties Arguments
--target-lifecycle-stage

The target lifecycle stage.

Property Value
Parameter group: Properties Arguments
Accepted values: deprecated, design, development, preview, production, retired, testing
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False