az apic

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

Manage Azure API Center services.

Commands

Name	Description	Type	Status
az apic api	Commands to manage APIs in API Center.	Extension	GA
az apic api create	Register a new API or update an existing API.	Extension	GA
az apic api definition	Commands to manage API definitions in API Center.	Extension	GA
az apic api definition create	Create a new API definition or update an existing API definition.	Extension	GA
az apic api definition delete	Delete specified API definition.	Extension	GA
az apic api definition export-specification	Exports the API specification.	Extension	GA
az apic api definition import-specification	Imports the API specification.	Extension	GA
az apic api definition list	List a collection of API definitions.	Extension	GA
az apic api definition show	Get details of the API definition.	Extension	GA
az apic api definition update	Update existing API definition.	Extension	GA
az apic api delete	Delete specified API.	Extension	GA
az apic api deployment	Commands to manage API deployments in API Center.	Extension	GA
az apic api deployment create	Create a new API deployment or update an existing API deployment.	Extension	GA
az apic api deployment delete	Delete API deployment.	Extension	GA
az apic api deployment list	List a collection of API deployments.	Extension	GA
az apic api deployment show	Get details of the API deployment.	Extension	GA
az apic api deployment update	Update existing API deployment.	Extension	GA
az apic api list	List a collection of APIs.	Extension	GA
az apic api register	Registers a new API with version, definition, and associated deployments using the specification file as the source of truth. For now we only support OpenAPI JSON/YAML format.	Extension	Preview
az apic api show	Get details of the API.	Extension	GA
az apic api update	Update existing API.	Extension	GA
az apic api version	Commands to manage API versions in API Center.	Extension	GA
az apic api version create	Create a new API version or update an existing API version.	Extension	GA
az apic api version delete	Delete specified API version.	Extension	GA
az apic api version list	List a collection of API versions.	Extension	GA
az apic api version show	Get details of the API version.	Extension	GA
az apic api version update	Update existing API version.	Extension	GA
az apic create	Creates an instance or update an existing instance of an Azure API Center service.	Extension	GA
az apic delete	Deletes an instance of an Azure API Center service.	Extension	GA
az apic environment	Commands to manage environments in API Center.	Extension	GA
az apic environment create	Create a new environment or update an existing environment.	Extension	GA
az apic environment delete	Delete the environment.	Extension	GA
az apic environment list	List a collection of environments.	Extension	GA
az apic environment show	Get details of the environment.	Extension	GA
az apic environment update	Update existing environment.	Extension	GA
az apic import-from-apim	Imports APIs from an Azure API Management service instance.	Extension	GA
az apic list	Lists Azure API Center services within an Azure subscription.	Extension	GA
az apic metadata	Commands to manage metadata schemas in API Center.	Extension	GA
az apic metadata create	Create a new metadata schema or update an existing metadata schema.	Extension	GA
az apic metadata delete	Delete specified metadata schema.	Extension	GA
az apic metadata export	Exports the metadata schema.	Extension	GA
az apic metadata list	List a collection of metadata schemas.	Extension	GA
az apic metadata show	Get details of the metadata schema.	Extension	GA
az apic metadata update	Update existing metadata schema.	Extension	GA
az apic show	Show details of an Azure API Center service instance.	Extension	GA
az apic update	Update an instance of an Azure API Center service.	Extension	GA

az apic create

Creates an instance or update an existing instance of an Azure API Center service.

az apic create --name
               --resource-group
               [--identity]
               [--location]
               [--tags]

Examples

Create service Example

az apic create -g contoso-resources -n contoso -l eastus

Create Service With System Assigned Identity Example

az apic create -g contoso-resources -n contoso -l eastus --identity '{type:systemassigned}'

Required Parameters

--name -n

The name of the API Center service.

--resource-group -g

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

Optional Parameters

--identity

The managed service identities assigned to this resource. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--location -l

The geo-location where the resource lives When not specified, the location of the resource group will be used.

--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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 delete

Deletes an instance of an Azure API Center service.

az apic delete [--ids]
               [--name]
               [--resource-group]
               [--subscription]
               [--yes]

Examples

Delete service

az apic delete -n contoso -g contoso-resources

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.

--name -n

The name of the API Center service.

--resource-group -g

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

--subscription

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

--yes -y

Do not prompt for confirmation.

Default value: False

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 import-from-apim

Imports APIs from an Azure API Management service instance.

az apic import-from-apim --apim-apis
                         --apim-name
                         [--apim-resource-group]
                         [--apim-subscription]
                         [--ids]
                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                         [--resource-group]
                         [--service-name]
                         [--subscription]

Examples

Import all APIs from APIM in same resource group

az apic import-from-apim -g api-center-test --service-name contoso-apic --apim-name contoso-apim --apim-apis *

Import selected APIs from APIM in same resource group

az apic import-from-apim -g api-center-test --service-name contoso-apic --apim-name contoso-apim --apim-apis [echo,foo]

Import all APIs from APIM in another subscription and resource group

az apic import-from-apim -g api-center-test --service-name contoso-apic --apim-subscription 00000000-0000-0000-0000-000000000000 --apim-resource-group apim-rg --apim-name contoso-apim --apim-apis *

Required Parameters

--apim-apis

The APIs to be imported. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--apim-name

The name of the source APIM instance.

Optional Parameters

--apim-resource-group

The resource group of the source APIM instance.

--apim-subscription

The subscription id of the source APIM instance.

--ids

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

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 list

Lists Azure API Center services within an Azure subscription.

There is a known issue that listing all resources under a subscription does not work. Please list resources by resource group.

az apic list [--max-items]
             [--next-token]
             [--resource-group]

Examples

List services in resource group

az apic list -g contoso-resources

Optional Parameters

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

--resource-group -g

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

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 show

Show details of an Azure API Center service instance.

az apic show [--ids]
             [--name]
             [--resource-group]
             [--subscription]

Examples

Show service details

az apic show -g contoso-resources -n contoso

Optional Parameters

--ids

--name -n

The name of the API Center service.

--resource-group -g

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

--subscription

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

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 update

Update an instance of an Azure API Center service.

az apic update [--add]
               [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
               [--identity]
               [--ids]
               [--name]
               [--remove]
               [--resource-group]
               [--set]
               [--subscription]
               [--tags]

Examples

Update service details

az apic update -g contoso-resources -n contoso

Update Service With System Assigned Identity Example

az apic create -g contoso-resources -n contoso --identity '{type:systemassigned}'

Optional Parameters

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

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

--identity

The managed service identities assigned to this resource. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--ids

--name -n

The name of the API Center service.

--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

--resource-group -g

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

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

--subscription

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

--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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.

Share via

az apic

Commands

az apic create

Examples

Required Parameters

Optional Parameters

az apic delete

Examples

Optional Parameters

az apic import-from-apim

Examples

Required Parameters

Optional Parameters

az apic list

Examples

Optional Parameters

az apic show

Examples

Optional Parameters

az apic update

Examples

Optional Parameters

Additional resources