MongoRoleDefinitionGetResults interface

An Azure Cosmos DB Mongo Role Definition.

Extends

Properties

databaseName

The database name for which access is being granted for this Role Definition.

privileges

A set of privileges contained by the Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Scopes higher than Database are not enforceable as privilege.

roleName

A user-friendly name for the Role Definition. Must be unique for the database account.

roles

The set of roles inherited by this Role Definition.

typePropertiesType

Indicates whether the Role Definition was built-in or user created.

Inherited Properties

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

The name of the resource

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Property Details

databaseName

The database name for which access is being granted for this Role Definition.

databaseName?: string

Property Value

string

privileges

A set of privileges contained by the Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Scopes higher than Database are not enforceable as privilege.

privileges?: Privilege[]

Property Value

roleName

A user-friendly name for the Role Definition. Must be unique for the database account.

roleName?: string

Property Value

string

roles

The set of roles inherited by this Role Definition.

roles?: Role[]

Property Value

Role[]

typePropertiesType

Indicates whether the Role Definition was built-in or user created.

typePropertiesType?: MongoRoleDefinitionType

Property Value

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

id?: string

Property Value

string

Inherited From ProxyResource.id

name

The name of the resource

name?: string

Property Value

string

Inherited From ProxyResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

systemData?: SystemData

Property Value

Inherited From ProxyResource.systemData

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

type?: string

Property Value

string

Inherited From ProxyResource.type