az apim api operation

  • Odwołanie

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

Polecenia

Nazwa Opis Typ Stan
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 operation create

Edytuj

Tworzy nową operację w interfejsie API.

az apim api operation create --api-id
                             --display-name
                             --method
                             --resource-group
                             --service-name
                             --url-template
                             [--description]
                             [--if-match]
                             [--operation-id]
                             [--params]

Przykłady

Tworzy nową operację w interfejsie API z kilkoma parametrami

az apim api operation create --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId --url-template "/session/{param1}/{param2}" --method "GET" --display-name MyOperationName --description MyDescription --template-parameters name=param1 description=descriptionContent type=paramType required="true" --template-parameters name=param2 required="false" type="string"

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.

--display-name

Wymagany. Nazwa operacji.

--method

Wymagany. Prawidłowa metoda operacji HTTP. Typowe metody HTTP, takie jak GET, PUT, POST, ale nie tylko przez nie.

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

--url-template

Względny szablon adresu URL identyfikujący zasób docelowy dla tej operacji. Może zawierać parametry.

Parametry opcjonalne

--description

Opis operacji. Może zawierać tagi formatowania HTML.

--if-match

Element ETag jednostki.

--operation-id

Identyfikator operacji w interfejsie API. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.

--params --template-parameters -p

Kolekcja parametrów szablonu adresu URL.

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

Edytuj

Usuwa określoną operację w interfejsie API.

az apim api operation delete --api-id
                             --operation-id
                             --resource-group
                             --service-name
                             [--if-match]

Przykłady

Usuwa określoną operację w interfejsie API.

az apim api operation delete --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId --operation-id MyOperationId

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.

--operation-id

Identyfikator operacji w interfejsie API. Musi być unikatowa w bieżącym 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.

Parametry opcjonalne

--if-match

Element ETag jednostki.

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

Edytuj

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

az apim api operation list --api-id
                           --resource-group
                           --service-name

Przykłady

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

az apim api operation list --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId

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

Edytuj

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

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

Przykłady

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

az apim api operation show --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId --operation-id MyOperationId

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.

--operation-id

Identyfikator operacji w interfejsie API. Musi być unikatowa w bieżącym 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.

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

Edytuj

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

az apim api operation update --api-id
                             --operation-id
                             --resource-group
                             --service-name
                             [--add]
                             [--description]
                             [--display-name]
                             [--force-string]
                             [--if-match]
                             [--method]
                             [--remove]
                             [--set]
                             [--url-template]

Przykłady

Aktualizacje metoda, displayname, opis operacji w interfejsie API określonym przez jego identyfikator.

az apim api operation update --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId --operation-id MyOperationId --method "PUT" --display-name NewDisplayName --description NewDescription

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.

--operation-id

Identyfikator operacji w interfejsie API. Musi być unikatowa w bieżącym 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.

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: []
--description

Opis operacji. Może zawierać tagi formatowania HTML.

--display-name

Wymagany. Nazwa operacji.

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

--method

Wymagany. Prawidłowa metoda operacji HTTP. Typowe metody HTTP, takie jak GET, PUT, POST, ale nie tylko przez nie.

--remove

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

wartość domyślna: []
--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: []
--url-template

Względny szablon adresu URL identyfikujący zasób docelowy dla tej operacji. Może zawierać parametry.

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.