az apim api versionset
Manage Azure API Management API Version Set.
Name | Description | Type | Status |
---|---|---|---|
az apim api versionset create |
Creates a Api Version Set. |
Core | GA |
az apim api versionset delete |
Deletes specific Api Version Set. |
Core | GA |
az apim api versionset list |
Lists a collection of API Version Sets in the specified service instance. |
Core | GA |
az apim api versionset show |
Gets the details of the Api Version Set specified by its identifier. |
Core | GA |
az apim api versionset update |
Updates the details of the Api VersionSet specified by its identifier. |
Core | GA |
Creates a Api Version Set.
az apim api versionset create --display-name
--resource-group
--service-name
--versioning-scheme
[--description]
[--if-match]
[--version-header-name]
[--version-query-name]
[--version-set-id]
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. Name of API Version Set.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
The name of the API Management service instance.
Required. An value that determines where the API Version identifer will be located in a HTTP request. Possible values include: 'Segment', 'Query', 'Header'.
Description of API Version Set.
ETag of the Entity.
Name of HTTP header parameter that indicates the API Version if versioningScheme is set to header
.
Name of query parameter that indicates the API Version if versioningScheme is set to query
.
A resource identifier for the related ApiVersionSet.
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.
Deletes specific Api Version Set.
az apim api versionset delete --resource-group
--service-name
--version-set-id
[--if-match]
Deletes specific Api Version Set.
az apim api versionset delete --resource-group MyResourceGroup --service-name MyServiceName --version-set-id MyVersionSetId
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
The name of the API Management service instance.
A resource identifier for the related ApiVersionSet.
ETag of the Entity.
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.
Lists a collection of API Version Sets in the specified service instance.
az apim api versionset list --resource-group
--service-name
Lists a collection of API Version Sets in the specified service instance.
az apim api versionset list --resource-group MyResourceGroup --service-name MyServiceName
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
The name of the API Management service instance.
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.
Gets the details of the Api Version Set specified by its identifier.
az apim api versionset show --resource-group
--service-name
--version-set-id
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
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
The name of the API Management service instance.
A resource identifier for the related ApiVersionSet.
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.
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]
[--version-header-name]
[--version-query-name]
[--versioning-scheme]
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
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
The name of the API Management service instance.
A resource identifier for the related ApiVersionSet.
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 of API Version Set.
Required. Name of API Version Set.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
ETag of the Entity.
Remove a property or an element from a list. Example: --remove property.list <indexToRemove>
OR --remove propertyToRemove
.
Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>
.
Name of HTTP header parameter that indicates the API Version if versioningScheme is set to header
.
Name of query parameter that indicates the API Version if versioningScheme is set to query
.
Required. An value that determines where the API Version identifer will be located in a HTTP request. Possible values include: 'Segment', 'Query', 'Header'.
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.
Azure CLI feedback
Azure CLI is an open source project. Select a link to provide feedback: