az apim api versionset

Manage Azure API Management API Version Set.

Commands

az apim api versionset create

Creates a Api Version Set.

az apim api versionset delete

Deletes specific Api Version Set.

az apim api versionset list

Lists a collection of API Version Sets in the specified service instance.

az apim api versionset show

Gets the details of the Api Version Set specified by its identifier.

az apim api versionset update

Updates the details of the Api VersionSet specified by its identifier.

az apim api versionset create

Creates a Api Version Set.

az apim api versionset create --display-name
                              --resource-group
                              --service-name
                              --versioning-scheme
                              [--description]
                              [--if-match]
                              [--subscription]
                              [--version-header-name]
                              [--version-query-name]
                              [--version-set-id]

Examples

Creates a Api Version Set with version schema as header.

az apim api versionset create --resource-group MyResourceGroup --service-name MyServiceName --version-set-id MyVersionSetId --display-name MyDisplayName --versioning-scheme "Header" --description MyDescription --version-header-name MyHeaderName

Creates a Api Version Set with version schema as query.

az apim api versionset create --resource-group MyResourceGroup --service-name MyServiceName --version-set-id MyVersionSetId --display-name MyDisplayName --versioning-scheme "Query" --description MyDescription --version-query-name MyQueryName

Required Parameters

--display-name

Required. Name of API Version Set.

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

--versioning-scheme

Required. An value that determines where the API Version identifer will be located in a HTTP request.

Optional Parameters

--description

Description of API Version Set.

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

--version-header-name

Name of HTTP header parameter that indicates the API Version if versioningScheme is set to header.

--version-query-name

Name of query parameter that indicates the API Version if versioningScheme is set to query.

--version-set-id

A resource identifier for the related ApiVersionSet.

az apim api versionset delete

Deletes specific Api Version Set.

az apim api versionset delete --resource-group
                              --service-name
                              --version-set-id
                              [--if-match]
                              [--subscription]

Examples

Deletes specific Api Version Set.

az apim api versionset delete --resource-group MyResourceGroup --service-name MyServiceName --version-set-id MyVersionSetId

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

--version-set-id

A resource identifier for the related ApiVersionSet.

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 versionset list

Lists a collection of API Version Sets in the specified service instance.

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

Examples

Lists a collection of API Version Sets in the specified service instance.

az apim api versionset list --resource-group MyResourceGroup --service-name MyServiceName

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

Gets the details of the Api Version Set specified by its identifier.

az apim api versionset show --resource-group
                            --service-name
                            --version-set-id
                            [--query-examples]
                            [--subscription]

Examples

Gets the details of the Api Version Set specified by its identifier.

az apim api versionset show --resource-group MyResourceGroup --service-name MyServiceName --version-set-id MyVersionSetId

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

--version-set-id

A resource identifier for the related ApiVersionSet.

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 versionset update

Updates the details of the Api VersionSet specified by its identifier.

az apim api versionset update --resource-group
                              --service-name
                              --version-set-id
                              [--add]
                              [--description]
                              [--display-name]
                              [--force-string]
                              [--if-match]
                              [--remove]
                              [--set]
                              [--subscription]
                              [--version-header-name]
                              [--version-query-name]
                              [--versioning-scheme]

Examples

Updates the description, display-name of the Api VersionSet specified by its identifier.

az apim api versionset update --resource-group MyResourceGroup --service-name MyServiceName --version-set-id MyVersionSetId --display-name MyNewDisplayName --description MyNewDescription

Updates the version schema of the Api VersionSet specified by its identifier.

az apim api versionset update --resource-group MyResourceGroup --service-name MyServiceName --version-set-id MyVersionSetId --versioning-scheme "Query" --version-query-name MyNewQueryName

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

--version-set-id

A resource identifier for the related ApiVersionSet.

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

--description

Description of API Version Set.

--display-name

Required. Name of API Version Set.

--force-string

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

--if-match

ETag of the Entity.

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

--version-header-name

Name of HTTP header parameter that indicates the API Version if versioningScheme is set to header.

--version-query-name

Name of query parameter that indicates the API Version if versioningScheme is set to query.

--versioning-scheme

Required. An value that determines where the API Version identifer will be located in a HTTP request.