Udostępnij przez

az apim api versionset

Zarządzanie zestawem wersji interfejsu API usługi Azure API Management.

Polecenia

Nazwa Opis Typ Stan
az apim api versionset create

Tworzy zestaw wersji interfejsu API.

 Core ogólna dostępność
az apim api versionset delete

Usuwa określony zestaw wersji interfejsu API.

 Core ogólna dostępność
az apim api versionset list

Wyświetla kolekcję zestawów wersji interfejsu API w określonym wystąpieniu usługi.

 Core ogólna dostępność
az apim api versionset show

Pobiera szczegóły zestawu wersji interfejsu API określonego przez jego identyfikator.

 Core ogólna dostępność
az apim api versionset update

Aktualizuje szczegóły zestawu wersji interfejsu API określonego przez jego identyfikator.

 Core ogólna dostępność

az apim api versionset create

Edytuj

Tworzy zestaw wersji interfejsu API.

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]

Przykłady

Tworzy zestaw wersji interfejsu API ze schematem wersji jako nagłówek.

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

Tworzy zestaw wersji interfejsu API ze schematem wersji jako zapytanie.

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

Parametry wymagane

--display-name

Required. Nazwa zestawu wersji interfejsu API.

--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu az configure --defaults group=<name>.

--service-name -n

Nazwa wystąpienia usługi API Management.

--versioning-scheme

Required. Wartość określająca, gdzie identyfikator wersji interfejsu API będzie znajdować się w żądaniu HTTP. Możliwe wartości to: "Segment", "Zapytanie", "Nagłówek".

Parametry opcjonalne

Poniższe parametry są opcjonalne, ale w zależności od kontekstu co najmniej jeden może być wymagany do pomyślnego wykonania polecenia.

--description

Opis zestawu wersji interfejsu API.

--if-match

Element ETag jednostki.

--version-header-name

Nazwa parametru nagłówka HTTP wskazująca wersję interfejsu API, jeśli parametr versioningScheme jest ustawiony na header.

--version-query-name

Nazwa parametru zapytania, który wskazuje wersję interfejsu API, jeśli ustawienie versioningScheme ma wartość query.

--version-set-id

Identyfikator zasobu powiązanego elementu ApiVersionSet.

Parametry globalne
--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False
--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

Właściwość Wartość
Domyślna wartość: False
--output -o

Format danych wyjściowych.

Właściwość Wartość
Domyślna wartość: json
Dopuszczalne wartości: json, jsonc, none, table, tsv, yaml, yamlc
--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False

az apim api versionset delete

Edytuj

Usuwa określony zestaw wersji interfejsu API.

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

Przykłady

Usuwa określony zestaw wersji interfejsu API.

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

Parametry wymagane

--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu az configure --defaults group=<name>.

--service-name -n

Nazwa wystąpienia usługi API Management.

--version-set-id

Identyfikator zasobu powiązanego elementu ApiVersionSet.

Parametry opcjonalne

Poniższe parametry są opcjonalne, ale w zależności od kontekstu co najmniej jeden może być wymagany do pomyślnego wykonania polecenia.

--if-match

Element ETag jednostki.

Parametry globalne
--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False
--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

Właściwość Wartość
Domyślna wartość: False
--output -o

Format danych wyjściowych.

Właściwość Wartość
Domyślna wartość: json
Dopuszczalne wartości: json, jsonc, none, table, tsv, yaml, yamlc
--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False

az apim api versionset list

Edytuj

Wyświetla kolekcję zestawów wersji interfejsu API w określonym wystąpieniu usługi.

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

Przykłady

Wyświetla kolekcję zestawów wersji interfejsu API w określonym wystąpieniu usługi.

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

Parametry wymagane

--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu az configure --defaults group=<name>.

--service-name -n

Nazwa wystąpienia usługi API Management.

Parametry globalne
--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False
--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

Właściwość Wartość
Domyślna wartość: False
--output -o

Format danych wyjściowych.

Właściwość Wartość
Domyślna wartość: json
Dopuszczalne wartości: json, jsonc, none, table, tsv, yaml, yamlc
--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False

az apim api versionset show

Edytuj

Pobiera szczegóły zestawu wersji interfejsu API określonego przez jego identyfikator.

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

Przykłady

Pobiera szczegóły zestawu wersji interfejsu API określonego przez jego identyfikator.

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

Parametry wymagane

--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu az configure --defaults group=<name>.

--service-name -n

Nazwa wystąpienia usługi API Management.

--version-set-id

Identyfikator zasobu powiązanego elementu ApiVersionSet.

Parametry globalne
--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False
--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

Właściwość Wartość
Domyślna wartość: False
--output -o

Format danych wyjściowych.

Właściwość Wartość
Domyślna wartość: json
Dopuszczalne wartości: json, jsonc, none, table, tsv, yaml, yamlc
--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False

az apim api versionset update

Edytuj

Aktualizuje szczegóły zestawu wersji interfejsu API określonego przez jego identyfikator.

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]

Przykłady

Aktualizuje opis, wyświetlaną nazwę zestawu wersji interfejsu API określonego przez jego identyfikator.

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

Aktualizuje schemat wersji zestawu wersji interfejsu API określonego przez jego identyfikator.

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

Parametry wymagane

--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu az configure --defaults group=<name>.

--service-name -n

Nazwa wystąpienia usługi API Management.

--version-set-id

Identyfikator zasobu powiązanego elementu ApiVersionSet.

Parametry opcjonalne

Poniższe parametry są opcjonalne, ale w zależności od kontekstu co najmniej jeden może być wymagany do pomyślnego wykonania polecenia.

--add

Dodaj obiekt do listy obiektów, określając pary ścieżki i wartości klucza. Przykład: --add property.listProperty <key=value, string or JSON string>.

Właściwość Wartość
Grupa parametrów: Generic Update Arguments
Domyślna wartość: []
--description

Opis zestawu wersji interfejsu API.

--display-name

Required. Nazwa zestawu wersji interfejsu API.

--force-string

W przypadku używania polecenia "set" lub "add" zachowaj literały ciągu zamiast próbować konwertować na format JSON.

Właściwość Wartość
Grupa parametrów: Generic Update Arguments
Domyślna wartość: False
--if-match

Element ETag jednostki.

--remove

Usuń właściwość lub element z listy. Przykład: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Właściwość Wartość
Grupa parametrów: Generic Update Arguments
Domyślna wartość: []
--set

Zaktualizuj obiekt, określając ścieżkę właściwości i wartość do ustawienia. Przykład: --set property1.property2=<value>.

Właściwość Wartość
Grupa parametrów: Generic Update Arguments
Domyślna wartość: []
--version-header-name

Nazwa parametru nagłówka HTTP wskazująca wersję interfejsu API, jeśli parametr versioningScheme jest ustawiony na header.

--version-query-name

Nazwa parametru zapytania, który wskazuje wersję interfejsu API, jeśli ustawienie versioningScheme ma wartość query.

--versioning-scheme

Required. Wartość określająca, gdzie identyfikator wersji interfejsu API będzie znajdować się w żądaniu HTTP. Możliwe wartości to: "Segment", "Zapytanie", "Nagłówek".

Parametry globalne
--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False
--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

Właściwość Wartość
Domyślna wartość: False
--output -o

Format danych wyjściowych.

Właściwość Wartość
Domyślna wartość: json
Dopuszczalne wartości: json, jsonc, none, table, tsv, yaml, yamlc
--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False