az apim api

  • Odwołanie

Zarządzanie interfejsami API usługi Azure API Management.

Polecenia

Nazwa Opis Typ Stan
az apim api create

Tworzenie interfejsu API usługi API Management.

 Podstawowe funkcje Ogólna dostępność
az apim api delete

Usuwanie interfejsu API usługi API Management.

 Podstawowe funkcje Ogólna dostępność
az apim api export

Eksportowanie interfejsu API usługi API Management.

 Podstawowe funkcje Ogólna dostępność
az apim api import

Importowanie interfejsu API usługi API Management.

 Podstawowe funkcje Ogólna dostępność
az apim api list

Wyświetlanie listy interfejsów API usługi API Management.

 Podstawowe funkcje Ogólna dostępność
az apim api operation

Zarządzanie operacjami interfejsu API usługi Azure API Management.

 Podstawowe funkcje Ogólna dostępność
az apim api operation create

Tworzy nową operację w interfejsie API.

 Podstawowe funkcje Ogólna dostępność
az apim api operation delete

Usuwa określoną operację w interfejsie API.

 Podstawowe funkcje Ogólna dostępność
az apim api operation list

Wyświetlanie listy kolekcji operacji dla określonego interfejsu API.

 Podstawowe funkcje Ogólna dostępność
az apim api operation show

Pobiera szczegóły operacji interfejsu API określonej przez jego identyfikator.

 Podstawowe funkcje Ogólna dostępność
az apim api operation update

Aktualizacje szczegóły operacji w interfejsie API określonym przez jego identyfikator.

 Podstawowe funkcje Ogólna dostępność
az apim api release

Zarządzanie wydaniem interfejsu API usługi Azure API Management.

 Podstawowe funkcje Ogólna dostępność
az apim api release create

Tworzy nową wersję dla interfejsu API.

 Podstawowe funkcje Ogólna dostępność
az apim api release delete

Usuwa określoną wersję w interfejsie API.

 Podstawowe funkcje Ogólna dostępność
az apim api release list

Wyświetla listę wszystkich wydań interfejsu API.

 Podstawowe funkcje Ogólna dostępność
az apim api release show

Zwraca szczegóły wydania interfejsu API.

 Podstawowe funkcje Ogólna dostępność
az apim api release update

Aktualizacje szczegóły wydania interfejsu API określonego przez jego identyfikator.

 Podstawowe funkcje Ogólna dostępność
az apim api revision

Zarządzanie poprawką interfejsu API usługi Azure API Management.

 Podstawowe funkcje Ogólna dostępność
az apim api revision create

Utwórz poprawkę interfejsu API.

 Podstawowe funkcje Ogólna dostępność
az apim api revision list

Wyświetla listę wszystkich poprawek interfejsu API.

 Podstawowe funkcje Ogólna dostępność
az apim api schema

Zarządzanie schematami interfejsu API usługi Azure API Management.

 Podstawowe funkcje Ogólna dostępność
az apim api schema create

Tworzenie schematu interfejsu API usługi API Management.

 Podstawowe funkcje Ogólna dostępność
az apim api schema delete

Usuwanie schematu interfejsu API usługi API Management.

 Podstawowe funkcje Ogólna dostępność
az apim api schema get-etag

Pobierz element etag schematu interfejsu API usługi API Management.

 Podstawowe funkcje Ogólna dostępność
az apim api schema list

Wyświetlanie listy schematów interfejsu API usługi API Management.

 Podstawowe funkcje Ogólna dostępność
az apim api schema show

Pokaż szczegóły schematu interfejsu API usługi API Management.

 Podstawowe funkcje Ogólna dostępność
az apim api schema wait

Umieść interfejs wiersza polecenia w stanie oczekiwania do momentu spełnienia warunku schematu interfejsu API usługi APIm.

 Podstawowe funkcje Ogólna dostępność
az apim api show

Pokaż szczegóły interfejsu API usługi API Management.

 Podstawowe funkcje Ogólna dostępność
az apim api update

Aktualizowanie interfejsu API usługi API Management.

 Podstawowe funkcje Ogólna dostępność
az apim api versionset

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

 Podstawowe funkcje Ogólna dostępność
az apim api versionset create

Tworzy zestaw wersji interfejsu API.

 Podstawowe funkcje Ogólna dostępność
az apim api versionset delete

Usuwa określony zestaw wersji interfejsu API.

 Podstawowe funkcje Ogólna dostępność
az apim api versionset list

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

 Podstawowe funkcje Ogólna dostępność
az apim api versionset show

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

 Podstawowe funkcje Ogólna dostępność
az apim api versionset update

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

 Podstawowe funkcje Ogólna dostępność
az apim api wait

Umieść interfejs wiersza polecenia w stanie oczekiwania do momentu spełnienia warunku interfejsu API apim.

 Podstawowe funkcje Ogólna dostępność

az apim api create

Edytuj

Tworzenie interfejsu API usługi API Management.

az apim api create --api-id
                   --display-name
                   --path
                   --resource-group
                   --service-name
                   [--api-type {graphql, http, soap, websocket}]
                   [--authorization-scope]
                   [--authorization-server-id]
                   [--bearer-token-sending-methods]
                   [--description]
                   [--no-wait]
                   [--open-id-provider-id]
                   [--protocols {http, https, ws, wss}]
                   [--service-url]
                   [--subscription-key-header-name]
                   [--subscription-key-query-param-name]
                   [--subscription-key-required]
                   [--subscription-required {false, true}]

Przykłady

Tworzenie podstawowego interfejsu API.

az apim api create --service-name MyApim -g MyResourceGroup --api-id MyApi --path '/myapi' --display-name 'My API'

Parametry wymagane

--api-id

Unikatowa nazwa interfejsu API do utworzenia.

Identyfikator poprawki interfejsu API. Musi być unikatowa w bieżącym wystąpieniu usługi API Management. Nieobsługiwana poprawka ma wartość ; rev=n jako sufiks, gdzie n jest numerem poprawki.

--display-name

Nazwa wyświetlana interfejsu API do utworzenia.

--path

Ścieżka do 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-name -n

Nazwa wystąpienia usługi API Management.

Parametry opcjonalne

--api-type

Typ interfejsu API.

akceptowane wartości: graphql, http, soap, websocket
--authorization-scope

Określa zakres operacji OAuth.

--authorization-server-id

Określa identyfikator serwera autoryzacji OAuth.

--bearer-token-sending-methods

Określa metody wysyłania tokenu elementu nośnego.

--description

Opis interfejsu API. Może zawierać tagi formatowania HTML.

--no-wait

Nie czekaj na zakończenie długotrwałej operacji.

wartość domyślna: False
--open-id-provider-id

Określa identyfikator openid w ustawieniu uwierzytelniania.

--protocols

Opisuje, które protokoły mogą być wywoływane operacje w tym interfejsie API.

akceptowane wartości: http, https, ws, wss
--service-url

Bezwzględny adres URL usługi zaplecza implementowania tego interfejsu API. Długość nie może przekraczać 2000 znaków.

--subscription-key-header-name

Określa nazwę nagłówka klucza subskrypcji.

--subscription-key-query-param-name

Określa nazwę parametru ciągu zapytania klucza subskrypcji.

--subscription-key-required

Określa, czy klucz subskrypcji jest wymagany podczas wywoływania tego interfejsu API, prawda — interfejs API jest uwzględniany tylko w zamkniętych produktach, false — interfejs API jest uwzględniany tylko w otwartych produktach, wartość null — istnieje kombinacja produktów.

--subscription-required

Jeśli to prawda, interfejs API wymaga klucza subskrypcji dla żądań.

akceptowane wartości: false, true
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 apim api delete

Edytuj

Usuwanie interfejsu API usługi API Management.

az apim api delete --api-id
                   --resource-group
                   --service-name
                   [--delete-revisions]
                   [--if-match]
                   [--no-wait]
                   [--yes]

Parametry wymagane

--api-id

Identyfikator interfejsu API. Musi być unikatowa w bieżącym wystąpieniu usługi API Management. Nieobsługiwana poprawka ma wartość ; rev=n jako sufiks, gdzie n jest numerem poprawki.

--resource-group -g

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

--service-name -n

Nazwa wystąpienia usługi API Management.

Parametry opcjonalne

--delete-revisions

Usuń wszystkie poprawki interfejsu API.

--if-match

Element ETag jednostki.

--no-wait

Nie czekaj na zakończenie długotrwałej operacji.

wartość domyślna: False
--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 apim api export

Edytuj

Eksportowanie interfejsu API usługi API Management.

az apim api export --api-id
                   --ef {OpenApiJsonFile, OpenApiJsonUrl, OpenApiYamlFile, OpenApiYamlUrl, SwaggerFile, SwaggerUrl, WadlFile, WadlUrl, WsdlFile, WsdlUrl}
                   --resource-group
                   --service-name
                   [--file-path]

Przykłady

Eksportowanie interfejsu API usługi API Management do pliku lub zwraca odpowiedź zawierającą link eksportu.

az apim api export -g MyResourceGroup --service-name MyApim --api-id MyApi --export-format OpenApiJson --file-path path

Parametry wymagane

--api-id

Identyfikator interfejsu API. Musi być unikatowa w bieżącym wystąpieniu usługi API Management. Nieobsługiwana poprawka ma wartość ; rev=n jako sufiks, gdzie n jest numerem poprawki. Wzorzec wyrażenia regularnego: ^[^*#&+:<>?] +$.

--ef --export-format

Określ format eksportu interfejsu API.

akceptowane wartości: OpenApiJsonFile, OpenApiJsonUrl, OpenApiYamlFile, OpenApiYamlUrl, SwaggerFile, SwaggerUrl, WadlFile, WadlUrl, WsdlFile, WsdlUrl
--resource-group -g

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

--service-name -n

Nazwa wystąpienia usługi API Management.

Parametry opcjonalne

--file-path -f

Ścieżka pliku określona do wyeksportowania 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 apim api import

Edytuj

Importowanie interfejsu API usługi API Management.

az apim api import --path
                   --resource-group
                   --service-name
                   --specification-format {GraphQL, OpenApi, OpenApiJson, Swagger, Wadl, Wsdl}
                   [--api-id]
                   [--api-revision]
                   [--api-type {graphql, http, soap, websocket}]
                   [--api-version]
                   [--api-version-set-id]
                   [--description]
                   [--display-name]
                   [--no-wait]
                   [--protocols {http, https, ws, wss}]
                   [--service-url]
                   [--soap-api-type]
                   [--specification-path]
                   [--specification-url]
                   [--subscription-key-header-name]
                   [--subscription-key-query-param-name]
                   [--subscription-required {false, true}]
                   [--wsdl-endpoint-name]
                   [--wsdl-service-name]

Przykłady

Importowanie interfejsu API usługi API Management z pliku lub adresu URL

az apim api import -g MyResourceGroup --service-name MyApim --path MyApi --specification-url https://MySpecificationURL --specification-format OpenApiJson

Parametry wymagane

--path

Wymagany. Względny adres URL jednoznacznie identyfikujący ten interfejs API i wszystkie jego ścieżki zasobów w wystąpieniu usługi API Management.

--resource-group -g

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

--service-name -n

Nazwa wystąpienia usługi API Management.

--specification-format

Określ format zaimportowanego interfejsu API.

akceptowane wartości: GraphQL, OpenApi, OpenApiJson, Swagger, Wadl, Wsdl

Parametry opcjonalne

--api-id

Identyfikator interfejsu API. Musi być unikatowa w bieżącym wystąpieniu usługi API Management. Nieobsługiwana poprawka ma wartość ; rev=n jako sufiks, gdzie n jest numerem poprawki.

--api-revision

Opisuje poprawkę interfejsu API. Jeśli nie podano żadnej wartości, zostanie utworzona domyślna wersja 1.

--api-type

Typ interfejsu API.

akceptowane wartości: graphql, http, soap, websocket
--api-version

Opisuje wersję interfejsu API. Jeśli dodasz wersję do interfejsu API innej niż wersja, oryginalna wersja zostanie automatycznie utworzona i odpowie na domyślny adres URL.

--api-version-set-id

Opisuje zestaw wersji, który ma być używany z interfejsem API.

--description

Opis interfejsu API. Może zawierać tagi formatowania HTML.

--display-name

Nazwa wyświetlana tego interfejsu API.

--no-wait

Nie czekaj na zakończenie długotrwałej operacji.

wartość domyślna: False
--protocols

Opisuje, które protokoły (co najmniej jeden) operacje w tym interfejsie API można wywołać.

akceptowane wartości: http, https, ws, wss
--service-url

Bezwzględny adres URL usługi zaplecza implementowania tego interfejsu API. Długość nie może przekraczać 2000 znaków.

--soap-api-type

Typ interfejsu API, gdy format pliku to WSDL.

--specification-path

Ścieżka pliku określona do zaimportowania interfejsu API.

--specification-url

Adres URL określony do zaimportowania interfejsu API.

--subscription-key-header-name

Określa nazwę nagłówka klucza subskrypcji.

--subscription-key-query-param-name

Określa nazwę parametru ciągu zapytania klucza subskrypcji.

--subscription-required

Jeśli to prawda, interfejs API wymaga klucza subskrypcji dla żądań.

akceptowane wartości: false, true
--wsdl-endpoint-name

Nazwa lokalna punktu końcowego WSDL (port) do zaimportowania.

--wsdl-service-name

Nazwa lokalna usługi WSDL do zaimportowania.

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 apim api list

Edytuj

Wyświetlanie listy interfejsów API usługi API Management.

az apim api list --resource-group
                 --service-name
                 [--filter-display-name]
                 [--skip]
                 [--top]

Parametry wymagane

--resource-group -g

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

--service-name -n

Nazwa wystąpienia usługi API Management.

Parametry opcjonalne

--filter-display-name

Filtr interfejsów API według displayName.

--skip

Liczba rekordów do pominięcia.

--top

Liczba rekordów do zwrócenia.

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 apim api show

Edytuj

Pokaż szczegóły interfejsu API usługi API Management.

az apim api show --api-id
                 --resource-group
                 --service-name

Parametry wymagane

--api-id

Identyfikator interfejsu API. Musi być unikatowa w bieżącym wystąpieniu usługi API Management. Nieobsługiwana poprawka ma wartość ; rev=n jako sufiks, gdzie n jest numerem poprawki.

--resource-group -g

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

--service-name

Nazwa wystąpienia usługi API Management.

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 apim api update

Edytuj

Aktualizowanie interfejsu API usługi API Management.

az apim api update --api-id
                   --resource-group
                   --service-name
                   [--add]
                   [--api-type {graphql, http, soap, websocket}]
                   [--description]
                   [--display-name]
                   [--force-string]
                   [--if-match]
                   [--no-wait]
                   [--path]
                   [--protocols {http, https, ws, wss}]
                   [--remove]
                   [--service-url]
                   [--set]
                   [--subscription-key-header-name]
                   [--subscription-key-query-param-name]
                   [--subscription-required {false, true}]
                   [--tags]

Przykłady

Tworzenie podstawowego interfejsu API.

az apim api update --service-name MyApim -g MyResourceGroup --api-id MyApi --description foo

Parametry wymagane

--api-id

Unikatowa nazwa interfejsu API do utworzenia.

Identyfikator poprawki interfejsu API. Musi być unikatowa w bieżącym wystąpieniu usługi API Management. Nieobsługiwana poprawka ma wartość ; rev=n jako sufiks, gdzie n jest numerem poprawki.

--resource-group -g

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

--service-name -n

Nazwa wystąpienia usługi API Management.

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 or JSON string>.

wartość domyślna: []
--api-type

Typ interfejsu API.

akceptowane wartości: graphql, http, soap, websocket
--description

Opis interfejsu API. Może zawierać tagi formatowania HTML.

--display-name

Nazwa interfejsu API. Musi mieć długość od 1 do 300 znaków.

--force-string

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

wartość domyślna: False
--if-match

Element ETag jednostki. Nie jest to wymagane podczas tworzenia jednostki, ale wymagane podczas aktualizowania jednostki. Wartość domyślna to Brak.

--no-wait

Nie czekaj na zakończenie długotrwałej operacji.

wartość domyślna: False
--path

Wymagany. Względny adres URL jednoznacznie identyfikujący ten interfejs API i wszystkie jego ścieżki zasobów w wystąpieniu usługi API Management.

--protocols

Opisuje, które protokoły mogą być wywoływane operacje w tym interfejsie API.

akceptowane wartości: http, https, ws, wss
--remove

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

wartość domyślna: []
--service-url

Bezwzględny adres URL usługi zaplecza implementowania tego interfejsu API. Długość nie może przekraczać 2000 znaków.

--set

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

wartość domyślna: []
--subscription-key-header-name

Określa nazwę nagłówka klucza subskrypcji.

--subscription-key-query-param-name

Określa nazwę parametru ciągu zapytania klucza subskrypcji.

--subscription-required

Jeśli to prawda, interfejs API wymaga klucza subskrypcji dla żądań.

akceptowane wartości: false, true
--tags

Tagi rozdzielone spacjami: klucz[=wartość] [key[=value] ...]. Użyj ciągu "", aby wyczyścić istniejące tagi.

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 apim api wait

Edytuj

Umieść interfejs wiersza polecenia w stanie oczekiwania do momentu spełnienia warunku interfejsu API apim.

az apim api wait --api-id
                 --name
                 --resource-group
                 [--created]
                 [--custom]
                 [--deleted]
                 [--exists]
                 [--interval]
                 [--timeout]
                 [--updated]

Przykłady

Umieść interfejs wiersza polecenia w stanie oczekiwania do momentu spełnienia warunku interfejsu APIm. (automatycznie wygenerowane)

az apim api wait --created --api-id MyApi --name MyApim --resource-group MyResourceGroup

Parametry wymagane

--api-id

Identyfikator poprawki interfejsu API. Musi być unikatowa w bieżącym wystąpieniu usługi API Management. Nieobsługiwana poprawka ma wartość ; rev=n jako sufiks, gdzie n jest numerem poprawki. Wymagany.

--name -n

Nazwa wystąpienia usługi API Management.

--resource-group -g

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

Parametry opcjonalne

--created

Zaczekaj na utworzenie polecenia "provisioningState" o godzinie "Succeeded".

wartość domyślna: False
--custom

Poczekaj, aż warunek spełnia niestandardowe zapytanie JMESPath. Np. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Poczekaj na usunięcie.

wartość domyślna: False
--exists

Zaczekaj, aż zasób istnieje.

wartość domyślna: False
--interval

Interwał sondowania w sekundach.

wartość domyślna: 30
--timeout

Maksymalny czas oczekiwania w sekundach.

wartość domyślna: 3600
--updated

Zaczekaj na zaktualizowanie stanu provisioningState o 'Powodzenie'.

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.