az apim api versionset

Azure API Management API-versieset beheren.

Opdracht

az apim api versionset create

Hiermee maakt u een API-versieset.

az apim api versionset delete

Hiermee verwijdert u een specifieke API-versieset.

az apim api versionset list

Hiermee wordt een verzameling API-versiesets in het opgegeven service-exemplaar vermeld.

az apim api versionset show

Hiermee haalt u de details op van de API-versieset die is opgegeven door de id.

az apim api versionset update

Werkt de details bij van de API-versieset die is opgegeven door de id.

az apim api versionset create

Hiermee maakt u een API-versieset.

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]

Voorbeelden

Hiermee maakt u een API-versieset met versieschema als 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

Hiermee maakt u een API-versieset met versieschema als 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

Vereiste parameters

--display-name

Vereist. Naam van API-versieset.

--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name> .

--service-name -n

De naam van het API Management service-exemplaar.

--versioning-scheme

Vereist. Een waarde die bepaalt waar de API-versie zich in een HTTP-aanvraag bevindt.

Optionele parameters

--description

Beschrijving van API-versieset.

--if-match

ETag van de entiteit.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met az account set -s NAME_OR_ID behulp van .

--version-header-name

Naam van http-headerparameter die de API-versie aangeeft als versioningScheme is ingesteld op header .

--version-query-name

Naam van queryparameter die de API-versie aangeeft als versioningScheme is ingesteld op query .

--version-set-id

Een resource-id voor de gerelateerde ApiVersionSet.

az apim api versionset delete

Hiermee verwijdert u een specifieke API-versieset.

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

Voorbeelden

Hiermee verwijdert u een specifieke API-versieset.

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

Vereiste parameters

--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name> .

--service-name -n

De naam van het API Management service-exemplaar.

--version-set-id

Een resource-id voor de gerelateerde ApiVersionSet.

Optionele parameters

--if-match

ETag van de entiteit.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met az account set -s NAME_OR_ID behulp van .

az apim api versionset list

Hiermee wordt een verzameling API-versiesets in het opgegeven service-exemplaar vermeld.

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

Voorbeelden

Hiermee wordt een verzameling API-versiesets in het opgegeven service-exemplaar vermeld.

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

Vereiste parameters

--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name> .

--service-name -n

De naam van het API Management service-exemplaar.

Optionele parameters

--query-examples

JMESPath-tekenreeks voor u aanbevelen. U kunt een van de query's kopiƫren en plakken na de parameter --query tussen dubbele aanhalingstekens om de resultaten te bekijken. U kunt een of meer positionele trefwoorden toevoegen, zodat we suggesties kunnen geven op basis van deze sleutelwoorden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met az account set -s NAME_OR_ID behulp van .

az apim api versionset show

Hiermee haalt u de details op van de API-versieset die is opgegeven door de id.

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

Voorbeelden

Hiermee haalt u de details op van de API-versieset die is opgegeven door de id.

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

Vereiste parameters

--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name> .

--service-name -n

De naam van het API Management service-exemplaar.

--version-set-id

Een resource-id voor de gerelateerde ApiVersionSet.

Optionele parameters

--query-examples

JMESPath-tekenreeks voor u aanbevelen. U kunt een van de query's kopiƫren en plakken na de parameter --query tussen dubbele aanhalingstekens om de resultaten te bekijken. U kunt een of meer positionele trefwoorden toevoegen, zodat we suggesties kunnen geven op basis van deze sleutelwoorden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met az account set -s NAME_OR_ID behulp van .

az apim api versionset update

Werkt de details bij van de API-versieset die is opgegeven door de id.

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]

Voorbeelden

Werkt de beschrijving bij, de weergavenaam van de API VersionSet die is opgegeven door de id.

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

Werkt het versieschema bij van de API VersionSet die is opgegeven door de id.

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

Vereiste parameters

--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name> .

--service-name -n

De naam van het API Management service-exemplaar.

--version-set-id

Een resource-id voor de gerelateerde ApiVersionSet.

Optionele parameters

--add

Voeg een object toe aan een lijst met objecten door een pad en sleutelwaardeparen op te geven. Voorbeeld: --add property.listProperty <key=value, string of JSON string>.

--description

Beschrijving van API-versieset.

--display-name

Vereist. Naam van API-versieset.

--force-string

Wanneer u 'set' of 'add' gebruikt, moet u letterlijke tekenreeksen bewaren in plaats van te proberen te converteren naar JSON.

--if-match

ETag van de entiteit.

--remove

Verwijder een eigenschap of een element uit een lijst. Voorbeeld: --remove property.list OR --remove propertyToRemove.

--set

Werk een object bij door een eigenschapspad en waarde op te geven die moeten worden ingesteld. Voorbeeld: --set property1.property2=.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met az account set -s NAME_OR_ID behulp van .

--version-header-name

Naam van http-headerparameter die de API-versie aangeeft als versioningScheme is ingesteld op header .

--version-query-name

Naam van queryparameter die de API-versie aangeeft als versioningScheme is ingesteld op query .

--versioning-scheme

Vereist. Een waarde die bepaalt waar de API-versie zich in een HTTP-aanvraag bevindt.