Share via

az apic api deployment

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

Commands to manage API deployments in API Center.

Commands

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

Create a new API deployment or update an existing API deployment.

az apic api deployment create --api-id
                              --deployment-id
                              --resource-group
                              --service
                              [--custom-properties]
                              [--definition-id]
                              [--description]
                              [--environment-id]
                              [--server]
                              [--state {active, inactive}]
                              [--title]

Examples

Create deployment

az apic api deployment create -g api-center-test -s contoso --deployment-id production --title "Production deployment" --description "Public cloud production deployment." --api-id echo-api --environment-id "/workspaces/default/environments/production" --definition-id "/workspaces/default/apis/echo-api/versions/2023-01-01/definitions/openapi" --server '{"runtimeUri":["https://example.com"]}'

Required Parameters

--api-id

The id of the API.

--deployment-id

The id of the API deployment.

--resource-group -g

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

--service --service-name -s

The name of the API Center service.

Optional Parameters

--custom-properties

The custom metadata defined for API catalog entities. Support json-file and yaml-file.

--definition-id

API center-scoped definition resource ID.

--description

Description of the deployment.

--environment-id

API center-scoped environment resource ID.

--server

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

--state

State of API deployment.

accepted values: active, inactive
--title

Deployment title.

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 api deployment delete

Delete API deployment.

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

Examples

Delete API deployment

az apic api deployment delete -g api-center-test -s contoso --deployment-id production --api-id echo-api

Optional Parameters

--api-id

The id of the API.

--deployment-id

The id of the API deployment.

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

--resource-group -g

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

--service --service-name -s

The name of the API Center service.

--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 api deployment list

List a collection of API deployments.

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

Examples

List API deployments

az apic api deployment list -g api-center-test -s contoso --api-id echo-api

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 --service-name -s

The name of the API Center service.

Optional Parameters

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

--next-token

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

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

Get details of the API deployment.

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

Examples

Show API deployment details

az apic api deployment show -g api-center-test -s contoso --deployment-id production --api-id echo-api

Optional Parameters

--api-id

The id of the API.

--deployment-id

The id of the API deployment.

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

--resource-group -g

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

--service --service-name -s

The name of the 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 api deployment update

Update existing API deployment.

az apic api deployment update [--add]
                              [--api-id]
                              [--custom-properties]
                              [--definition-id]
                              [--deployment-id]
                              [--description]
                              [--environment-id]
                              [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                              [--ids]
                              [--remove]
                              [--resource-group]
                              [--server]
                              [--service]
                              [--set]
                              [--state {active, inactive}]
                              [--subscription]
                              [--title]

Examples

Update API deployment

az apic api deployment update -g api-center-test -s contoso --deployment-id production --title "Production deployment" --api-id echo-api

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

--api-id

The id of the API.

--custom-properties

The custom metadata defined for API catalog entities. Support json-file and yaml-file.

--definition-id

Service-scoped definition resource ID.

--deployment-id

The id of the API deployment.

--description

Description of the deployment.

--environment-id

Service-scoped environment resource ID.

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

--remove

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

--resource-group -g

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

--server

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

--service --service-name -s

The name of the API Center service.

--set

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

--state

State of API deployment.

accepted values: active, inactive
--subscription

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

--title

Title.

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.