Freigeben über


az cosmosdb gremlin role definition

Note

Diese Referenz ist Teil der Cosmosdb-Preview-Erweiterung für die Azure CLI (Version 2.17.1 oder höher). Die Erweiterung wird automatisch installiert, wenn Sie einen az cosmosdb gremlin Rollendefinitionsbefehl zum ersten Mal ausführen. Erfahren Sie mehr über Erweiterungen.

Verwalten von Azure Cosmos DB Gremlin-Rollendefinitionen.

Befehle

Name Beschreibung Typ Status
az cosmosdb gremlin role definition create

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

Extension GA
az cosmosdb gremlin role definition delete

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

Extension GA
az cosmosdb gremlin role definition exists

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

Extension GA
az cosmosdb gremlin role definition list

Listet alle Gremlin-Rollendefinitionen unter einem Azure Cosmos DB-Konto auf.

Extension GA
az cosmosdb gremlin role definition show

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

Extension GA
az cosmosdb gremlin role definition update

Aktualisieren Sie eine Gremlin-Rollendefinition unter einem Azure Cosmos DB-Konto.

Extension GA

az cosmosdb gremlin role definition create

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

az cosmosdb gremlin role definition create --account-name
                                           --body
                                           --resource-group

Beispiele

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

az cosmosdb gremlin 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/gremlin/containers/entities/read",
      "Microsoft.DocumentDB/databaseAccounts/gremlin/containers/executeQuery",
      "Microsoft.DocumentDB/databaseAccounts/gremlin/containers/readChangeFeed"
    ]
  }]
}'

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

az cosmosdb gremlin 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), Typ (Standard ist CustomRole), RoleName, Description, AssignableScopes, Permissions. Sie können sie als Zeichenfolge oder als Datei eingeben, z. B. --body @gremlin-role_definition-body-file.json oder --body "{ "Id": "be79875a-2cc4-40d5-8958-566017875b39", "RoleName": "MyTestRole", "type": "CustomRole", "description": "Custom role to read Cosmos DB metadata", "AssignableScopes":["/subscriptions/{0}/resourceGroups/{1}/providers/Microsoft.DocumentDB/databaseAccounts/MyDBAccountName"], "Permissions": [{"dataActions": ["Microsoft.DocumentDB/databaseAccounts/readMetadata"]} }".

--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 gremlin role definition delete

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

az cosmosdb gremlin role definition delete --account-name
                                           --resource-group
                                           --role-definition-id
                                           [--yes]

Beispiele

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

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

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.

--role-definition-id -i

Eindeutige ID für die Gremlin-Rollendefinition.

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.

--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 gremlin role definition exists

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

az cosmosdb gremlin role definition exists --account-name
                                           --resource-group
                                           --role-definition-id

Beispiele

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

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

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.

--role-definition-id -i

Eindeutige ID für die Gremlin-Rollendefinition.

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 gremlin role definition list

Listet alle Gremlin-Rollendefinitionen unter einem Azure Cosmos DB-Konto auf.

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

Beispiele

Listet alle Gremlin-Rollendefinitionen unter einem Azure Cosmos DB-Konto auf.

az cosmosdb gremlin 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 gremlin role definition show

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

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

Beispiele

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

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

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.

--role-definition-id -i

Eindeutige ID für die Gremlin-Rollendefinition.

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 gremlin role definition update

Aktualisieren Sie eine Gremlin-Rollendefinition unter einem Azure Cosmos DB-Konto.

az cosmosdb gremlin role definition update --account-name
                                           --body
                                           --resource-group

Beispiele

Aktualisieren Sie eine Gremlin-Rollendefinition unter einem Azure Cosmos DB-Konto.

az cosmosdb gremlin 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), Typ (Standard ist CustomRole), RoleName, Description, AssignableScopes, Permissions. Sie können sie als Zeichenfolge oder als Datei eingeben, z. B. --body @gremlin-role_definition-body-file.json oder --body "{ "Id": "be79875a-2cc4-40d5-8958-566017875b39", "RoleName": "MyTestRole", "type": "CustomRole", "description": "Custom role to read Cosmos DB metadata", "AssignableScopes":["/subscriptions/{0}/resourceGroups/{1}/providers/Microsoft.DocumentDB/databaseAccounts/MyDBAccountName"], "Permissions": [{"dataActions": ["Microsoft.DocumentDB/databaseAccounts/readMetadata"]} }".

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