az apim api release

Manage Azure API Management API Release.

Commands

az apim api release create

Creates a new Release for the API.

az apim api release delete

Deletes the specified release in the API.

az apim api release list

Lists all releases of an API.

az apim api release show

Returns the details of an API release.

az apim api release update

Updates the details of the release of the API specified by its identifier.

az apim api release create

Creates a new Release for the API.

az apim api release create --api-id
                           --api-revision
                           --resource-group
                           --service-name
                           [--if-match]
                           [--notes]
                           [--release-id]
                           [--subscription]

Examples

Creates a new Release for the API.

az apim api release create --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId --release-id MyReleaseId --api-revision 2 --notes MyNotes

Required Parameters

--api-id

API identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

--api-revision

API revision number.

--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 the API Management service instance.

Optional Parameters

--if-match

ETag of the Entity.

--notes

Release Notes.

--release-id

Release identifier within an API. Must be unique in the current API Management service instance.

--subscription

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

az apim api release delete

Deletes the specified release in the API.

az apim api release delete --api-id
                           --release-id
                           --resource-group
                           --service-name
                           [--if-match]
                           [--subscription]

Examples

Deletes the specified release in the API.

az apim api release delete --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId --release-id MyReleaseId

Required Parameters

--api-id

API identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

--release-id

Release identifier within an API. Must be unique in the current API Management service instance.

--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 the API Management service instance.

Optional Parameters

--if-match

ETag of the Entity.

--subscription

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

az apim api release list

Lists all releases of an API.

az apim api release list --api-id
                         --resource-group
                         --service-name
                         [--query-examples]
                         [--subscription]

Examples

Lists all releases of an API.

az apim api release list --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId

Required Parameters

--api-id

API identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

--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 the API Management service instance.

Optional Parameters

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

--subscription

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

az apim api release show

Returns the details of an API release.

az apim api release show --api-id
                         --release-id
                         --resource-group
                         --service-name
                         [--query-examples]
                         [--subscription]

Examples

Returns the details of an API release.

az apim api release show --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId --release-id MyReleaseId

Required Parameters

--api-id

API identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

--release-id

Release identifier within an API. Must be unique in the current API Management service instance.

--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 the API Management service instance.

Optional Parameters

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

--subscription

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

az apim api release update

Updates the details of the release of the API specified by its identifier.

az apim api release update --api-id
                           --release-id
                           --resource-group
                           --service-name
                           [--add]
                           [--api-id1]
                           [--force-string]
                           [--if-match]
                           [--notes]
                           [--remove]
                           [--set]
                           [--subscription]

Examples

Updates the notes of the release of the API specified by its identifier.

az apim api release update --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId --release-id MyReleaseId --notes MyNewNotes

Required Parameters

--api-id

API identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

--release-id

Release identifier within an API. Must be unique in the current API Management service instance.

--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 the API Management service instance.

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

Identifier of the API the release belongs to.

--force-string

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

--if-match

ETag of the Entity.

--notes

Release Notes.

--remove

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

--set

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

--subscription

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