az apic api deployment
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
--definition-id
--deployment-id
--environment-id
--resource-group
--server
--service-name
--title
[--custom-properties]
[--description]
Examples
Create deployment
az apic api deployment create -g api-center-test -n 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
The id of the API.
API center-scoped definition resource ID.
The id of the API deployment.
API center-scoped environment resource ID.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Server Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The name of Azure API Center service.
Deployment title.
Optional Parameters
The custom metadata defined for API catalog entities. Support json-file and yaml-file.
Description of the deployment.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
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-name]
[--subscription]
[--yes]
Examples
Delete API deployment
az apic api deployment delete -g api-center-test -n contoso --deployment-id production --api-id echo-api
Optional Parameters
The id of the API.
The id of the API deployment.
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 of resource group. You can configure the default group using az configure --defaults group=<name>
.
The name of Azure API Center service.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Do not prompt for confirmation.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
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-name
[--filter]
[--max-items]
[--next-token]
Examples
List API deployments
az apic api deployment list -g api-center-test -n contoso --api-id echo-api
Required Parameters
The id of the API.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
The name of Azure API Center service.
Optional Parameters
OData filter parameter.
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.
Token to specify where to start paginating. This is the token value from a previously truncated response.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
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-name]
[--subscription]
Examples
Show API deployment details
az apic api deployment show -g api-center-test -n contoso --deployment-id production --api-id echo-api
Optional Parameters
The id of the API.
The id of the API deployment.
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 of resource group. You can configure the default group using az configure --defaults group=<name>
.
The name of Azure API Center service.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
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-name]
[--set]
[--subscription]
[--title]
Examples
Update API deployment
az apic api deployment update -g api-center-test -n contoso --deployment-id production --title "Production deployment" --api-id echo-api
Optional Parameters
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>
.
The id of the API.
The custom metadata defined for API catalog entities. Support json-file and yaml-file.
Service-scoped definition resource ID.
The id of the API deployment.
Description of the deployment.
Service-scoped environment resource ID.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
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 a property or an element from a list. Example: --remove property.list <indexToRemove>
OR --remove propertyToRemove
.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Server Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The name of Azure API Center service.
Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Title.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.