Freigeben über

az apim nv

  • Referenz

Verwalten sie die benannten Werte der Azure-API-Verwaltung.

Befehle

Name Beschreibung Typ Status
az apim nv create

Erstellen Sie einen benannten Wert für die API-Verwaltung.

 Core Allgemein verfügbar
az apim nv delete

Löschen sie einen benannten Wert für die API-Verwaltung.

 Core Allgemein verfügbar
az apim nv list

Listen-API-Verwaltung benannte Werte.

 Core Allgemein verfügbar
az apim nv show

Details einer API-Verwaltung mit benannten Werten anzeigen.

 Core Allgemein verfügbar
az apim nv show-secret

Ruft den geheimen Schlüssel einer API-Verwaltung benannten Wert ab.

 Core Allgemein verfügbar
az apim nv update

Aktualisieren sie eine API-Verwaltung mit dem Namen "Wert".

 Core Allgemein verfügbar
az apim nv wait

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

 Core Allgemein verfügbar

az apim nv create

Bearbeiten

Erstellen Sie einen benannten Wert für die API-Verwaltung.

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.

Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein.

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

Optionale Parameter

--if-match

ETag der Entität.

--no-wait

Nicht auf den Abschluss lang andauernder Vorgänge warten

Standardwert: False
--secret

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

Zulässige Werte: false, true
Standardwert: False
--tags

Durch Leerzeichen getrennte 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.

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

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

Bearbeiten

Löschen sie einen benannten Wert für die API-Verwaltung.

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

Erforderliche Parameter

--named-value-id

Bezeichner des NamedValue-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-Verwaltungsdienstinstanz.

Optionale Parameter

--yes -y

Nicht zur Bestätigung auffordern

Standardwert: False
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.

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

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

Bearbeiten

Listen-API-Verwaltung benannte Werte.

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

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.

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

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

Bearbeiten

Details einer API-Verwaltung mit benannten Werten anzeigen.

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

Erforderliche Parameter

--named-value-id

Bezeichner des NamedValue-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-Verwaltungsdienstinstanz.

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.

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

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

Bearbeiten

Ruft den geheimen Schlüssel einer API-Verwaltung benannten Wert ab.

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

Erforderliche Parameter

--named-value-id

Bezeichner des NamedValue-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-Verwaltungsdienstinstanz.

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.

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

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

Bearbeiten

Aktualisieren sie eine API-Verwaltung mit dem Namen "Wert".

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

Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein.

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

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

Standardwert: []
--force-string

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

Standardwert: False
--if-match

ETag der Entität.

--remove

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

Standardwert: []
--secret

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

Zulässige Werte: false, true
--set

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

Standardwert: []
--tags

Durch Leerzeichen getrennte 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.

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

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

Bearbeiten

Platzieren Sie die CLI in einem Wartezustand, 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 Wartezustand, bis eine Bedingung einer 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 NamedValue-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-Verwaltungsdienstinstanz.

Optionale Parameter

--created

Warten Sie, bis sie mit 'provisioningState' unter 'Succeeded' erstellt wurde.

Standardwert: False
--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.

Standardwert: False
--exists

Warten Sie, bis die Ressource vorhanden ist.

Standardwert: False
--interval

Abrufintervall in Sekunden.

Standardwert: 30
--timeout

Maximale Wartezeit in Sekunden.

Standardwert: 3600
--updated

Warten Sie, bis sie mit provisioningState unter 'Succeeded' aktualisiert wurde.

Standardwert: False
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.

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

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.