Freigeben über

az apim api versionset

  • Referenz

Verwalten sie den Versionssatz der Azure API-Verwaltungs-API.

Befehle

Name Beschreibung Typ Status
az apim api versionset create

Erstellt einen API-Versionssatz.

 Kern GA
az apim api versionset delete

Löscht bestimmte API-Versionssatz.

 Kern GA
az apim api versionset list

Listet eine Auflistung von API-Versionssätzen in der angegebenen Dienstinstanz auf.

 Kern GA
az apim api versionset show

Ruft die Details des api-Versionssatzes ab, der durch seinen Bezeichner angegeben ist.

 Kern GA
az apim api versionset update

Aktualisiert die Details des durch den Bezeichner angegebenen API-Versionssets.

 Kern GA

az apim api versionset create

Bearbeiten

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

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

--versioning-scheme

Erforderlich. Ein Wert, der bestimmt, wo sich die API-Versionidentifer in einer HTTP-Anforderung befindet. Mögliche Werte sind: "Segment", "Abfrage", "Header".

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

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

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

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

az apim api versionset delete

Bearbeiten

Löscht bestimmte API-Versionssatz.

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

Beispiele

Löscht bestimmte API-Versionssatz.

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

--version-set-id

Ein Ressourcenbezeichner für das zugehörige ApiVersionSet.

Optionale Parameter

--if-match

ETag der Entität.

Globale Parameter
--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

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

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

az apim api versionset list

Bearbeiten

Listet eine Auflistung von API-Versionssätzen in der angegebenen Dienstinstanz auf.

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

Beispiele

Listet eine Auflistung von API-Versionssätzen 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-Verwaltungsdienstinstanz.

Globale Parameter
--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

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

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

az apim api versionset show

Bearbeiten

Ruft die Details des api-Versionssatzes ab, der durch seinen Bezeichner angegeben ist.

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

Beispiele

Ruft die Details des api-Versionssatzes ab, der durch seinen Bezeichner angegeben ist.

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

--version-set-id

Ein Ressourcenbezeichner für das zugehörige ApiVersionSet.

Globale Parameter
--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

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

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

az apim api versionset update

Bearbeiten

Aktualisiert die Details des durch den Bezeichner angegebenen API-Versionssets.

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

Aktualisiert die Beschreibung, den Anzeigenamen des durch den Bezeichner angegebenen API-Versionssets.

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

Aktualisiert das Versionsschema des durch den Bezeichner angegebenen API-Versionssets.

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

--version-set-id

Ein Ressourcenbezeichner für das zugehörige ApiVersionSet.

Optionale Parameter

--add

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

Standardwert: []
--description

Beschreibung des API-Versionssatzes.

--display-name

Erforderlich. Name des API-Versionssatzes.

--force-string

Wenn Sie "set" oder "add" verwenden, behalten Sie Zeichenfolgenliterale bei, anstatt zu versuchen, in JSON zu konvertieren.

Standardwert: False
--if-match

ETag der Entität.

--remove

Entfernen sie eine Eigenschaft oder ein Element aus einer Liste. Beispiel: --remove property.list <indexToRemove> ODER --remove propertyToRemove.

Standardwert: []
--set

Aktualisieren Sie ein Objekt, indem Sie einen festzulegenden Eigenschaftspfad und -wert angeben. Beispiel: --set property1.property2=<value>.

Standardwert: []
--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-Versionidentifer in einer HTTP-Anforderung befindet. Mögliche Werte sind: "Segment", "Abfrage", "Header".

Globale Parameter
--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

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

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.