Share via

az apim api versionset

  • Referentie

Azure API Management API-versieset beheren.

Opdracht

Name Description Type Status
az apim api versionset create

Hiermee maakt u een API-versieset.

 Kern GA
az apim api versionset delete

Hiermee verwijdert u specifieke API-versieset.

 Kern GA
az apim api versionset list

Geeft een verzameling API-versiesets weer in het opgegeven service-exemplaar.

 Kern GA
az apim api versionset show

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

 Kern GA
az apim api versionset update

Hiermee worden de details bijgewerkt van de Api VersionSet die is opgegeven door de id.

 Kern GA

az apim api versionset create

Bewerken

Hiermee maakt u een API-versieset.

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]

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

Verplicht. Naam van API-versieset.

--resource-group -g

Naam van 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

Verplicht. Een waarde die bepaalt waar de API-versie-id zich in een HTTP-aanvraag bevindt. Mogelijke waarden zijn: 'Segment', 'Query', 'Header'.

Optionele parameters

--description

Beschrijving van API-versieset.

--if-match

ETag van de entiteit.

--version-header-name

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

--version-query-name

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

--version-set-id

Een resource-id voor de gerelateerde ApiVersionSet.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

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

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az apim api versionset delete

Bewerken

Hiermee verwijdert u specifieke API-versieset.

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

Voorbeelden

Hiermee verwijdert u specifieke API-versieset.

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

Vereiste parameters

--resource-group -g

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

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

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

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az apim api versionset list

Bewerken

Geeft een verzameling API-versiesets weer in het opgegeven service-exemplaar.

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

Voorbeelden

Geeft een verzameling API-versiesets weer in het opgegeven service-exemplaar.

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

Vereiste parameters

--resource-group -g

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

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

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

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az apim api versionset show

Bewerken

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

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

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

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

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

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az apim api versionset update

Bewerken

Hiermee worden de details bijgewerkt van de Api VersionSet 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]
                              [--version-header-name]
                              [--version-query-name]
                              [--versioning-scheme]

Voorbeelden

Hiermee wordt de beschrijving, weergavenaam van de Api VersionSet bijgewerkt 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

Hiermee wordt het versieschema van de Api VersionSet bijgewerkt 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

Naam van 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 or JSON string>.

Default value: []
--description

Beschrijving van API-versieset.

--display-name

Verplicht. Naam van API-versieset.

--force-string

Wanneer u 'set' of 'toevoegen' gebruikt, behoudt u letterlijke tekenreeksen in plaats van te converteren naar JSON.

Default value: False
--if-match

ETag van de entiteit.

--remove

Een eigenschap of element uit een lijst verwijderen. Voorbeeld: --remove property.list <indexToRemove> OF --remove propertyToRemove.

Default value: []
--set

Werk een object bij door een eigenschapspad en waarde op te geven die u wilt instellen. Voorbeeld: --set property1.property2=<value>.

Default value: []
--version-header-name

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

--version-query-name

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

--versioning-scheme

Verplicht. Een waarde die bepaalt waar de API-versie-id zich in een HTTP-aanvraag bevindt. Mogelijke waarden zijn: 'Segment', 'Query', 'Header'.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

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

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.