az apim nv

Verwalten von Azure API Management benannten Werten.

Befehle

az apim nv create	Erstellen Sie einen API Management benannten Wert.
az apim nv delete	Löschen Sie einen API Management benannten Wert.
az apim nv list	Liste API Management benannten Werten auf.
az apim nv show	Details eines API Management benannten Werts anzeigen.
az apim nv show-secret	Ruft den geheimen Schlüssel eines API Management benannten Werts ab.
az apim nv update	Aktualisieren eines API Management benannten Werts.
az apim nv wait	Platzieren Sie die CLI in einem Wartezeitstatus, bis eine Bedingung eines apim benannten Werts erfüllt ist.

az apim nv create

Erstellen Sie einen API Management benannten Wert.

az apim nv create --display-name
                  --named-value-id
                  --resource-group
                  --service-name
                  [--if-match]
                  [--no-wait]
                  [--secret {false, true}]
                  [--tags]
                  [--value]

Beispiele

Erstellen Sie einen benannten Wert.

az apim nv create --service-name MyApim -g MyResourceGroup --named-value-id MyNamedValue --display-name 'My Named Value' --value 'foo'

Erforderliche Parameter

--display-name

Der Anzeigename des benannten Werts.

--named-value-id

Eindeutiger Name für den zu erstellenden benannten Wert.

--resource-group -g

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

--service-name -n

Der Name der API Management Dienstinstanz.

Optionale Parameter

--if-match

ETag der Entität.

--no-wait

Nicht auf den Abschluss lang andauernder Vorgänge warten

--secret

Bestimmt, ob der Wert ein geheimer Schlüssel ist und ob er verschlüsselt werden sollte. Der Standardwert ist „false“.

Zulässige Werte: false, true

--tags

Leergetrennte Tags: key[=value] [key[=value] ...]. Verwenden Sie "", um vorhandene Tags zu löschen.

--value

Der Wert des benannten Werts.

Globale Parameter

--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

--query

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

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az apim nv delete

Löschen Sie einen API Management benannten Wert.

az apim nv delete --named-value-id
                  --resource-group
                  --service-name
                  [--yes]

Erforderliche Parameter

--named-value-id

Bezeichner des Benannten Werts.

--resource-group -g

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

--service-name -n

Der Name der API Management Dienstinstanz.

Optionale Parameter

--yes -y

Nicht zur Bestätigung auffordern

Globale Parameter

--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

--query

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

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az apim nv list

Liste API Management benannten Werten auf.

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

Erforderliche Parameter

--resource-group -g

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

--service-name -n

Der Name der API Management Dienstinstanz.

Globale Parameter

--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

--query

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

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az apim nv show

Details eines API Management benannten Werts anzeigen.

az apim nv show --named-value-id
                --resource-group
                --service-name

Erforderliche Parameter

--named-value-id

Bezeichner des Benannten Werts.

--resource-group -g

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

--service-name -n

Der Name der API Management Dienstinstanz.

Globale Parameter

--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

--query

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

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az apim nv show-secret

Ruft den geheimen Schlüssel eines API Management benannten Werts ab.

az apim nv show-secret --named-value-id
                       --resource-group
                       --service-name

Erforderliche Parameter

--named-value-id

Bezeichner des Benannten Werts.

--resource-group -g

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

--service-name -n

Der Name der API Management Dienstinstanz.

Globale Parameter

--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

--query

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

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az apim nv update

Aktualisieren eines API Management benannten Werts.

az apim nv update --named-value-id
                  --resource-group
                  --service-name
                  [--add]
                  [--force-string]
                  [--if-match]
                  [--remove]
                  [--secret {false, true}]
                  [--set]
                  [--tags]
                  [--value]

Beispiele

Erstellen Sie eine grundlegende API.

az apim nv update --service-name MyApim -g MyResourceGroup --named-value-id MyNamedValue --value foo

Erforderliche Parameter

--named-value-id

Eindeutiger Name der zu erstellenden API.

--resource-group -g

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

--service-name -n

Der Name der API Management Dienstinstanz.

Optionale Parameter

--add

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

--force-string

Wenn Sie "set" oder "add" verwenden, behalten Sie Zeichenfolgen literale beibehalten, anstatt zu versuchen, in JSON zu konvertieren.

--if-match

ETag der Entität.

--remove

Entfernen Sie eine Eigenschaft oder ein Element aus einer Liste. Beispiel: --remove property.list OR --remove propertyToRemove.

--secret

Bestimmt, ob der Wert ein geheimer Schlüssel ist und ob er verschlüsselt werden sollte. Der Standardwert ist „false“.

Zulässige Werte: false, true

--set

Aktualisieren Sie ein Objekt, indem Sie einen Eigenschaftenpfad und einen wert angeben, der festgelegt werden soll. Beispiel: --set-property1.property2=.

--tags

Leergetrennte Tags: key[=value] [key[=value] ...]. Verwenden Sie "", um vorhandene Tags zu löschen.

--value

Der Wert des benannten Werts.

Globale Parameter

--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

--query

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

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az apim nv wait

Platzieren Sie die CLI in einem Wartezeitstatus, bis eine Bedingung eines apim benannten Werts erfüllt ist.

az apim nv wait --named-value-id
                --resource-group
                --service-name
                [--created]
                [--custom]
                [--deleted]
                [--exists]
                [--interval]
                [--timeout]
                [--updated]

Beispiele

Platzieren Sie die CLI in einem Wartenstatus, bis eine Bedingung einer APIm-API erfüllt ist.

az apim nv wait --created --service-name MyApim -g MyResourceGroup --named-value-id MyNamedValue --resource-group MyResourceGroup

Erforderliche Parameter

--named-value-id

Bezeichner des Benannten Werts.

--resource-group -g

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

--service-name -n

Der Name der API Management Dienstinstanz.

Optionale Parameter

--created

Warten Sie, bis Sie mit "provisioningState" unter "Erfolgreich" erstellt wurden.

--custom

Warten Sie, bis die Bedingung eine benutzerdefinierte JMESPath-Abfrage erfüllt. Beispiel: provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Warten Sie, bis sie gelöscht wurde.

--exists

Warten Sie, bis die Ressource vorhanden ist.

--interval

Abfrageintervall in Sekunden.

Standardwert: 30

--timeout

Maximale Wartezeit in Sekunden.

Standardwert: 3600

--updated

Warten Sie, bis sie mit provisioningState unter "Erfolgreich" aktualisiert wurde.

Globale Parameter

--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

--query

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

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.