az apic import

Reference

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 import command. Learn more about extensions.

Commands

Name	Description	Type	Status
az apic import aws	Import an Amazon API Gateway API source.	Extension	Preview

az apic import aws

Preview

This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Import an Amazon API Gateway API source.

az apic import aws --aws-access-key-reference
                   --aws-region-name
                   --aws-secret-access-key-reference
                   [--ids]
                   [--import-specification {always, never, ondemand}]
                   [--msi-resource-id]
                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                   [--resource-group]
                   [--service-name]
                   [--subscription]
                   [--target-environment-id]
                   [--target-lifecycle-stage {deprecated, design, development, preview, production, retired, testing}]

Examples

Import an Amazon API Gateway API source

az apic import aws -g contoso-resources -n contoso -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.

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--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.

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

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

--service-name -n

The name of Azure API Center service.

--subscription

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

--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.

Dijelite putem