az apim api

Odwołanie

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

Polecenia

az apim api create	Tworzenie interfejsu API API Management.
az apim api delete	Usuń interfejs API API Management.
az apim api import	Zaimportuj interfejs API API Management.
az apim api list	Wyświetl listę API Management interfejsów API.
az apim api operation	Zarządzanie operacjami interfejsu API usługi Azure API Management.
az apim api operation create	Tworzy nową operację w interfejsie API.
az apim api operation delete	Usuwa określoną operację w interfejsie API.
az apim api operation list	Wyświetlanie listy kolekcji operacji dla określonego interfejsu API.
az apim api operation show	Pobiera szczegóły operacji interfejsu API określonej przez jej identyfikator.
az apim api operation update	Aktualizacje szczegóły operacji w interfejsie API określonym przez jego identyfikator.
az apim api release	Zarządzanie wydaniem interfejsu API usługi Azure API Management.
az apim api release create	Tworzy nowe wydanie dla interfejsu API.
az apim api release delete	Usuwa określoną wersję w interfejsie API.
az apim api release list	Wyświetla listę wszystkich wydań interfejsu API.
az apim api release show	Zwraca szczegóły wydania interfejsu API.
az apim api release update	Aktualizacje szczegóły wydania interfejsu API określonego przez jego identyfikator.
az apim api revision	Zarządzanie poprawką interfejsu API usługi Azure API Management.
az apim api revision create	Utwórz poprawkę interfejsu API.
az apim api revision list	Wyświetla listę wszystkich poprawek interfejsu API.
az apim api schema	Zarządzanie schematami interfejsu API usługi Azure API Management.
az apim api schema create	Utwórz schemat interfejsu API API Management.
az apim api schema delete	Usuń schemat interfejsu API API Management.
az apim api schema get-etag	Pobierz element etag schematu interfejsu API API Management.
az apim api schema list	Wyświetl listę schematów interfejsu API API Management.
az apim api schema show	Pokaż szczegóły schematu interfejsu API API Management.
az apim api schema wait	Umieść interfejs wiersza polecenia w stanie oczekiwania do momentu spełnienia warunku schematu interfejsu APIm.
az apim api show	Pokaż szczegóły interfejsu API API Management.
az apim api update	Aktualizowanie interfejsu API API Management.
az apim api versionset	Zarządzanie zestawem wersji interfejsu API usługi Azure API Management.
az apim api versionset create	Tworzy zestaw wersji interfejsu API.
az apim api versionset delete	Usuwa określony zestaw wersji interfejsu API.
az apim api versionset list	Wyświetla listę kolekcji zestawów wersji interfejsu API w określonym wystąpieniu usługi.
az apim api versionset show	Pobiera szczegóły zestawu wersji interfejsu API określonego przez jego identyfikator.
az apim api versionset update	Aktualizacje szczegóły zestawu wersji interfejsu API określonego przez jego identyfikator.
az apim api wait	Umieść interfejs wiersza polecenia w stanie oczekiwania do momentu spełnienia warunku interfejsu APIm.

az apim api create

Edytuj

Tworzenie interfejsu API 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.

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

--open-id-provider-id

Określa identyfikator openid w ustawieniu uwierzytelniania.

--protocols

Opisuje, na których protokołach można wywołać 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. Nie można mieć więcej niż 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 w samych otwartych produktach, null — istnieje kombinacja produktów.

--subscription-required

Jeśli jest to prawda, interfejs API wymaga klucza subskrypcji na żądaniach.

akceptowane wartości: false, true

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.

--query

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

--subscription

Nazwa lub identyfikator subskrypcji. Możesz skonfigurować domyślną subskrypcję przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

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

az apim api delete

Edytuj

Usuń interfejs API 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. Nieistniena 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

ETag jednostki.

--no-wait

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

--yes -y

Nie monituj o potwierdzenie.

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.

--query

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

--subscription

Nazwa lub identyfikator subskrypcji. Możesz skonfigurować domyślną subskrypcję przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

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

az apim api import

Edytuj

Zaimportuj interfejs API API Management.

az apim api import --path
                   --resource-group
                   --service-name
                   --specification-format {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 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

Wymagane. 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: OpenApi, OpenApiJson, Swagger, Wadl, Wsdl

Parametry opcjonalne

--api-id

Identyfikator interfejsu API. Musi być unikatowa w bieżącym wystąpieniu usługi API Management. Nieistniena 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 poprawka 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 bez wersji, 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.

--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. Nie można mieć więcej niż 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 jest to prawda, interfejs API wymaga klucza subskrypcji na żądaniach.

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.

--query

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

--subscription

Nazwa lub identyfikator subskrypcji. Możesz skonfigurować domyślną subskrypcję przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

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

az apim api list

Edytuj

Wyświetl listę API Management interfejsów API.

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.

--query

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

--subscription

Nazwa lub identyfikator subskrypcji. Możesz skonfigurować domyślną subskrypcję przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

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

az apim api show

Edytuj

Pokaż szczegóły interfejsu API 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. Nieistniena 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.

--query

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

--subscription

Nazwa lub identyfikator subskrypcji. Możesz skonfigurować domyślną subskrypcję przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

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

az apim api update

Edytuj

Aktualizowanie interfejsu API 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.

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

--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ć przekonwertować na kod JSON.

--if-match

ETag jednostki. Nie jest wymagane podczas tworzenia jednostki, ale wymagane podczas aktualizowania jednostki.

--no-wait

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

--path

Wymagane. 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, na których protokołach można wywołać 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 OR --remove propertyToRemove.

--service-url

Bezwzględny adres URL usługi zaplecza implementowania tego interfejsu API. Nie można mieć więcej niż 2000 znaków.

--set

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

--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 jest to prawda, interfejs API wymaga klucza subskrypcji na żądaniach.

akceptowane wartości: false, true

--tags

Tagi rozdzielone spacjami: klucz[=wartość] [klucz[=wartość] ...]. 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.

--query

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

--subscription

Nazwa lub identyfikator subskrypcji. Możesz skonfigurować domyślną subskrypcję przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

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

az apim api wait

Edytuj

Umieść interfejs wiersza polecenia w stanie oczekiwania do momentu spełnienia warunku interfejsu 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. (generowane automatycznie)

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. Nieistniena poprawka ma wartość ;rev=n jako sufiks, gdzie n jest numerem poprawki.

--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" w lokalizacji "Powodzenie".

--custom

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

--deleted

Zaczekaj na usunięcie.

--exists

Zaczekaj, aż zasób istnieje.

--interval

Interwał sondowania w sekundach.

wartość domyślna: 30

--timeout

Maksymalny czas oczekiwania w sekundach.

wartość domyślna: 3600

--updated

Zaczekaj na aktualizację za pomocą parametru provisioningState w lokalizacji "Powodzenie".

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.

--query

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

--subscription

Nazwa lub identyfikator subskrypcji. Możesz skonfigurować domyślną subskrypcję przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

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