Freigeben über


az cosmosdb sql role definition

Verwalten Azure Cosmos DB SQL-Rollendefinitionen.

Befehle

Name Beschreibung Typ Status
az cosmosdb sql role definition create

Erstellen Sie eine SQL-Rollendefinition unter einem Azure Cosmos DB Konto.

Core GA
az cosmosdb sql role definition delete

Löschen Sie eine SQL-Rollendefinition unter einem Azure Cosmos DB Konto.

Core GA
az cosmosdb sql role definition exists

Überprüfen Sie, ob eine Azure Cosmos DB Rollendefinition vorhanden ist.

Core GA
az cosmosdb sql role definition list

Auflisten aller SQL-Rollendefinitionen unter einem Azure Cosmos DB Konto.

Core GA
az cosmosdb sql role definition show

Zeigen Sie die Eigenschaften einer SQL-Rollendefinition unter einem Azure Cosmos DB Konto an.

Core GA
az cosmosdb sql role definition update

Aktualisieren sie eine SQL-Rollendefinition unter einem Azure Cosmos DB Konto.

Core GA
az cosmosdb sql role definition wait

Abrufen einer SQL-Rollendefinition, bis eine bestimmte Bedingung erfüllt ist.

Core GA

az cosmosdb sql role definition create

Erstellen Sie eine SQL-Rollendefinition unter einem Azure Cosmos DB Konto.

az cosmosdb sql role definition create --account-name
                                       --body
                                       --resource-group
                                       [--acquire-policy-token]
                                       [--change-reference]
                                       [--no-wait]

Beispiele

Erstellen Sie eine SQL-Rollendefinition unter einem Azure Cosmos DB-Konto mithilfe einer JSON-Zeichenfolge.

az cosmosdb sql role definition create --account-name MyAccount --resource-group MyResourceGroup --body '{
  "Id": "be79875a-2cc4-40d5-8958-566017875b39",
  "RoleName": "My Read Only Role",
  "Type": "CustomRole",
  "AssignableScopes": ["/dbs/mydb/colls/mycontainer"],
  "Permissions": [{
    "DataActions": [
      "Microsoft.DocumentDB/databaseAccounts/readMetadata",
      "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/items/read",
      "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/executeQuery",
      "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/readChangeFeed"
    ]
  }]
}'

Erstellen Sie eine SQL-Rollendefinition unter einem Azure Cosmos DB Konto mithilfe einer JSON-Datei.

az cosmosdb sql role definition create --account-name MyAccount --resource-group MyResourceGroup --body @role-definition.json

Erforderliche Parameter

--account-name -a

Cosmosdb-Kontoname.

--body -b

Rollendefinitionstext mit ID (Optional zum Erstellen), DataActions oder Berechtigungen, Typ (Standard ist CustomRole) und AssignableScopes. Sie können sie als Zeichenfolge oder als Datei eingeben, z. B. --body @rdbody-file.json oder --body "{ "Id": "be79875a-2cc4-40d5-8958-566017875b39", "RoleName": "My Read Write Role", "Type": "CustomRole", "AssignableScopes": [ "/" ], "DataActions": [ "Microsoft. DocumentDB/databaseAccounts/sqlDatabases/containers/items/create", "Microsoft. DocumentDB/databaseAccounts/sqlDatabases/containers/items/read" ]}".

--resource-group -g

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

Optionale Parameter

Die folgenden Parameter sind optional, aber je nach Kontext kann mindestens ein Parameter erforderlich sein, damit der Befehl erfolgreich ausgeführt werden kann.

--acquire-policy-token

Automatisches Abrufen eines Azure Policy Tokens für diesen Ressourcenvorgang.

Eigenschaft Wert
Parametergruppe: Global Policy Arguments
--change-reference

Die zugehörige Änderungsreferenz-ID für diesen Ressourcenvorgang.

Eigenschaft Wert
Parametergruppe: Global Policy Arguments
--no-wait

Warten Sie nicht, bis der lange ausgeführte Vorgang abgeschlossen ist.

Eigenschaft Wert
Standardwert: False
Globale Parameter
--debug

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

Eigenschaft Wert
Standardwert: False
--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft Wert
Standardwert: False
--output -o

Ausgabeformat.

Eigenschaft Wert
Standardwert: json
Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Eigenschaft Wert
Standardwert: False

az cosmosdb sql role definition delete

Löschen Sie eine SQL-Rollendefinition unter einem Azure Cosmos DB Konto.

az cosmosdb sql role definition delete --account-name
                                       --id
                                       --resource-group
                                       [--acquire-policy-token]
                                       [--change-reference]
                                       [--no-wait]
                                       [--yes]

Beispiele

Löschen Sie eine SQL-Rollendefinition unter einem Azure Cosmos DB Konto.

az cosmosdb sql role definition delete --account-name MyAccount --resource-group MyResourceGroup --id be79875a-2cc4-40d5-8958-566017875b39

Erforderliche Parameter

--account-name -a

Cosmosdb-Kontoname.

--id -i

Eindeutige ID für die Rollendefinition.

--resource-group -g

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

Optionale Parameter

Die folgenden Parameter sind optional, aber je nach Kontext kann mindestens ein Parameter erforderlich sein, damit der Befehl erfolgreich ausgeführt werden kann.

--acquire-policy-token

Automatisches Abrufen eines Azure Policy Tokens für diesen Ressourcenvorgang.

Eigenschaft Wert
Parametergruppe: Global Policy Arguments
--change-reference

Die zugehörige Änderungsreferenz-ID für diesen Ressourcenvorgang.

Eigenschaft Wert
Parametergruppe: Global Policy Arguments
--no-wait

Warten Sie nicht, bis der lange ausgeführte Vorgang abgeschlossen ist.

Eigenschaft Wert
Standardwert: False
--yes -y

Zur Bestätigung nicht auffordern.

Eigenschaft Wert
Standardwert: False
Globale Parameter
--debug

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

Eigenschaft Wert
Standardwert: False
--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft Wert
Standardwert: False
--output -o

Ausgabeformat.

Eigenschaft Wert
Standardwert: json
Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Eigenschaft Wert
Standardwert: False

az cosmosdb sql role definition exists

Überprüfen Sie, ob eine Azure Cosmos DB Rollendefinition vorhanden ist.

az cosmosdb sql role definition exists --account-name
                                       --id
                                       --resource-group
                                       [--acquire-policy-token]
                                       [--change-reference]

Beispiele

Überprüfen Sie, ob eine Azure Cosmos DB Rollendefinition vorhanden ist.

az cosmosdb sql role definition exists --account-name MyAccount --resource-group MyResourceGroup --id be79875a-2cc4-40d5-8958-566017875b39

Erforderliche Parameter

--account-name -a

Cosmosdb-Kontoname.

--id -i

Eindeutige ID für die Rollendefinition.

--resource-group -g

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

Optionale Parameter

Die folgenden Parameter sind optional, aber je nach Kontext kann mindestens ein Parameter erforderlich sein, damit der Befehl erfolgreich ausgeführt werden kann.

--acquire-policy-token

Automatisches Abrufen eines Azure Policy Tokens für diesen Ressourcenvorgang.

Eigenschaft Wert
Parametergruppe: Global Policy Arguments
--change-reference

Die zugehörige Änderungsreferenz-ID für diesen Ressourcenvorgang.

Eigenschaft Wert
Parametergruppe: Global Policy Arguments
Globale Parameter
--debug

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

Eigenschaft Wert
Standardwert: False
--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft Wert
Standardwert: False
--output -o

Ausgabeformat.

Eigenschaft Wert
Standardwert: json
Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Eigenschaft Wert
Standardwert: False

az cosmosdb sql role definition list

Auflisten aller SQL-Rollendefinitionen unter einem Azure Cosmos DB Konto.

az cosmosdb sql role definition list --account-name
                                     --resource-group

Beispiele

Auflisten aller SQL-Rollendefinitionen unter einem Azure Cosmos DB Konto.

az cosmosdb sql role definition list --account-name MyAccount --resource-group MyResourceGroup

Erforderliche Parameter

--account-name -a

Cosmosdb-Kontoname.

--resource-group -g

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

Globale Parameter
--debug

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

Eigenschaft Wert
Standardwert: False
--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft Wert
Standardwert: False
--output -o

Ausgabeformat.

Eigenschaft Wert
Standardwert: json
Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Eigenschaft Wert
Standardwert: False

az cosmosdb sql role definition show

Zeigen Sie die Eigenschaften einer SQL-Rollendefinition unter einem Azure Cosmos DB Konto an.

az cosmosdb sql role definition show --account-name
                                     --id
                                     --resource-group

Beispiele

Zeigen Sie die Eigenschaften einer SQL-Rollendefinition unter einem Azure Cosmos DB Konto an.

az cosmosdb sql role definition show --account-name MyAccount --resource-group MyResourceGroup --id be79875a-2cc4-40d5-8958-566017875b39

Erforderliche Parameter

--account-name -a

Cosmosdb-Kontoname.

--id -i

Eindeutige ID für die Rollendefinition.

--resource-group -g

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

Globale Parameter
--debug

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

Eigenschaft Wert
Standardwert: False
--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft Wert
Standardwert: False
--output -o

Ausgabeformat.

Eigenschaft Wert
Standardwert: json
Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Eigenschaft Wert
Standardwert: False

az cosmosdb sql role definition update

Aktualisieren sie eine SQL-Rollendefinition unter einem Azure Cosmos DB Konto.

az cosmosdb sql role definition update --account-name
                                       --body
                                       --resource-group
                                       [--acquire-policy-token]
                                       [--change-reference]
                                       [--no-wait]

Beispiele

Aktualisieren sie eine SQL-Rollendefinition unter einem Azure Cosmos DB Konto.

az cosmosdb sql role definition update --account-name MyAccount --resource-group MyResourceGroup --body @role-definition.json

Erforderliche Parameter

--account-name -a

Cosmosdb-Kontoname.

--body -b

Rollendefinitionstext mit ID (Optional zum Erstellen), DataActions oder Berechtigungen, Typ (Standard ist CustomRole) und AssignableScopes. Sie können sie als Zeichenfolge oder als Datei eingeben, z. B. --body @rdbody-file.json oder --body "{ "Id": "be79875a-2cc4-40d5-8958-566017875b39", "RoleName": "My Read Write Role", "Type": "CustomRole", "AssignableScopes": [ "/" ], "DataActions": [ "Microsoft. DocumentDB/databaseAccounts/sqlDatabases/containers/items/create", "Microsoft. DocumentDB/databaseAccounts/sqlDatabases/containers/items/read" ]}".

--resource-group -g

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

Optionale Parameter

Die folgenden Parameter sind optional, aber je nach Kontext kann mindestens ein Parameter erforderlich sein, damit der Befehl erfolgreich ausgeführt werden kann.

--acquire-policy-token

Automatisches Abrufen eines Azure Policy Tokens für diesen Ressourcenvorgang.

Eigenschaft Wert
Parametergruppe: Global Policy Arguments
--change-reference

Die zugehörige Änderungsreferenz-ID für diesen Ressourcenvorgang.

Eigenschaft Wert
Parametergruppe: Global Policy Arguments
--no-wait

Warten Sie nicht, bis der lange ausgeführte Vorgang abgeschlossen ist.

Eigenschaft Wert
Standardwert: False
Globale Parameter
--debug

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

Eigenschaft Wert
Standardwert: False
--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft Wert
Standardwert: False
--output -o

Ausgabeformat.

Eigenschaft Wert
Standardwert: json
Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Eigenschaft Wert
Standardwert: False

az cosmosdb sql role definition wait

Abrufen einer SQL-Rollendefinition, bis eine bestimmte Bedingung erfüllt ist.

az cosmosdb sql role definition wait --account-name
                                     --id
                                     --resource-group
                                     [--acquire-policy-token]
                                     [--change-reference]
                                     [--created]
                                     [--custom]
                                     [--deleted]
                                     [--exists]
                                     [--interval]
                                     [--timeout]
                                     [--updated]

Beispiele

Abrufen einer SQL-Rollendefinition, bis sie gelöscht wird.

az cosmosdb sql role definition wait --account-name MyAccount --resource-group MyResourceGroup --id cb8ed2d7-2371-4e3c-bd31-6cc1560e84f8 --deleted

Erforderliche Parameter

--account-name -a

Cosmosdb-Kontoname.

--id -i

Eindeutige ID für die Rollendefinition.

--resource-group -g

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

Optionale Parameter

Die folgenden Parameter sind optional, aber je nach Kontext kann mindestens ein Parameter erforderlich sein, damit der Befehl erfolgreich ausgeführt werden kann.

--acquire-policy-token

Automatisches Abrufen eines Azure Policy Tokens für diesen Ressourcenvorgang.

Eigenschaft Wert
Parametergruppe: Global Policy Arguments
--change-reference

Die zugehörige Änderungsreferenz-ID für diesen Ressourcenvorgang.

Eigenschaft Wert
Parametergruppe: Global Policy Arguments
--created

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

Eigenschaft Wert
Parametergruppe: Wait Condition Arguments
Standardwert: False
--custom

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

Eigenschaft Wert
Parametergruppe: Wait Condition Arguments
--deleted

Warten Sie, bis sie gelöscht wurde.

Eigenschaft Wert
Parametergruppe: Wait Condition Arguments
Standardwert: False
--exists

Warten Sie, bis die Ressource vorhanden ist.

Eigenschaft Wert
Parametergruppe: Wait Condition Arguments
Standardwert: False
--interval

Abrufintervall in Sekunden.

Eigenschaft Wert
Parametergruppe: Wait Condition Arguments
Standardwert: 30
--timeout

Maximale Wartezeit in Sekunden.

Eigenschaft Wert
Parametergruppe: Wait Condition Arguments
Standardwert: 3600
--updated

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

Eigenschaft Wert
Parametergruppe: Wait Condition Arguments
Standardwert: False
Globale Parameter
--debug

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

Eigenschaft Wert
Standardwert: False
--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft Wert
Standardwert: False
--output -o

Ausgabeformat.

Eigenschaft Wert
Standardwert: json
Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Eigenschaft Wert
Standardwert: False