az apim api versionset

Verwalten von Azure API Management API-Versionssatz.

Befehle

az apim api versionset create	Erstellt einen API-Versionssatz.
az apim api versionset delete	Löscht die angegebene API-Versionsgruppe
az apim api versionset list	Listet eine Auflistung von API-Versionsgruppen in der angegebenen Dienstinstanz auf
az apim api versionset show	Ruft die Details des API-Versionssatzes ab, der durch den Bezeichner angegeben wird.
az apim api versionset update	Aktualisierungen die Details des api VersionSets, das durch den Bezeichner angegeben wird.

az apim api versionset create

Erstellt einen API-Versionssatz.

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]

Beispiele

Erstellt einen API-Versionssatz mit Versionsschema als Kopfzeile.

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

Erstellt einen API-Versionssatz mit Versionsschema als Abfrage.

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

Erforderliche Parameter

--display-name

Erforderlich. Name des API-Versionssatzes.

--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

--service-name -n

Der Name der API Management Dienstinstanz.

--versioning-scheme

Erforderlich. Ein Wert, der bestimmt, wo sich die API-Version identifer in einer HTTP-Anforderung befindet.

Optionale Parameter

--description

Beschreibung des API-Versionssatzes.

--if-match

ETag der Entität.

--version-header-name

Name des HTTP-Headerparameters, der die API-Version angibt, wenn versioningScheme auf headerfestgelegt ist.

--version-query-name

Name des Abfrageparameters, der die API-Version angibt, wenn versioningScheme auf queryfestgelegt ist.

--version-set-id

Ein Ressourcenbezeichner für das zugehörige ApiVersionSet.

Globale Parameter

--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az apim api versionset delete

Löscht die angegebene API-Versionsgruppe

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

Beispiele

Löscht die angegebene API-Versionsgruppe

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

Erforderliche Parameter

--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

--service-name -n

Der Name der API Management Dienstinstanz.

--version-set-id

Ein Ressourcenbezeichner für das zugehörige ApiVersionSet.

Optionale Parameter

--if-match

ETag der Entität.

Globale Parameter

--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az apim api versionset list

Listet eine Auflistung von API-Versionsgruppen in der angegebenen Dienstinstanz auf

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

Beispiele

Listet eine Auflistung von API-Versionsgruppen in der angegebenen Dienstinstanz auf

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

Erforderliche Parameter

--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

--service-name -n

Der Name der API Management Dienstinstanz.

Globale Parameter

--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az apim api versionset show

Ruft die Details des API-Versionssatzes ab, der durch den Bezeichner angegeben wird.

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

Beispiele

Ruft die Details des API-Versionssatzes ab, der durch den Bezeichner angegeben wird.

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

Erforderliche Parameter

--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

--service-name -n

Der Name der API Management Dienstinstanz.

--version-set-id

Ein Ressourcenbezeichner für das zugehörige ApiVersionSet.

Globale Parameter

--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az apim api versionset update

Aktualisierungen die Details des api VersionSets, das durch den Bezeichner angegeben wird.

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]

Beispiele

Aktualisierungen die Beschreibung, Anzeigename der api VersionSet, die durch den Bezeichner angegeben wird.

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

Aktualisierungen das Versionsschema des api VersionSets, das durch den Bezeichner angegeben wird.

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

Erforderliche Parameter

--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

--service-name -n

Der Name der API Management Dienstinstanz.

--version-set-id

Ein Ressourcenbezeichner für das zugehörige ApiVersionSet.

Optionale Parameter

--add

Fügen Sie einem Objekt eine Liste von Objekten hinzu, indem Sie ein Pfad- und Schlüsselwertpaar angeben. Beispiel: --add property.listProperty <key=value, string or JSON string>.

--description

Beschreibung des API-Versionssatzes.

--display-name

Erforderlich. Name des API-Versionssatzes.

--force-string

Wenn Sie "set" oder "add" verwenden, behalten Sie Zeichenfolgen literale beibehalten, anstatt zu versuchen, in JSON zu konvertieren.

--if-match

ETag der Entität.

--remove

Entfernen Sie eine Eigenschaft oder ein Element aus einer Liste. Beispiel: --remove property.list OR --remove propertyToRemove.

--set

Aktualisieren Sie ein Objekt, indem Sie einen Eigenschaftenpfad und einen wert angeben, der festgelegt werden soll. Beispiel: --set-property1.property2=.

--version-header-name

Name des HTTP-Headerparameters, der die API-Version angibt, wenn versioningScheme auf headerfestgelegt ist.

--version-query-name

Name des Abfrageparameters, der die API-Version angibt, wenn versioningScheme auf queryfestgelegt ist.

--versioning-scheme

Erforderlich. Ein Wert, der bestimmt, wo sich die API-Version identifer in einer HTTP-Anforderung befindet.

Globale Parameter

--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.