az apim api

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.	Core	ogólna dostępność
az apim api delete	Usuwanie interfejsu API usługi API Management.	Core	ogólna dostępność
az apim api export	Eksportowanie interfejsu API usługi API Management.	Core	ogólna dostępność
az apim api import	Importowanie interfejsu API usługi API Management.	Core	ogólna dostępność
az apim api list	Wyświetlanie listy interfejsów API usługi API Management.	Core	ogólna dostępność
az apim api operation	Zarządzanie operacjami interfejsu API usługi Azure API Management.	Core	ogólna dostępność
az apim api operation create	Tworzy nową operację w interfejsie API.	Core	ogólna dostępność
az apim api operation delete	Usuwa określoną operację w interfejsie API.	Core	ogólna dostępność
az apim api operation list	Wyświetlanie listy kolekcji operacji dla określonego interfejsu API.	Core	ogólna dostępność
az apim api operation show	Pobiera szczegóły operacji interfejsu API określonej przez jego identyfikator.	Core	ogólna dostępność
az apim api operation update	Aktualizuje szczegóły operacji w interfejsie API określonym przez jego identyfikator.	Core	ogólna dostępność
az apim api release	Zarządzanie wydaniem interfejsu API usługi Azure API Management.	Core	ogólna dostępność
az apim api release create	Tworzy nową wersję dla interfejsu API.	Core	ogólna dostępność
az apim api release delete	Usuwa określoną wersję w interfejsie API.	Core	ogólna dostępność
az apim api release list	Wyświetla listę wszystkich wydań interfejsu API.	Core	ogólna dostępność
az apim api release show	Zwraca szczegóły wydania interfejsu API.	Core	ogólna dostępność
az apim api release update	Aktualizuje szczegóły wydania interfejsu API określonego przez jego identyfikator.	Core	ogólna dostępność
az apim api revision	Zarządzanie poprawką interfejsu API usługi Azure API Management.	Core	ogólna dostępność
az apim api revision create	Utwórz poprawkę interfejsu API.	Core	ogólna dostępność
az apim api revision list	Wyświetla listę wszystkich poprawek interfejsu API.	Core	ogólna dostępność
az apim api schema	Zarządzanie schematami interfejsu API usługi Azure API Management.	Core	ogólna dostępność
az apim api schema create	Tworzenie schematu interfejsu API usługi API Management.	Core	ogólna dostępność
az apim api schema delete	Usuwanie schematu interfejsu API usługi API Management.	Core	ogólna dostępność
az apim api schema get-etag	Pobierz element etag schematu interfejsu API usługi API Management.	Core	ogólna dostępność
az apim api schema list	Wyświetlanie listy schematów interfejsu API usługi API Management.	Core	ogólna dostępność
az apim api schema show	Pokaż szczegóły schematu interfejsu API usługi API Management.	Core	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.	Core	ogólna dostępność
az apim api show	Pokaż szczegóły interfejsu API usługi API Management.	Core	ogólna dostępność
az apim api update	Aktualizowanie interfejsu API usługi API Management.	Core	ogólna dostępność
az apim api versionset	Zarządzanie zestawem wersji interfejsu API usługi Azure API Management.	Core	ogólna dostępność
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 wait	Umieść interfejs wiersza polecenia w stanie oczekiwania do momentu spełnienia warunku interfejsu API apim.	Core	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.

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

--display-name

Nazwa wyświetlana interfejsu API do utworzenia.

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

--path

Ścieżka do interfejsu API.

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

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

Typ interfejsu API.

Właściwość	Wartość
Grupa parametrów:	API Arguments
Dopuszczalne 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.

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

--no-wait

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

Właściwość	Wartość
Domyślna wartość:	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.

Właściwość	Wartość
Grupa parametrów:	API Arguments
Dopuszczalne 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.

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

--subscription-key-header-name

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

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

--subscription-key-query-param-name

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

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

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

Właściwość	Wartość
Grupa parametrów:	API Arguments
Domyślna wartość:	False
Dopuszczalne wartości:	false, true

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

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

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

--delete-revisions

Usuń wszystkie poprawki interfejsu API.

--if-match

Element ETag jednostki.

--no-wait

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

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

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

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

Edytuj

Eksportowanie interfejsu API usługi API Management.

az apim api export --api-id
                   --ef --export-format {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: ^[^*#&+:<>?]+$.

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

--ef --export-format

Określ format eksportu interfejsu API.

Właściwość	Wartość
Dopuszczalne 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

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

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

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

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

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

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

--specification-format

Określ format zaimportowanego interfejsu API.

Właściwość	Wartość
Dopuszczalne wartości:	GraphQL, OpenApi, OpenApiJson, Swagger, Wadl, Wsdl

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

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

--api-revision

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

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

--api-type

Typ interfejsu API.

Właściwość	Wartość
Grupa parametrów:	API Arguments
Dopuszczalne 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.

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

--api-version-set-id

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

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

--description

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

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

--display-name

Nazwa wyświetlana tego interfejsu API.

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

--no-wait

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

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

--protocols

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

Właściwość	Wartość
Grupa parametrów:	API Arguments
Dopuszczalne 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.

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

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

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

--subscription-key-query-param-name

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

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

--subscription-required

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

Właściwość	Wartość
Grupa parametrów:	API Arguments
Dopuszczalne 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.

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

--service-name -n

Nazwa wystąpienia usługi API Management.

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

Filtr interfejsów API według displayName.

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

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

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

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

--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu 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.

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

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

--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 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ść:	[]

--api-type

Typ interfejsu API.

Właściwość	Wartość
Grupa parametrów:	API Arguments
Dopuszczalne wartości:	graphql, http, soap, websocket

--description

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

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

--display-name

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

Właściwość	Wartość
Grupa parametrów:	API 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
Domyślna wartość:	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.

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

--path

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

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

--protocols

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

Właściwość	Wartość
Grupa parametrów:	API Arguments
Dopuszczalne wartości:	http, https, ws, wss

--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ść:	[]

--service-url

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

Właściwość	Wartość
Grupa parametrów:	API 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
Domyślna wartość:	[]

--subscription-key-header-name

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

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

--subscription-key-query-param-name

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

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

--subscription-required

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

Właściwość	Wartość
Grupa parametrów:	API Arguments
Dopuszczalne 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.

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 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. (autogenerated)

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

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

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.

--created

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

Właściwość	Wartość
Grupa parametrów:	Wait Condition Arguments
Domyślna wartość:	False

--custom

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

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

--deleted

Poczekaj na usunięcie.

Właściwość	Wartość
Grupa parametrów:	Wait Condition Arguments
Domyślna wartość:	False

--exists

Zaczekaj, aż zasób istnieje.

Właściwość	Wartość
Grupa parametrów:	Wait Condition Arguments
Domyślna wartość:	False

--interval

Interwał sondowania w sekundach.

Właściwość	Wartość
Grupa parametrów:	Wait Condition Arguments
Domyślna wartość:	30

--timeout

Maksymalny czas oczekiwania w sekundach.

Właściwość	Wartość
Grupa parametrów:	Wait Condition Arguments
Domyślna wartość:	3600

--updated

Zaczekaj na zaktualizowanie stanu provisioningState o 'Powodzenie'.

Właściwość	Wartość
Grupa parametrów:	Wait Condition Arguments
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.

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

Sprzężenie zwrotne

Czy ta strona była pomocna?

Udostępnij przez

az apim api

Polecenia

az apim api create

Przykłady

Parametry wymagane

Parametry opcjonalne

az apim api delete

Parametry wymagane

Parametry opcjonalne

az apim api export

Przykłady

Parametry wymagane

Parametry opcjonalne

az apim api import

Przykłady

Parametry wymagane

Parametry opcjonalne

az apim api list

Parametry wymagane

Parametry opcjonalne

az apim api show

Parametry wymagane

az apim api update

Przykłady

Parametry wymagane

Parametry opcjonalne

az apim api wait

Przykłady

Parametry wymagane

Parametry opcjonalne

Sprzężenie zwrotne