az monitor app-insights api-key

  • Referenz

Hinweis

Diese Referenz ist Teil der Application-Insights-Erweiterung für die Azure CLI (Version 2.55.0 oder höher). Die Erweiterung wird automatisch installiert, wenn Sie einen az monitor app-insights api-key-Befehl zum ersten Mal ausführen. Weitere Informationen zu Erweiterungen

Vorgänge auf API-Schlüsseln, die einer Application Insights-Komponente zugeordnet sind.

Befehle

Name Beschreibung Typ Status
az monitor app-insights api-key create

Erstellen Sie einen API-Schlüssel einer Application Insights-Komponente.

 Erweiterung Allgemein verfügbar
az monitor app-insights api-key delete

Löschen Sie einen API-Schlüssel aus einer Application Insights-Ressource.

 Erweiterung Allgemein verfügbar
az monitor app-insights api-key show

Rufen Sie alle Schlüssel oder einen bestimmten API-Schlüssel ab, der einer Application Insights-Ressource zugeordnet ist.

 Erweiterung Allgemein verfügbar

az monitor app-insights api-key create

Erstellen Sie einen API-Schlüssel einer Application Insights-Komponente.

az monitor app-insights api-key create --api-key
                                       --app
                                       --resource-group
                                       [--read-properties]
                                       [--write-properties]

Beispiele

Erstellen Sie eine Komponente mit artem Web und Speicherort.

az monitor app-insights api-key create --api-key cli-demo --read-properties ReadTelemetry --write-properties WriteAnnotations -g demoRg --app testApp

Erstellen einer Komponente mit artem Web und Standort ohne Berechtigung

az monitor app-insights api-key create --api-key cli-demo --read-properties '""' --write-properties '""' -g demoRg --app testApp

Erforderliche Parameter

--api-key

Name des zu erstellenden API-Schlüssels.

--app -a

GUID, App-Name oder vollqualifizierter Azure-Ressourcenname der Application Insights-Komponente. Die Anwendungs-GUID kann über das MENÜelement "API Access" in einer beliebigen Application Insights-Ressource im Azure-Portal abgerufen werden. Wenn Sie einen Anwendungsnamen verwenden, geben Sie die Ressourcengruppe an.

--resource-group -g

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

Optionale Parameter

--read-properties

Eine durch Leerzeichen getrennte Liste der Namen der leserollen für diesen API-Schlüssel, der geerbt werden soll. Unterstützung von Shorthand-Syntax, JSON-Datei und Yaml-Datei. Probieren Sie "??" aus, um mehr anzuzeigen.

--write-properties

Eine durch Leerzeichen getrennte Liste der Namen von Schreibrollen für diesen API-Schlüssel, der geerbt werden soll. Unterstützung von Shorthand-Syntax, JSON-Datei und Yaml-Datei. Probieren Sie "??" aus, um mehr anzuzeigen.

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 monitor app-insights api-key delete

Löschen Sie einen API-Schlüssel aus einer Application Insights-Ressource.

az monitor app-insights api-key delete [--api-key]
                                       [--app]
                                       [--ids]
                                       [--resource-group]
                                       [--subscription]
                                       [--yes]

Beispiele

API-Schlüssel löschen.

az monitor app-insights api-key delete --app demoApp -g demoRg --api-key demo-key

Optionale Parameter

--api-key

Name des zu löschenden API-Schlüssels. Dies finden Sie unter Verwendung von api-key show.

--app -a

GUID, App-Name oder vollqualifizierter Azure-Ressourcenname der Application Insights-Komponente. Die Anwendungs-GUID kann über das MENÜelement "API Access" in einer beliebigen Application Insights-Ressource im Azure-Portal abgerufen werden. Wenn Sie einen Anwendungsnamen verwenden, geben Sie die Ressourcengruppe an.

--ids

Eine oder mehrere 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

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

--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 monitor app-insights api-key show

Rufen Sie alle Schlüssel oder einen bestimmten API-Schlüssel ab, der einer Application Insights-Ressource zugeordnet ist.

az monitor app-insights api-key show --app
                                     --resource-group
                                     [--api-key]

Beispiele

API-Schlüssel abrufen.

az monitor app-insights api-key show --app demoApp -g demoRg --api-key demo-key

API-Schlüssel abrufen.

az monitor app-insights api-key show --app demoApp -g demoRg

Erforderliche Parameter

--app -a

Der Name der Application Insights-Komponentenressource.

--resource-group -g

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

Optionale Parameter

--api-key

Name des abzurufenden API-Schlüssels. Dies finden Sie unter Verwendung von api-key show.

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.