Share via

az apic api

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

Commands to manage APIs in API Center.

Commands

Name Description Type Status
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 api create

Register a new API or update an existing API.

az apic api create --api-id
                   --resource-group
                   --service-name
                   --title
                   --type {graphql, grpc, rest, soap, webhook, websocket}
                   [--contacts]
                   [--custom-properties]
                   [--description]
                   [--external-documentation]
                   [--license]
                   [--summary]

Examples

Create API

az apic api create -g contoso-resources -n contoso --api-id echo-api --title "Echo API" --type REST

Create API with custom properties

az apic api create -g contoso-resources -n contoso --api-id echo-api --title "Echo API" --type REST --custom-properties '{"public-facing":true}'

Create API with custom properties using json file

az apic api create -g contoso-resources -n contoso --api-id echo-api --title "Echo API" --type REST --custom-properties '@customProperties.json'

Required Parameters

--api-id

The id of the API.

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

--title

API title.

Property Value
Parameter group: Properties Arguments
--type

Type of API.

Property Value
Parameter group: Properties Arguments
Accepted values: graphql, grpc, rest, soap, webhook, websocket

Optional Parameters

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

--contacts

The contact information for the API. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--custom-properties

The custom metadata defined for API catalog entities. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--description

Description of the API.

Property Value
Parameter group: Properties Arguments
--external-documentation

Additional, external documentation for the API. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--license

The license information for the API. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--summary

Short description of the API.

Property Value
Parameter group: Properties Arguments
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 api delete

Delete specified API.

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

Examples

Delete API

az apic api delete -g contoso-resources -n contoso --api-id echo-api

Optional Parameters

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

--api-id

The id of the API.

Property Value
Parameter group: Resource Id Arguments
--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.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--service-name -n

The name of Azure API Center service.

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
--yes -y

Do not prompt for confirmation.

Property Value
Default value: False
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.

--verbose

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

Property Value
Default value: False

az apic api list

List a collection of APIs.

az apic api list --resource-group
                 --service-name
                 [--filter]
                 [--max-items]
                 [--next-token]

Examples

List APIs

az apic api list -g contoso-resources -n contoso

List APIs with filter

az apic api list -g contoso-resources -n contoso --filter "kind eq 'rest'"

Required Parameters

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

Optional Parameters

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

--filter

OData filter parameter.

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

Property Value
Parameter group: Pagination Arguments
--next-token

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

Property Value
Parameter group: Pagination Arguments
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 api register

Preview

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

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.

az apic api register --api-___location
                     --resource-group
                     --service-name
                     [--environment-id]

Examples

Register api by providing spec file.

az apic api register -g api-center-test -n contosoeuap --api-___location "examples/cli-examples/spec-examples/openai.json" --environment-id public
az apic api register -g api-center-test -n contosoeuap --api-___location "examples/cli-examples/spec-examples/openai.yml" --environment-id public

Register api by providing spec url.

az apic api register -g api-center-test -n contosoeuap --api-___location "https://petstore.swagger.io/v2/swagger.json" --environment-id public
az apic api register -g api-center-test -n contosoeuap --api-___location "https://petstore.swagger.io/v2/swagger.yaml" --environment-id public

Required Parameters

--api-___location -l

Location of spec file.

--resource-group -g

Resource group name.

--service-name -n

APICenter Catalog or Service name.

Optional Parameters

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

--environment-id

Id of environment created before.

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 api show

Get details of the API.

az apic api show [--api-id]
                 [--ids]
                 [--resource-group]
                 [--service-name]
                 [--subscription]

Examples

Show API details

az apic api show -g contoso-resources -n contoso --api-id echo-api

Optional Parameters

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

--api-id

The id of the API.

Property Value
Parameter group: Resource Id Arguments
--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.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--service-name -n

The name of Azure API Center service.

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
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.

--verbose

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

Property Value
Default value: False

az apic api update

Update existing API.

az apic api update [--add]
                   [--api-id]
                   [--contacts]
                   [--custom-properties]
                   [--description]
                   [--external-documentation]
                   [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                   [--ids]
                   [--license]
                   [--remove]
                   [--resource-group]
                   [--service-name]
                   [--set]
                   [--subscription]
                   [--summary]
                   [--title]
                   [--type {graphql, grpc, rest, soap, webhook, websocket}]

Examples

Update API

az apic api update -g contoso-resources -n contoso --api-id echo-api --summary "Basic REST API service"

Update custom properties

az apic api update -g contoso-resources -n contoso --api-id echo-api --custom-properties '{"public-facing":true}'

Update custom properties using json file

az apic api update -g contoso-resources -n contoso --api-id echo-api --custom-properties '@customProperities.json'

Update single custom metadata

az apic api update -g contoso-resources -n contoso --api-id echo-api --set customProperties.internal=false

Optional Parameters

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

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

Property Value
Parameter group: Generic Update Arguments
--api-id

The id of the API.

Property Value
Parameter group: Resource Id Arguments
--contacts

The contact information for the API. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--custom-properties

The custom metadata defined for API catalog entities. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--description

Description of the API.

Property Value
Parameter group: Properties Arguments
--external-documentation

Additional, external documentation for the API. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--force-string

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

Property Value
Parameter group: Generic Update Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--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.

Property Value
Parameter group: Resource Id Arguments
--license

The license information for the API. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--remove

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

Property Value
Parameter group: Generic Update Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--service-name -n

The name of Azure API Center service.

Property Value
Parameter group: Resource Id Arguments
--set

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

Property Value
Parameter group: Generic Update Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
--summary

Short description of the API.

Property Value
Parameter group: Properties Arguments
--title

API title.

Property Value
Parameter group: Properties Arguments
--type

Type of API.

Property Value
Parameter group: Properties Arguments
Accepted values: graphql, grpc, rest, soap, webhook, websocket
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.

--verbose

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

Property Value
Default value: False