Freigeben über

az nginx deployment api-key

  • Referenz

Anmerkung

Diese Referenz ist Teil der nginx-Erweiterung für die Azure CLI (Version 2.68.0 oder höher). Die Erweiterung wird beim ersten Ausführen eines az nginx-Bereitstellungs-API-Schlüssels automatisch Befehl installiert. Erfahren Sie mehr über Erweiterungen.

Verwalten von Nginxaas-Bereitstellungs-API-Schlüsseln.

Befehle

Name Beschreibung Typ Status
az nginx deployment api-key create

Erstellen Sie einen API-Schlüssel für die Nginx-Bereitstellung, um auf den Datenplan-API-Endpunkt zuzugreifen.

 Erweiterung GA
az nginx deployment api-key delete

Löschen sie den API-Schlüssel für die Nginx-Bereitstellung.

 Erweiterung GA
az nginx deployment api-key list

Auflisten aller API-Schlüssel der angegebenen Nginx-Bereitstellung.

 Erweiterung GA
az nginx deployment api-key show

Rufen Sie den angegebenen API-Schlüssel der angegebenen Nginx-Bereitstellung ab.

 Erweiterung GA
az nginx deployment api-key update

Aktualisieren Sie einen API-Schlüssel für die Nginx-Bereitstellung, um auf den Datenplan-API-Endpunkt zuzugreifen.

 Erweiterung GA

az nginx deployment api-key create

Erstellen Sie einen API-Schlüssel für die Nginx-Bereitstellung, um auf den Datenplan-API-Endpunkt zuzugreifen.

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

Erforderliche Parameter

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

Der Ressourcenname des API-Schlüssels.

--deployment-name

Der Name der gezielten NGINX-Bereitstellung.

--resource-group -g

Name der Ressourcengruppe. Sie können die Standardgruppe mit az configure --defaults group=<name>konfigurieren.

Optionale Parameter

--end-date-time

Die Zeit, nach der dieser Dataplane-API-Schlüssel nicht mehr gültig ist.

--secret-text

Geheimer Text, der als Dataplane-API-Schlüssel verwendet werden soll. Dies ist eine schreibgeschützte Eigenschaft, die nie zurückgelesen werden kann, aber die ersten drei Zeichen werden in der Eigenschaft "hint" zurückgegeben. Wenn der Wert leer ist, wird er von der tty gefragt.

Globale Parameter
--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

--help -h

Diese Hilfenachricht anzeigen und beenden.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

az nginx deployment api-key delete

Löschen sie den API-Schlüssel für die Nginx-Bereitstellung.

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

Optionale Parameter

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

Der Ressourcenname des API-Schlüssels.

--deployment-name

Der Name der gezielten NGINX-Bereitstellung.

--ids

Mindestens eine Ressourcen-IDs (durch Leerzeichen getrennt). Dabei sollte es sich um eine vollständige Ressourcen-ID mit allen Informationen der Argumente "Ressourcen-ID" sein. Sie sollten entweder --ids oder andere Argumente für die Ressourcen-ID angeben.

--resource-group -g

Name der Ressourcengruppe. Sie können die Standardgruppe mit az configure --defaults group=<name>konfigurieren.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--yes -y

Zur Bestätigung nicht auffordern.

Standardwert: False
Globale Parameter
--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

--help -h

Diese Hilfenachricht anzeigen und beenden.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

az nginx deployment api-key list

Auflisten aller API-Schlüssel der angegebenen Nginx-Bereitstellung.

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

Erforderliche Parameter

--deployment-name

Der Name der gezielten NGINX-Bereitstellung.

--resource-group -g

Name der Ressourcengruppe. Sie können die Standardgruppe mit az configure --defaults group=<name>konfigurieren.

Optionale Parameter

--max-items

Die Gesamtanzahl der Elemente, die in der Ausgabe des Befehls zurückgegeben werden sollen. Wenn die Gesamtanzahl der verfügbaren Elemente größer als der angegebene Wert ist, wird ein Token in der Ausgabe des Befehls bereitgestellt. Um die Paginierung fortzusetzen, geben Sie den Tokenwert in --next-token Argument eines nachfolgenden Befehls an.

--next-token

Token, das angibt, wo die Paginierung beginnen soll. Dies ist der Tokenwert aus einer zuvor abgeschnittenen Antwort.

Globale Parameter
--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

--help -h

Diese Hilfenachricht anzeigen und beenden.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

az nginx deployment api-key show

Rufen Sie den angegebenen API-Schlüssel der angegebenen Nginx-Bereitstellung ab.

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

Optionale Parameter

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

Der Ressourcenname des API-Schlüssels.

--deployment-name

Der Name der gezielten NGINX-Bereitstellung.

--ids

Mindestens eine Ressourcen-IDs (durch Leerzeichen getrennt). Dabei sollte es sich um eine vollständige Ressourcen-ID mit allen Informationen der Argumente "Ressourcen-ID" sein. Sie sollten entweder --ids oder andere Argumente für die Ressourcen-ID angeben.

--resource-group -g

Name der Ressourcengruppe. Sie können die Standardgruppe mit az configure --defaults group=<name>konfigurieren.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

Globale Parameter
--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

--help -h

Diese Hilfenachricht anzeigen und beenden.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

az nginx deployment api-key update

Aktualisieren Sie einen API-Schlüssel für die Nginx-Bereitstellung, um auf den Datenplan-API-Endpunkt zuzugreifen.

az nginx deployment api-key update [--add]
                                   [--api-key-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]

Optionale Parameter

--add

Fügen Sie einer Liste von Objekten ein Objekt hinzu, indem Sie ein Pfad- und Schlüsselwertpaar angeben. Beispiel: --add property.listProperty <key=value, string or JSON string>.

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

Der Ressourcenname des API-Schlüssels.

--deployment-name

Der Name der gezielten NGINX-Bereitstellung.

--end-date-time

Die Zeit, nach der dieser Dataplane-API-Schlüssel nicht mehr gültig ist.

--force-string

Wenn Sie "set" oder "add" verwenden, behalten Sie Zeichenfolgenliterale bei, anstatt zu versuchen, in JSON zu konvertieren.

Zulässige Werte: 0, 1, f, false, n, no, t, true, y, yes
--ids

Mindestens eine Ressourcen-IDs (durch Leerzeichen getrennt). Dabei sollte es sich um eine vollständige Ressourcen-ID mit allen Informationen der Argumente "Ressourcen-ID" sein. Sie sollten entweder --ids oder andere Argumente für die Ressourcen-ID angeben.

--remove

Entfernen sie eine Eigenschaft oder ein Element aus einer Liste. Beispiel: --remove property.list <indexToRemove> ODER --remove propertyToRemove.

--resource-group -g

Name der Ressourcengruppe. Sie können die Standardgruppe mit az configure --defaults group=<name>konfigurieren.

--secret-text

Geheimer Text, der als Dataplane-API-Schlüssel verwendet werden soll. Dies ist eine schreibgeschützte Eigenschaft, die nie zurückgelesen werden kann, aber die ersten drei Zeichen werden in der Eigenschaft "hint" zurückgegeben. Wenn der Wert leer ist, wird er von der tty gefragt.

--set

Aktualisieren Sie ein Objekt, indem Sie einen festzulegenden Eigenschaftspfad und -wert angeben. Beispiel: --set property1.property2=<value>.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

Globale Parameter
--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

--help -h

Diese Hilfenachricht anzeigen und beenden.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.