az apic api version

Note

Ta dokumentacja jest częścią rozszerzenia apic-extension dla interfejsu wiersza polecenia platformy Azure (wersja 2.57.0 lub nowsza). Rozszerzenie zostanie automatycznie zainstalowane przy pierwszym uruchomieniu polecenia az apic api. Dowiedz się więcej o rozszerzeniach.

Polecenia do zarządzania wersjami interfejsu API w Centrum interfejsu API.

Polecenia

Nazwa	Opis	Typ	Stan
az apic api version create	Utwórz nową wersję interfejsu API lub zaktualizuj istniejącą wersję interfejsu API.	Extension	ogólna dostępność
az apic api version delete	Usuń określoną wersję interfejsu API.	Extension	ogólna dostępność
az apic api version list	Wyświetlanie listy kolekcji wersji interfejsu API.	Extension	ogólna dostępność
az apic api version show	Uzyskaj szczegółowe informacje o wersji interfejsu API.	Extension	ogólna dostępność
az apic api version update	Zaktualizuj istniejącą wersję interfejsu API.	Extension	ogólna dostępność

az apic api version create

Utwórz nową wersję interfejsu API lub zaktualizuj istniejącą wersję interfejsu API.

az apic api version create --api-id
                           --lifecycle-stage {deprecated, design, development, preview, production, retired, testing}
                           --resource-group
                           --service-name
                           --title
                           --version-id

Przykłady

Tworzenie wersji interfejsu API

az apic api version create -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01 --title "2023-01-01" --lifecycle-stage production

Parametry wymagane

--api-id

Identyfikator interfejsu API.

--lifecycle-stage

Bieżący etap cyklu życia interfejsu API.

Właściwość	Wartość
Grupa parametrów:	Properties Arguments
Dopuszczalne wartości:	deprecated, design, development, preview, production, retired, testing

--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 usługi Azure API Center.

--title

Wersja interfejsu API.

Właściwość	Wartość
Grupa parametrów:	Properties Arguments

--version-id

Identyfikator wersji interfejsu API.

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 apic api version delete

Usuń określoną wersję interfejsu API.

az apic api version delete [--api-id]
                           [--ids]
                           [--resource-group]
                           [--service-name]
                           [--subscription]
                           [--version-id]
                           [--yes]

Przykłady

Usuwanie wersji interfejsu API

az apic api version delete -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01

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.

--api-id

Identyfikator interfejsu API.

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

--ids

Co najmniej jeden identyfikator zasobu (rozdzielany spacjami). Powinien to być kompletny identyfikator zasobu, zawierający wszystkie informacje dotyczące argumentów „Identyfikator zasobu”. Należy podać argumenty --ids lub inne argumenty "Identyfikator zasobu".

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

--resource-group -g

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

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

--service-name -n

Nazwa usługi Azure API Center.

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

--subscription

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

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

--version-id

Identyfikator wersji interfejsu API.

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

--yes -y

Nie monituj o potwierdzenie.

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

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.

--verbose

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

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

az apic api version list

Wyświetlanie listy kolekcji wersji interfejsu API.

az apic api version list --api-id
                         --resource-group
                         --service-name
                         [--filter]
                         [--max-items]
                         [--next-token]

Przykłady

Wyświetlanie listy wersji interfejsu API

az apic api version list -g api-center-test -n contosoeuap --api-id echo-api

Parametry wymagane

--api-id

Identyfikator 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 usługi Azure API Center.

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.

--filter

Parametr filtru OData.

--max-items

Łączna liczba elementów do zwrócenia w danych wyjściowych polecenia. Jeśli łączna liczba dostępnych elementów jest większa niż określona wartość, token jest udostępniany w danych wyjściowych polecenia. Aby wznowić stronicowanie, podaj wartość tokenu w --next-token argumentu kolejnego polecenia.

Właściwość	Wartość
Grupa parametrów:	Pagination Arguments

--next-token

Token do określenia, gdzie rozpocząć stronicowanie. Jest to wartość tokenu z wcześniej obciętej odpowiedzi.

Właściwość	Wartość
Grupa parametrów:	Pagination Arguments

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 apic api version show

Uzyskaj szczegółowe informacje o wersji interfejsu API.

az apic api version show [--api-id]
                         [--ids]
                         [--resource-group]
                         [--service-name]
                         [--subscription]
                         [--version-id]

Przykłady

Pokaż szczegóły wersji interfejsu API

az apic api version show -g api-center-test -n contoso --api-id echo-api --version-id 2023-01-01

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.

--api-id

Identyfikator interfejsu API.

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

--ids

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

--resource-group -g

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

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

--service-name -n

Nazwa usługi Azure API Center.

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

--subscription

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

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

--version-id

Identyfikator wersji interfejsu API.

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

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.

--verbose

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

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

az apic api version update

Zaktualizuj istniejącą wersję interfejsu API.

az apic api version update [--add]
                           [--api-id]
                           [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                           [--ids]
                           [--lifecycle-stage {deprecated, design, development, preview, production, retired, testing}]
                           [--remove]
                           [--resource-group]
                           [--service-name]
                           [--set]
                           [--subscription]
                           [--title]
                           [--version-id]

Przykłady

Aktualizowanie wersji interfejsu API

az apic api version update -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01 --title "2023-01-01"

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

--api-id

Identyfikator interfejsu API.

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

--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
Dopuszczalne wartości:	0, 1, f, false, n, no, t, true, y, yes

--ids

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

--lifecycle-stage

Bieżący etap cyklu życia interfejsu API.

Właściwość	Wartość
Grupa parametrów:	Properties Arguments
Dopuszczalne wartości:	deprecated, design, development, preview, production, retired, testing

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

--resource-group -g

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

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

--service-name -n

Nazwa usługi Azure API Center.

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

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

--subscription

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

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

--title

Wersja interfejsu API.

Właściwość	Wartość
Grupa parametrów:	Properties Arguments

--version-id

Identyfikator wersji interfejsu API.

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

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.

--verbose

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

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

Sprzężenie zwrotne

Czy ta strona była pomocna?

Udostępnij przez

az apic api version

Polecenia

az apic api version create

Przykłady

Parametry wymagane

az apic api version delete

Przykłady

Parametry opcjonalne

az apic api version list

Przykłady

Parametry wymagane

Parametry opcjonalne

az apic api version show

Przykłady

Parametry opcjonalne

az apic api version update

Przykłady

Parametry opcjonalne

Sprzężenie zwrotne