Dela via


New-AzCosmosDBSqlRoleDefinition

Skapar en ny CosmosDB Sql-rolldefinition.

Syntax

ByFieldsDataActionsParameterSet (Standard)

New-AzCosmosDBSqlRoleDefinition
    -ResourceGroupName <String>
    -AccountName <String>
    -RoleName <String>
    -AssignableScope <System.Collections.Generic.List`1[System.String]>
    -DataAction <System.Collections.Generic.List`1[System.String]>
    [-Id <String>]
    [-Type <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByFieldsPermissionsParameterSet

New-AzCosmosDBSqlRoleDefinition
    -ResourceGroupName <String>
    -AccountName <String>
    -RoleName <String>
    -AssignableScope <System.Collections.Generic.List`1[System.String]>
    -Permission <System.Collections.Generic.List`1[Microsoft.Azure.Commands.CosmosDB.Models.PSPermission]>
    [-Id <String>]
    [-Type <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByParentObjectDataActionsParameterSet

New-AzCosmosDBSqlRoleDefinition
    -RoleName <String>
    -AssignableScope <System.Collections.Generic.List`1[System.String]>
    -DataAction <System.Collections.Generic.List`1[System.String]>
    -ParentObject <PSDatabaseAccountGetResults>
    [-Id <String>]
    [-Type <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByParentObjectPermissionsParameterSet

New-AzCosmosDBSqlRoleDefinition
    -RoleName <String>
    -AssignableScope <System.Collections.Generic.List`1[System.String]>
    -Permission <System.Collections.Generic.List`1[Microsoft.Azure.Commands.CosmosDB.Models.PSPermission]>
    -ParentObject <PSDatabaseAccountGetResults>
    [-Id <String>]
    [-Type <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Skapar en ny CosmosDB Sql-rolldefinition. Tilldelningsbara omfång kan antingen vara fullständigt kvalificerade (dvs. /subscriptions/subId/resourceGroups/resourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/accountName/dbs/dbName) eller börja med databasnamnet (dvs. /dbs/dbName). Om du vill ange rolldefinitionens behörigheter använder du antingen parametern DataAction och skickar in en lista med strängar som ska omvandlas till ett enda behörighetsobjekt eller använder cmdleten New-AzCosmosDBPermission för att skapa PSPermission-objekt för att skicka in via parametern Behörighet.

Exempel

Exempel 1: Använda DataAction

New-AzCosmosDBSqlRoleDefinition `
	-AccountName accountName `
	-ResourceGroupName resourceGroupName `
	-Type CustomRole `
	-RoleName roleName `
	-DataAction "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/items/create" `
	-AssignableScope "/"
RoleName         : roleName
Id               : /subscriptions/subId/resourceGroups/resourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/accountName/sqlRoleDefinitions/id
Type             : CustomRole
Permissions      : {Microsoft.Azure.Management.CosmosDB.Models.Permission}
AssignableScopes : {/subscriptions/subId/resourceGroups/resourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/accountName}

Exempel 2: Använda behörighet och ParentObject

$DatabaseAccount = Get-AzCosmosDBAccount -Name accountName -ResourceGroupName resourceGroupName
$Permission = New-AzCosmosDBPermission -DataAction "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/items/create"
New-AzCosmosDBSqlRoleDefinition `
	-Type CustomRole `
	-RoleName roleName `
	-Permission $Permission `
	-AssignableScope "/" `
	-ParentObject $DatabaseAccount
RoleName         : roleName
Id               : /subscriptions/subId/resourceGroups/resourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/accountName/sqlRoleDefinitions/id
Type             : CustomRole
Permissions      : {Microsoft.Azure.Management.CosmosDB.Models.Permission}
AssignableScopes : {/subscriptions/subId/resourceGroups/resourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/accountName}

Parametrar

-AccountName

Namnet på Cosmos DB-databaskontot.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

ByFieldsDataActionsParameterSet
Position:Named
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False
ByFieldsPermissionsParameterSet
Position:Named
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-AssignableScope

Uppsättning resurssökvägar under vilka en rolltilldelning kan kopplas till rolldefinitionen. Eg. '/', '/dbs/dbname','/dbs/dbname/colls/collname'.

Parameteregenskaper

Typ:

List<T>[String]

Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-Confirm

Uppmanar dig att bekräfta innan du kör cmdleten.

Parameteregenskaper

Typ:SwitchParameter
Standardvärde:False
Stöder jokertecken:False
DontShow:False
Alias:jfr

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-DataAction

Uppsättning dataåtgärder som beviljats via rolldefinitionen. Lista över tillåtna åtgärder finns på: https://aka.ms/cosmos-native-rbac

Parameteregenskaper

Typ:

List<T>[String]

Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

ByFieldsDataActionsParameterSet
Position:Named
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False
ByParentObjectDataActionsParameterSet
Position:Named
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-DefaultProfile

Autentiseringsuppgifter, konto, klientorganisation och prenumeration som används för kommunikation med Azure.

Parameteregenskaper

Typ:IAzureContextContainer
Standardvärde:None
Stöder jokertecken:False
DontShow:False
Alias:AzContext, AzureRmContext, AzureCredential

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-Id

Rolltilldelnings-ID.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-ParentObject

Rolldefinitionsobjekt.

Parameteregenskaper

Typ:PSDatabaseAccountGetResults
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

ByParentObjectDataActionsParameterSet
Position:Named
Obligatorisk:True
Värde från pipeline:True
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False
ByParentObjectPermissionsParameterSet
Position:Named
Obligatorisk:True
Värde från pipeline:True
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-Permission

Behörighet är en samling dataåtgärder.

Parameteregenskaper

Typ:

List<T>[PSPermission]

Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

ByFieldsPermissionsParameterSet
Position:Named
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False
ByParentObjectPermissionsParameterSet
Position:Named
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-ResourceGroupName

Namnet på resursgruppen.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

ByFieldsDataActionsParameterSet
Position:Named
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False
ByFieldsPermissionsParameterSet
Position:Named
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-RoleName

Namn på rolldefinition.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-Type

Typ av rolldefinition, antingen CustomRole eller BuiltInRole. Standardvärdet är CustomRole.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-WhatIf

Visar vad som skulle hända om kommandot körs. Cmdleten körs inte.

Parameteregenskaper

Typ:SwitchParameter
Standardvärde:False
Stöder jokertecken:False
DontShow:False
Alias:Wi

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

CommonParameters

Den här cmdleten stöder vanliga parametrar: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction och -WarningVariable. Mer information finns i about_CommonParameters.

Indata

PSSqlRoleDefinitionGetResults

Utdata

PSSqlRoleDefinitionGetResults