Udostępnij przez

az nginx deployment api-key

Note

To odwołanie jest częścią rozszerzenia nginx dla interfejsu wiersza polecenia platformy Azure (wersja 2.75.0 lub nowsza). Rozszerzenie zostanie automatycznie zainstalowane przy pierwszym uruchomieniu polecenia az nginx deployment api-key. Dowiedz się więcej o rozszerzeniach.

Zarządzanie kluczami interfejsu API wdrażania serwera Nginxaas.

Polecenia

Nazwa Opis Typ Stan
az nginx deployment api-key create

Utwórz klucz interfejsu API dla wdrożenia Nginx w celu uzyskania dostępu do punktu końcowego interfejsu API płaszczyzny danych.

 Extension ogólna dostępność
az nginx deployment api-key delete

Usuń klucz interfejsu API dla wdrożenia serwera Nginx.

 Extension ogólna dostępność
az nginx deployment api-key list

Wyświetl listę wszystkich kluczy interfejsu API danego wdrożenia serwera Nginx.

 Extension ogólna dostępność
az nginx deployment api-key show

Pobierz określony klucz interfejsu API danego wdrożenia Nginx.

 Extension ogólna dostępność
az nginx deployment api-key update

Zaktualizuj klucz interfejsu API dla wdrożenia Nginx, aby uzyskać dostęp do punktu końcowego interfejsu API płaszczyzny danych.

 Extension ogólna dostępność

az nginx deployment api-key create

Utwórz klucz interfejsu API dla wdrożenia Nginx w celu uzyskania dostępu do punktu końcowego interfejsu API płaszczyzny danych.

az nginx deployment api-key create --api-key-name --name
                                   --deployment-name
                                   --resource-group
                                   [--end-date-time]
                                   [--secret-text]

Wymagane parametry

--api-key-name --name -n

Nazwa zasobu klucza interfejsu API.

--deployment-name

Nazwa docelowego wdrożenia NGINX.

--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 z nich może stać się wymagany do pomyślnego wykonania polecenia.

--end-date-time

Czas, po którym ten klucz interfejsu API płaszczyzny danych nie jest już prawidłowy.

Własność Wartość
Grupa parametrów: Properties Arguments
--secret-text

Tekst tajny, który ma być używany jako klucz interfejsu API płaszczyzny danych. Jest to właściwość tylko do zapisu, która nigdy nie może być odczytywana, ale pierwsze trzy znaki zostaną zwrócone we właściwości "hint". Jeśli wartość jest pusta, zostanie wyświetlony monit z tty.

Własność Wartość
Grupa parametrów: Properties Arguments
Parametry globalne
--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

Własność Wartość
Wartość domyślna: False
--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

Własność Wartość
Wartość domyślna: False
--output -o

Format danych wyjściowych.

Własność Wartość
Wartość domyślna: json
Akceptowane 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łasność Wartość
Wartość domyślna: False

az nginx deployment api-key delete

Usuń klucz interfejsu API dla wdrożenia serwera Nginx.

az nginx deployment api-key delete [--api-key-name --name]
                                   [--deployment-name]
                                   [--ids]
                                   [--resource-group]
                                   [--subscription]
                                   [--yes]

Parametry opcjonalne

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

--api-key-name --name -n

Nazwa zasobu klucza interfejsu API.

Własność Wartość
Grupa parametrów: Resource Id Arguments
--deployment-name

Nazwa docelowego wdrożenia NGINX.

Własność Wartość
Grupa parametrów: Resource Id Arguments
--ids

Co najmniej jeden identyfikator zasobu (rozdzielany spacjami). Powinien to być kompletny identyfikator zasobu, zawierający wszystkie informacje dotyczące argumentów „Identyfikator zasobu”. Należy podać argumenty --ids lub inne argumenty "Identyfikator zasobu".

Własność Wartość
Grupa parametrów: Resource Id Arguments
--resource-group -g

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

Własność Wartość
Grupa parametrów: Resource Id Arguments
--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu az account set -s NAME_OR_ID.

Własność Wartość
Grupa parametrów: Resource Id Arguments
--yes -y

Nie monituj o potwierdzenie.

Własność Wartość
Wartość domyślna: False
Parametry globalne
--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

Własność Wartość
Wartość domyślna: False
--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

Własność Wartość
Wartość domyślna: False
--output -o

Format danych wyjściowych.

Własność Wartość
Wartość domyślna: json
Akceptowane 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.

--verbose

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

Własność Wartość
Wartość domyślna: False

az nginx deployment api-key list

Wyświetl listę wszystkich kluczy interfejsu API danego wdrożenia serwera Nginx.

az nginx deployment api-key list --deployment-name
                                 --resource-group
                                 [--max-items]
                                 [--next-token]

Wymagane parametry

--deployment-name

Nazwa docelowego wdrożenia NGINX.

--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 z nich może stać się wymagany do pomyślnego wykonania polecenia.

--max-items

Łączna liczba elementów do zwrócenia w danych wyjściowych polecenia. Jeśli łączna liczba dostępnych elementów jest większa niż określona wartość, token jest udostępniany w danych wyjściowych polecenia. Aby wznowić stronicowanie, podaj wartość tokenu w --next-token argumentu kolejnego polecenia.

Własność Wartość
Grupa parametrów: Pagination Arguments
--next-token

Token do określenia, gdzie rozpocząć stronicowanie. Jest to wartość tokenu z wcześniej obciętej odpowiedzi.

Własność Wartość
Grupa parametrów: Pagination Arguments
Parametry globalne
--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

Własność Wartość
Wartość domyślna: False
--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

Własność Wartość
Wartość domyślna: False
--output -o

Format danych wyjściowych.

Własność Wartość
Wartość domyślna: json
Akceptowane 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łasność Wartość
Wartość domyślna: False

az nginx deployment api-key show

Pobierz określony klucz interfejsu API danego wdrożenia Nginx.

az nginx deployment api-key show [--api-key-name --name]
                                 [--deployment-name]
                                 [--ids]
                                 [--resource-group]
                                 [--subscription]

Parametry opcjonalne

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

--api-key-name --name -n

Nazwa zasobu klucza interfejsu API.

Własność Wartość
Grupa parametrów: Resource Id Arguments
--deployment-name

Nazwa docelowego wdrożenia NGINX.

Własność Wartość
Grupa parametrów: Resource Id Arguments
--ids

Co najmniej jeden identyfikator zasobu (rozdzielany spacjami). Powinien to być kompletny identyfikator zasobu, zawierający wszystkie informacje dotyczące argumentów „Identyfikator zasobu”. Należy podać argumenty --ids lub inne argumenty "Identyfikator zasobu".

Własność Wartość
Grupa parametrów: Resource Id Arguments
--resource-group -g

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

Własność Wartość
Grupa parametrów: Resource Id Arguments
--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu az account set -s NAME_OR_ID.

Własność Wartość
Grupa parametrów: Resource Id Arguments
Parametry globalne
--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

Własność Wartość
Wartość domyślna: False
--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

Własność Wartość
Wartość domyślna: False
--output -o

Format danych wyjściowych.

Własność Wartość
Wartość domyślna: json
Akceptowane 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.

--verbose

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

Własność Wartość
Wartość domyślna: False

az nginx deployment api-key update

Zaktualizuj klucz interfejsu API dla wdrożenia Nginx, aby uzyskać dostęp do punktu końcowego interfejsu API płaszczyzny danych.

az nginx deployment api-key update [--add]
                                   [--api-key-name --name]
                                   [--deployment-name]
                                   [--end-date-time]
                                   [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--ids]
                                   [--remove]
                                   [--resource-group]
                                   [--secret-text]
                                   [--set]
                                   [--subscription]

Parametry opcjonalne

Poniższe parametry są opcjonalne, ale w zależności od kontekstu co najmniej jeden z nich może stać się 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łasność Wartość
Grupa parametrów: Generic Update Arguments
--api-key-name --name -n

Nazwa zasobu klucza interfejsu API.

Własność Wartość
Grupa parametrów: Resource Id Arguments
--deployment-name

Nazwa docelowego wdrożenia NGINX.

Własność Wartość
Grupa parametrów: Resource Id Arguments
--end-date-time

Czas, po którym ten klucz interfejsu API płaszczyzny danych nie jest już prawidłowy.

Własność Wartość
Grupa parametrów: Properties Arguments
--force-string

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

Własność Wartość
Grupa parametrów: Generic Update Arguments
Akceptowane wartości: 0, 1, f, false, n, no, t, true, y, yes
--ids

Co najmniej jeden identyfikator zasobu (rozdzielany spacjami). Powinien to być kompletny identyfikator zasobu, zawierający wszystkie informacje dotyczące argumentów „Identyfikator zasobu”. Należy podać argumenty --ids lub inne argumenty "Identyfikator zasobu".

Własność Wartość
Grupa parametrów: Resource Id Arguments
--remove

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

Własność Wartość
Grupa parametrów: Generic Update Arguments
--resource-group -g

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

Własność Wartość
Grupa parametrów: Resource Id Arguments
--secret-text

Tekst tajny, który ma być używany jako klucz interfejsu API płaszczyzny danych. Jest to właściwość tylko do zapisu, która nigdy nie może być odczytywana, ale pierwsze trzy znaki zostaną zwrócone we właściwości "hint". Jeśli wartość jest pusta, zostanie wyświetlony monit z tty.

Własność Wartość
Grupa parametrów: Properties Arguments
--set

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

Własność Wartość
Grupa parametrów: Generic Update Arguments
--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu az account set -s NAME_OR_ID.

Własność Wartość
Grupa parametrów: Resource Id Arguments
Parametry globalne
--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

Własność Wartość
Wartość domyślna: False
--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

Własność Wartość
Wartość domyślna: False
--output -o

Format danych wyjściowych.

Własność Wartość
Wartość domyślna: json
Akceptowane 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.

--verbose

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

Własność Wartość
Wartość domyślna: False