[Index]

Model: device/skypeforbusiness/CsAdminRole

Model Details

Title Description Details
ScriptCmdlets
  • Field Name: ScriptCmdlets
  • Type: String
ScriptModules Enables you to specify a function within a Windows PowerShell script that will then be available to users who hold the new RBAC role. For example, this syntax provides access to a function named Reset in a script named UpdateDatabase.ps1 : -ScriptModules "UpdateDatabase.ps1:Reset"
  • Field Name: ScriptModules.[n]
  • Type: Array
ConfigScopes Used to limit the scope of the cmdlet to configuration settings within the specified site. To limit the cmdlet scope to a single site, use syntax similar to this: -ConfigScopes site:Redmond. Multiple sites can be specified by using a comma-separated list: -ConfigScopes "site:Redmond, "site:Dublin". You can also set the ConfigScopes property to "global". When assigning a value to the ConfigScopes parameter you must use the "site:" prefix followed by the value of the site's SiteId property; note that the SiteID is not necessarily the same value as the site's Identity or the site's DisplayName. To determine the SiteId for a given site you can use a command similar to this: Get-CsSite "Redmond" | Select-Object SiteId You must specify a value for either (or both) the ConfigScopes and UserScopes properties.
  • Field Name: ConfigScopes
  • Type: String
TemplateName
  • Field Name: TemplateName
  • Type: String
Cmdlets Enables you to specify the cmdlets that will be available to users who hold the new RBAC role. For example, to create a new role that provides access only to one cmdlet (the Export-CsArchivingData cmdlet) use syntax like this: -Cmdlets "Export-CsArchivingData" To allow access to multiple cmdlets, separate the cmdlet names using commas: -Cmdlets "Export-CsArchivingData","Invoke-CsArchivingDatabasePurge"
  • Field Name: Cmdlets
  • Type: String
TenantWellKnownGroup
  • Field Name: TenantWellKnownGroup
  • Type: String
InMemory Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-<cmdlet>.
  • Field Name: InMemory
  • Type: Boolean
IsStandardRole
  • Field Name: IsStandardRole
  • Type: Boolean
Template * Name of the built-in RBAC role that will serve as a template for the custom RBAC role being created. All new RBAC roles must be based on an existing role; it is not possible to create a blank RBAC role (that is, a role with no cmdlets assigned to it or without values assigned to either the ConfigScopes or UserScopes properties). However, after the custom role has been created, you can then use the Set-CsAdminRole cmdlet to modify the properties of the new role.
  • Field Name: Template
  • Type: String
SID
  • Field Name: SID
  • Type: String
MinVersion
  • Field Name: MinVersion
  • Type: String
UserScopes Used to limit the scope of the cmdlet to user management activities within the specified organizational unit. To limit the cmdlet scope to a single organizational unit, use syntax similar to this: -UserScopes "OU:ou=Redmond,dc=litwareinc,dc=com". Multiple OUs can be specified by using a comma-separated list: -UserScopes "OU:ou=Redmond,dc=litwareinc,dc=com", "OU:ou=Dublin,dc=litwareinc,dc=com". To add new scopes (or remove existing scopes) from a role, use the Windows PowerShell list modifiers syntax. For details, see the Examples section of this Help topic. You must specify a value for either (or both) the ConfigScopes and UserScopes properties.
  • Field Name: UserScopes
  • Type: String
Identity * Unique identifier for the RBAC role to be created. The Identity for an RBAC role must be the same as the SamAccountName for the Active Directory universal security group associated with that role. For example, the help desk role has an Identity equal to CsHelpDesk; CsHelpDesk is also the SamAccountName of the Active Directory security group associated with that role.
  • Field Name: Identity
  • Type: String
API reference for device/skypeforbusiness/CsAdminRole