Mongo MI Resources - Create Update Mongo MI Role Definition

Referenz

Dienst:: Cosmos DB Resource Provider

API-Version:: 2025-05-01-preview

Erstellt oder aktualisiert eine Azure Cosmos DB MongoMI-Rollendefinition.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongoMIRoleDefinitions/{roleDefinitionId}?api-version=2025-05-01-preview

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
accountName	path	True	string minLength: 3 maxLength: 50 pattern: ^[a-z0-9]+(-[a-z0-9]+)*	Name des Cosmos DB-Datenbankkontos.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
roleDefinitionId	path	True	string	Die GUID für die Rollendefinition.
subscriptionId	path	True	string (uuid)	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

Name	Typ	Beschreibung
properties.assignableScopes	string[]	Eine Reihe vollqualifizierter Bereiche, unter denen MongoMI-Rollenzuweisungen mithilfe dieser Rollendefinition erstellt werden können. Dies ermöglicht die Anwendung dieser Rollendefinition auf das gesamte Datenbankkonto oder eine beliebige zugrunde liegende Datenbank/Sammlung. Muss mindestens ein Element aufweisen. Bereiche, die höher als das Datenbankkonto sind, können nicht als zuweisungsfähige Bereiche erzwingt werden. Beachten Sie, dass Ressourcen, auf die in zugewiesenen Bereichen verwiesen wird, nicht vorhanden sind.
properties.id	string	Die Pfad-ID für die Rollendefinition.
properties.permissions	Permission[]	Der Satz von Vorgängen, die über diese Rollendefinition zulässig sind.
properties.roleName	string	Ein benutzerfreundlicher Name für die Rollendefinition. Muss für das Datenbankkonto eindeutig sein.
properties.type	RoleDefinitionType	Gibt an, ob die Rollendefinition integriert oder vom Benutzer erstellt wurde.

Antworten

Name	Typ	Beschreibung
200 OK	MongoMIRoleDefinitionResource	Der Erstellungs- oder Aktualisierungsvorgang der Rollendefinition wurde erfolgreich abgeschlossen.
202 Accepted		Die Anforderung zum Erstellen oder Aktualisieren der Rollendefinition wurde akzeptiert und wird asynchron abgeschlossen. Header azure-AsyncOperation: string location: string
Other Status Codes	ErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Name

Typ

Beschreibung

200 OK

MongoMIRoleDefinitionResource

Der Erstellungs- oder Aktualisierungsvorgang der Rollendefinition wurde erfolgreich abgeschlossen.

202 Accepted

Die Anforderung zum Erstellen oder Aktualisieren der Rollendefinition wurde akzeptiert und wird asynchron abgeschlossen.

Header

azure-AsyncOperation: string
location: string

Other Status Codes

ErrorResponse

Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

CosmosDBMongoMIRoleDefinitionCreateUpdate

Beispielanforderung

HTTP

PUT https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/mongoMIRoleDefinitions/myRoleDefinitionId?api-version=2025-05-01-preview

{
  "properties": {
    "roleName": "myRoleName",
    "type": "CustomRole",
    "assignableScopes": [
      "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/dbs/sales",
      "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/dbs/purchases"
    ],
    "permissions": [
      {
        "dataActions": [
          "Microsoft.DocumentDB/databaseAccounts/mongoMIDatabases/containers/entities/create",
          "Microsoft.DocumentDB/databaseAccounts/mongoMIDatabases/containers/entities/read"
        ],
        "notDataActions": []
      }
    ]
  }
}

Beispiel für eine Antwort

Statuscode:: 200

{
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/mongoMIRoleDefinitions/myRoleDefinitionId",
  "name": "myRoleDefinitionId",
  "type": "Microsoft.DocumentDB/databaseAccounts/mongoMIRoleDefinitions",
  "properties": {
    "roleName": "myRoleName",
    "type": "CustomRole",
    "assignableScopes": [
      "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/dbs/sales",
      "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/dbs/purchases"
    ],
    "permissions": [
      {
        "dataActions": [
          "Microsoft.DocumentDB/databaseAccounts/mongoMIDatabases/containers/entities/create",
          "Microsoft.DocumentDB/databaseAccounts/mongoMIDatabases/containers/entities/read"
        ]
      }
    ]
  }
}

Statuscode:: 202

azure-AsyncOperation: https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2025-05-01-preview
location: https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2025-05-01-preview

Definitionen

Name	Beschreibung
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
MongoMIRoleDefinitionResource	Parameter zum Erstellen und Aktualisieren einer Azure Cosmos DB MongoMI-Rollendefinition.
Permission	Der Satz von Datenebenenvorgängen, die über diese Rollendefinition zulässig sind.
RoleDefinitionType	Gibt an, ob die Rollendefinition integriert oder vom Benutzer erstellt wurde.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

MongoMIRoleDefinitionResource

Objekt

Parameter zum Erstellen und Aktualisieren einer Azure Cosmos DB MongoMI-Rollendefinition.

Name	Typ	Beschreibung
id	string (arm-id)	Vollqualifizierte Ressourcen-ID für die Ressource. Z. B. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Der Name der Ressource
properties.assignableScopes	string[]	Eine Reihe vollqualifizierter Bereiche, unter denen MongoMI-Rollenzuweisungen mithilfe dieser Rollendefinition erstellt werden können. Dies ermöglicht die Anwendung dieser Rollendefinition auf das gesamte Datenbankkonto oder eine beliebige zugrunde liegende Datenbank/Sammlung. Muss mindestens ein Element aufweisen. Bereiche, die höher als das Datenbankkonto sind, können nicht als zuweisungsfähige Bereiche erzwingt werden. Beachten Sie, dass Ressourcen, auf die in zugewiesenen Bereichen verwiesen wird, nicht vorhanden sind.
properties.id	string	Die Pfad-ID für die Rollendefinition.
properties.permissions	Permission[]	Der Satz von Vorgängen, die über diese Rollendefinition zulässig sind.
properties.roleName	string	Ein benutzerfreundlicher Name für die Rollendefinition. Muss für das Datenbankkonto eindeutig sein.
properties.type	RoleDefinitionType	Gibt an, ob die Rollendefinition integriert oder vom Benutzer erstellt wurde.
systemData	systemData	Azure Resource Manager-Metadaten, die createdBy- und modifiedBy-Informationen enthalten.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

Permission

Objekt

Der Satz von Datenebenenvorgängen, die über diese Rollendefinition zulässig sind.

Name	Typ	Beschreibung
dataActions	string[]	Ein Array von Datenaktionen, die zulässig sind.
id	string	Die ID für die Berechtigung.
notDataActions	string[]	Ein Array von Datenaktionen, die verweigert werden.

RoleDefinitionType

Enumeration

Gibt an, ob die Rollendefinition integriert oder vom Benutzer erstellt wurde.

Wert	Beschreibung
BuiltInRole
CustomRole

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

Freigeben über

Mongo MI Resources - Create Update Mongo MI Role Definition

URI-Parameter

Anforderungstext

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

CosmosDBMongoMIRoleDefinitionCreateUpdate

Beispielanforderung

Beispiel für eine Antwort

Definitionen

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

MongoMIRoleDefinitionResource

Permission

RoleDefinitionType

systemData