az apic api version

  • Odwołanie

Uwaga

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

 Numer wewnętrzny Ogólna dostępność
az apic api version delete

Usuń określoną wersję interfejsu API.

 Numer wewnętrzny Ogólna dostępność
az apic api version list

Wyświetlanie listy kolekcji wersji interfejsu API.

 Numer wewnętrzny Ogólna dostępność
az apic api version show

Uzyskaj szczegółowe informacje o wersji interfejsu API.

 Numer wewnętrzny Ogólna dostępność
az apic api version update

Zaktualizuj istniejącą wersję interfejsu API.

 Numer wewnętrzny 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
                           --title
                           --version-id

Przykłady

Tworzenie wersji interfejsu API

az apic api version create -g api-center-test -s contosoeuap --api-id echo-api --version-id 2023-01-01 --title "2023-01-01"

Parametry wymagane

--api-id

Identyfikator interfejsu API.

--lifecycle-stage

Bieżący etap cyklu życia interfejsu API.

akceptowane 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 polecenia az configure --defaults group=<name>.

--service --service-name -s

Nazwa usługi API Center.

--title

Wersja interfejsu API.

--version-id

Identyfikator wersji interfejsu API.

Parametry globalne
--debug

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

--help -h

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

--only-show-errors

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

--output -o

Format danych wyjściowych.

akceptowane wartości: json, jsonc, none, table, tsv, yaml, yamlc
wartość domyślna: json
--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 polecenia az account set -s NAME_OR_ID.

--verbose

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

az apic api version delete

Usuń określoną wersję interfejsu API.

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

Przykłady

Usuwanie wersji interfejsu API

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

Parametry opcjonalne

--api-id

Identyfikator interfejsu API.

--ids

Co najmniej jeden identyfikator zasobu (rozdzielany spacjami). Powinien to być pełny identyfikator zasobu zawierający wszystkie informacje o argumentach "Identyfikator zasobu". Należy podać argumenty --ids lub inne argumenty "Identyfikator zasobu".

--resource-group -g

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

--service --service-name -s

Nazwa usługi API Center.

--subscription

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

--version-id

Identyfikator wersji interfejsu API.

--yes -y

Nie monituj o potwierdzenie.

wartość domyślna: False
Parametry globalne
--debug

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

--help -h

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

--only-show-errors

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

--output -o

Format danych wyjściowych.

akceptowane wartości: json, jsonc, none, table, tsv, yaml, yamlc
wartość domyślna: json
--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 polecenia az account set -s NAME_OR_ID.

--verbose

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

az apic api version list

Wyświetlanie listy kolekcji wersji interfejsu API.

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

Przykłady

Wyświetlanie listy wersji interfejsu API

az apic api version list -g api-center-test -s 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 polecenia az configure --defaults group=<name>.

--service --service-name -s

Nazwa usługi API Center.

Parametry opcjonalne

--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 argumencie kolejnego polecenia.

--next-token

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

Parametry globalne
--debug

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

--help -h

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

--only-show-errors

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

--output -o

Format danych wyjściowych.

akceptowane wartości: json, jsonc, none, table, tsv, yaml, yamlc
wartość domyślna: json
--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 polecenia az account set -s NAME_OR_ID.

--verbose

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

az apic api version show

Uzyskaj szczegółowe informacje o wersji interfejsu API.

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

Przykłady

Pokaż szczegóły wersji interfejsu API

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

Parametry opcjonalne

--api-id

Identyfikator interfejsu API.

--ids

Co najmniej jeden identyfikator zasobu (rozdzielany spacjami). Powinien to być pełny identyfikator zasobu zawierający wszystkie informacje o argumentach "Identyfikator zasobu". Należy podać argumenty --ids lub inne argumenty "Identyfikator zasobu".

--resource-group -g

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

--service --service-name -s

Nazwa usługi API Center.

--subscription

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

--version-id

Identyfikator wersji interfejsu API.

Parametry globalne
--debug

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

--help -h

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

--only-show-errors

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

--output -o

Format danych wyjściowych.

akceptowane wartości: json, jsonc, none, table, tsv, yaml, yamlc
wartość domyślna: json
--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 polecenia az account set -s NAME_OR_ID.

--verbose

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

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]
                           [--set]
                           [--subscription]
                           [--title]
                           [--version-id]

Przykłady

Aktualizowanie wersji interfejsu API

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

Parametry opcjonalne

--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 lub ciąg> JSON.

--api-id

Identyfikator interfejsu API.

--force-string

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

akceptowane wartości: 0, 1, f, false, n, no, t, true, y, yes
--ids

Co najmniej jeden identyfikator zasobu (rozdzielany spacjami). Powinien to być pełny identyfikator zasobu zawierający wszystkie informacje o argumentach "Identyfikator zasobu". Należy podać argumenty --ids lub inne argumenty "Identyfikator zasobu".

--lifecycle-stage

Bieżący etap cyklu życia interfejsu API.

akceptowane wartości: deprecated, design, development, preview, production, retired, testing
--remove

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

--resource-group -g

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

--service --service-name -s

Nazwa usługi API Center.

--set

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

--subscription

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

--title

Wersja interfejsu API.

--version-id

Identyfikator wersji interfejsu API.

Parametry globalne
--debug

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

--help -h

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

--only-show-errors

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

--output -o

Format danych wyjściowych.

akceptowane wartości: json, jsonc, none, table, tsv, yaml, yamlc
wartość domyślna: json
--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 polecenia az account set -s NAME_OR_ID.

--verbose

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