Mongo MI Resources - Create Update Mongo MI Role Definition

Reference

Služba:: Cosmos DB Resource Provider

Verze rozhraní API:: 2025-05-01-preview

Vytvoří nebo aktualizuje definici role MongoMI služby Azure Cosmos DB.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
accountName	path	True	string minLength: 3 maxLength: 50 pattern: ^[a-z0-9]+(-[a-z0-9]+)*	Název databázového účtu služby Cosmos DB.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
roleDefinitionId	path	True	string	Identifikátor GUID pro definici role.
subscriptionId	path	True	string (uuid)	ID cílového předplatného. Hodnota musí být UUID.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Text požadavku

Name	Typ	Description
properties.assignableScopes	string[]	Sada plně kvalifikovaných oborů s použitím této definice role MongoMI nebo pod tím, která přiřazení rolí MongoMI mohou být vytvořena. To umožní použití této definice role pro celý účet databáze nebo jakoukoli podkladovou databázi nebo kolekci. Musí mít alespoň jeden prvek. Obory vyšší než účet databáze nelze vynutit jako přiřaditelné obory. Všimněte si, že prostředky odkazované v přiřaditelných oborech nemusí existovat.
properties.id	string	ID cesty pro definici role.
properties.permissions	Permission[]	Sada operací povolených prostřednictvím této definice role.
properties.roleName	string	Uživatelsky přívětivý název definice role. Pro databázový účet musí být jedinečný.
properties.type	RoleDefinitionType	Určuje, jestli byla definice role vytvořená předdefinovaná nebo vytvořená uživatelem.

Odpovědi

Name	Typ	Description
200 OK	MongoMIRoleDefinitionResource	Operace vytvoření nebo aktualizace definice role byla úspěšně dokončena.
202 Accepted		Žádost o vytvoření nebo aktualizaci definice role byla přijata asynchronně. Hlavičky azure-AsyncOperation: string location: string
Other Status Codes	ErrorResponse	Chybová odpověď popisující, proč operace selhala.

Name

Typ

Description

200 OK

MongoMIRoleDefinitionResource

Operace vytvoření nebo aktualizace definice role byla úspěšně dokončena.

202 Accepted

Žádost o vytvoření nebo aktualizaci definice role byla přijata asynchronně.

Hlavičky

azure-AsyncOperation: string
location: string

Other Status Codes

ErrorResponse

Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	Zosobnění uživatelského účtu

Příklady

CosmosDBMongoMIRoleDefinitionCreateUpdate

Ukázkový požadavek

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": []
      }
    ]
  }
}

Ukázková odpověď

Stavový kód:: 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"
        ]
      }
    ]
  }
}

Stavový kód:: 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

Definice

Name	Description
createdByType	Typ identity, která prostředek vytvořila.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď
MongoMIRoleDefinitionResource	Parametry pro vytvoření a aktualizaci definice role MongoMI služby Azure Cosmos DB
Permission	Sada operací roviny dat povolená prostřednictvím této definice role.
RoleDefinitionType	Určuje, jestli byla definice role vytvořená předdefinovaná nebo vytvořená uživatelem.
systemData	Metadata týkající se vytvoření a poslední změny prostředku.

createdByType

Výčet

Typ identity, která prostředek vytvořila.

Hodnota	Description
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Objekt

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Objekt

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Objekt

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

MongoMIRoleDefinitionResource

Objekt

Parametry pro vytvoření a aktualizaci definice role MongoMI služby Azure Cosmos DB

Name	Typ	Description
id	string (arm-id)	Plně kvalifikované ID prostředku pro prostředek. Například /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Název prostředku
properties.assignableScopes	string[]	Sada plně kvalifikovaných oborů s použitím této definice role MongoMI nebo pod tím, která přiřazení rolí MongoMI mohou být vytvořena. To umožní použití této definice role pro celý účet databáze nebo jakoukoli podkladovou databázi nebo kolekci. Musí mít alespoň jeden prvek. Obory vyšší než účet databáze nelze vynutit jako přiřaditelné obory. Všimněte si, že prostředky odkazované v přiřaditelných oborech nemusí existovat.
properties.id	string	ID cesty pro definici role.
properties.permissions	Permission[]	Sada operací povolených prostřednictvím této definice role.
properties.roleName	string	Uživatelsky přívětivý název definice role. Pro databázový účet musí být jedinečný.
properties.type	RoleDefinitionType	Určuje, jestli byla definice role vytvořená předdefinovaná nebo vytvořená uživatelem.
systemData	systemData	Metadata služby Azure Resource Manager obsahující informace o tom, kdo jej vytvořil a upravil.
type	string	Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

Permission

Objekt

Sada operací roviny dat povolená prostřednictvím této definice role.

Name	Typ	Description
dataActions	string[]	Pole datových akcí, které jsou povoleny.
id	string	ID oprávnění.
notDataActions	string[]	Pole akcí dat, které jsou odepřeny.

RoleDefinitionType

Výčet

Určuje, jestli byla definice role vytvořená předdefinovaná nebo vytvořená uživatelem.

Hodnota	Description
BuiltInRole
CustomRole

systemData

Objekt

Metadata týkající se vytvoření a poslední změny prostředku.

Name	Typ	Description
createdAt	string (date-time)	Časové razítko vytvoření prostředku (UTC).
createdBy	string	Identita, která prostředek vytvořila.
createdByType	createdByType	Typ identity, která prostředek vytvořila.
lastModifiedAt	string (date-time)	Časové razítko poslední změny zdroje (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.

Sdílet prostřednictvím

Mongo MI Resources - Create Update Mongo MI Role Definition

Parametry identifikátoru URI

Text požadavku

Odpovědi

Zabezpečení

azure_auth

Rozsahy

Příklady

CosmosDBMongoMIRoleDefinitionCreateUpdate

Ukázkový požadavek

Ukázková odpověď

Definice

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

MongoMIRoleDefinitionResource

Permission

RoleDefinitionType

systemData