Udostępnij za pośrednictwem

az apim backend

Zarządzanie Azure API Management zapleczami.

Polecenia

Nazwa Opis Typ Stan
az apim backend create

Tworzenie lub aktualizowanie zaplecza usługi API Management.

 Rdzeń ogólna dostępność
az apim backend delete

Usuwanie zaplecza usługi API Management.

 Rdzeń ogólna dostępność
az apim backend list

Wyświetlanie listy zapleczy usługi API Management.

 Rdzeń ogólna dostępność
az apim backend show

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

 Rdzeń ogólna dostępność
az apim backend update

Aktualizowanie zaplecza usługi API Management.

 Rdzeń ogólna dostępność

az apim backend create

Edytuj

Tworzenie lub aktualizowanie zaplecza usługi API Management.

az apim backend create --backend-id
                       --protocol {http, soap}
                       --resource-group
                       --service-name
                       --url
                       [--acquire-policy-token]
                       [--change-reference]
                       [--description]
                       [--if-match]

Przykłady

Utwórz zaplecze.

az apim backend create --service-name MyApim -g MyResourceGroup --backend-id MyBackendId --url https://mybackend.com --protocol http

Parametry wymagane

--backend-id

Unikatowa nazwa zaplecza do utworzenia lub zaktualizowania.

Musi być unikatowy w bieżącym wystąpieniu usługi API Management.

Właściwość Wartość
Grupa parametrów: Backend Arguments
--protocol

Protokół używany do komunikowania się z usługą zaplecza.

Właściwość Wartość
Dopuszczalne wartości: http, soap
--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

Adres URL usługi zaplecza.

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.

--acquire-policy-token

Automatyczne uzyskiwanie tokenu Azure Policy dla tej operacji zasobu.

Właściwość Wartość
Grupa parametrów: Global Policy Arguments
--change-reference

Powiązany identyfikator odwołania do zmiany dla tej operacji zasobu.

Właściwość Wartość
Grupa parametrów: Global Policy Arguments
--description

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

--if-match

ETag podmiotu.

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 polecenia 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 backend delete

Edytuj

Usuwanie zaplecza usługi API Management.

az apim backend delete --backend-id
                       --resource-group
                       --service-name
                       [--acquire-policy-token]
                       [--change-reference]
                       [--if-match]
                       [--yes]

Przykłady

Usuwanie zaplecza w wystąpieniu usługi APIM.

az apim backend delete --resource-group MyResourceGroup --service-name MyServiceName --backend-id MyBackendId

Parametry wymagane

--backend-id

Identyfikator zaplecza.

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

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

--acquire-policy-token

Automatyczne uzyskiwanie tokenu Azure Policy dla tej operacji zasobu.

Właściwość Wartość
Grupa parametrów: Global Policy Arguments
--change-reference

Powiązany identyfikator odwołania do zmiany dla tej operacji zasobu.

Właściwość Wartość
Grupa parametrów: Global Policy Arguments
--if-match

ETag podmiotu.

--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 polecenia 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 backend list

Edytuj

Wyświetlanie listy zapleczy usługi API Management.

az apim backend list --resource-group
                     --service-name

Przykłady

Wyświetl listę wszystkich zapleczy w wystąpieniu usługi APIM.

az apim backend list --resource-group MyResourceGroup --service-name MyServiceName

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 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 polecenia 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 backend show

Edytuj

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

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

Przykłady

Pokaż szczegóły zaplecza w wystąpieniu usługi APIM.

az apim backend show --resource-group MyResourceGroup --service-name MyServiceName --backend-id MyBackendId

Parametry wymagane

--backend-id

Identyfikator zaplecza.

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

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 polecenia 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 backend update

Edytuj

Aktualizowanie zaplecza usługi API Management.

az apim backend update --backend-id
                       --resource-group
                       --service-name
                       [--acquire-policy-token]
                       [--add]
                       [--change-reference]
                       [--description]
                       [--force-string]
                       [--if-match]
                       [--protocol {http, soap}]
                       [--remove]
                       [--set]
                       [--url]

Przykłady

Aktualizowanie zaplecza.

az apim backend update --service-name MyApim -g MyResourceGroup --backend-id MyBackendId --url https://mynewbackend.com

Parametry wymagane

--backend-id

Unikatowa nazwa zaplecza do zaktualizowania.

Musi być unikatowy w bieżącym wystąpieniu usługi API Management.

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

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

--acquire-policy-token

Automatyczne uzyskiwanie tokenu Azure Policy dla tej operacji zasobu.

Właściwość Wartość
Grupa parametrów: Global Policy Arguments
--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ść: []
--change-reference

Powiązany identyfikator odwołania do zmiany dla tej operacji zasobu.

Właściwość Wartość
Grupa parametrów: Global Policy Arguments
--description

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

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

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

--protocol

Protokół używany do komunikowania się z usługą zaplecza. Możliwe wartości to: http, soap.

Właściwość Wartość
Dopuszczalne wartości: http, soap
--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ść: []
--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ść: []
--url

Adres URL usługi zaplecza.

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