Microsoft.CustomerInsights hubs/roleAssignments 2017-01-01
Bicep resource definition
The hubs/roleAssignments resource type can be deployed to:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.CustomerInsights/hubs/roleAssignments resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.CustomerInsights/hubs/roleAssignments@2017-01-01' = {
name: 'string'
parent: resourceSymbolicName
properties: {
conflationPolicies: {
elements: [
'string'
]
exceptions: [
'string'
]
}
connectors: {
elements: [
'string'
]
exceptions: [
'string'
]
}
description: {}
displayName: {}
interactions: {
elements: [
'string'
]
exceptions: [
'string'
]
}
kpis: {
elements: [
'string'
]
exceptions: [
'string'
]
}
links: {
elements: [
'string'
]
exceptions: [
'string'
]
}
principals: [
{
principalId: 'string'
principalMetadata: {}
principalType: 'string'
}
]
profiles: {
elements: [
'string'
]
exceptions: [
'string'
]
}
relationshipLinks: {
elements: [
'string'
]
exceptions: [
'string'
]
}
relationships: {
elements: [
'string'
]
exceptions: [
'string'
]
}
role: 'string'
roleAssignments: {
elements: [
'string'
]
exceptions: [
'string'
]
}
sasPolicies: {
elements: [
'string'
]
exceptions: [
'string'
]
}
segments: {
elements: [
'string'
]
exceptions: [
'string'
]
}
views: {
elements: [
'string'
]
exceptions: [
'string'
]
}
widgetTypes: {
elements: [
'string'
]
exceptions: [
'string'
]
}
}
}
Property values
hubs/roleAssignments
| Name | Description | Value |
|---|---|---|
| name | The resource name See how to set names and types for child resources in Bicep. |
string (required) Character limit: 1-128 Valid characters: Alphanumerics and underscores. Start with letter. |
| parent | In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource. |
Symbolic name for resource of type: hubs |
| properties | The Role Assignment definition. | RoleAssignment |
RoleAssignment
| Name | Description | Value |
|---|---|---|
| conflationPolicies | Widget types set for the assignment. | ResourceSetDescription |
| connectors | Connectors set for the assignment. | ResourceSetDescription |
| description | Localized description for the metadata. | object |
| displayName | Localized display names for the metadata. | object |
| interactions | Interactions set for the assignment. | ResourceSetDescription |
| kpis | Kpis set for the assignment. | ResourceSetDescription |
| links | Links set for the assignment. | ResourceSetDescription |
| principals | The principals being assigned to. | AssignmentPrincipal[] (required) |
| profiles | Profiles set for the assignment. | ResourceSetDescription |
| relationshipLinks | The Role assignments set for the relationship links. | ResourceSetDescription |
| relationships | The Role assignments set for the relationships. | ResourceSetDescription |
| role | Type of roles. | 'Admin' 'DataAdmin' 'DataReader' 'ManageAdmin' 'ManageReader' 'Reader' (required) |
| roleAssignments | The Role assignments set for the assignment. | ResourceSetDescription |
| sasPolicies | Sas Policies set for the assignment. | ResourceSetDescription |
| segments | The Role assignments set for the assignment. | ResourceSetDescription |
| views | Views set for the assignment. | ResourceSetDescription |
| widgetTypes | Widget types set for the assignment. | ResourceSetDescription |
ResourceSetDescription
| Name | Description | Value |
|---|---|---|
| elements | The elements included in the set. | string[] |
| exceptions | The elements that are not included in the set, in case elements contains '*' indicating 'all'. | string[] |
AssignmentPrincipal
| Name | Description | Value |
|---|---|---|
| principalId | The principal id being assigned to. | string (required) |
| principalMetadata | Other metadata for the principal. | object |
| principalType | The Type of the principal ID. | string (required) |
ARM template resource definition
The hubs/roleAssignments resource type can be deployed to:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.CustomerInsights/hubs/roleAssignments resource, add the following JSON to your template.
{
"type": "Microsoft.CustomerInsights/hubs/roleAssignments",
"apiVersion": "2017-01-01",
"name": "string",
"properties": {
"conflationPolicies": {
"elements": [ "string" ],
"exceptions": [ "string" ]
},
"connectors": {
"elements": [ "string" ],
"exceptions": [ "string" ]
},
"description": {},
"displayName": {},
"interactions": {
"elements": [ "string" ],
"exceptions": [ "string" ]
},
"kpis": {
"elements": [ "string" ],
"exceptions": [ "string" ]
},
"links": {
"elements": [ "string" ],
"exceptions": [ "string" ]
},
"principals": [
{
"principalId": "string",
"principalMetadata": {},
"principalType": "string"
}
],
"profiles": {
"elements": [ "string" ],
"exceptions": [ "string" ]
},
"relationshipLinks": {
"elements": [ "string" ],
"exceptions": [ "string" ]
},
"relationships": {
"elements": [ "string" ],
"exceptions": [ "string" ]
},
"role": "string",
"roleAssignments": {
"elements": [ "string" ],
"exceptions": [ "string" ]
},
"sasPolicies": {
"elements": [ "string" ],
"exceptions": [ "string" ]
},
"segments": {
"elements": [ "string" ],
"exceptions": [ "string" ]
},
"views": {
"elements": [ "string" ],
"exceptions": [ "string" ]
},
"widgetTypes": {
"elements": [ "string" ],
"exceptions": [ "string" ]
}
}
}
Property values
hubs/roleAssignments
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.CustomerInsights/hubs/roleAssignments' |
| apiVersion | The resource api version | '2017-01-01' |
| name | The resource name See how to set names and types for child resources in JSON ARM templates. |
string (required) Character limit: 1-128 Valid characters: Alphanumerics and underscores. Start with letter. |
| properties | The Role Assignment definition. | RoleAssignment |
RoleAssignment
| Name | Description | Value |
|---|---|---|
| conflationPolicies | Widget types set for the assignment. | ResourceSetDescription |
| connectors | Connectors set for the assignment. | ResourceSetDescription |
| description | Localized description for the metadata. | object |
| displayName | Localized display names for the metadata. | object |
| interactions | Interactions set for the assignment. | ResourceSetDescription |
| kpis | Kpis set for the assignment. | ResourceSetDescription |
| links | Links set for the assignment. | ResourceSetDescription |
| principals | The principals being assigned to. | AssignmentPrincipal[] (required) |
| profiles | Profiles set for the assignment. | ResourceSetDescription |
| relationshipLinks | The Role assignments set for the relationship links. | ResourceSetDescription |
| relationships | The Role assignments set for the relationships. | ResourceSetDescription |
| role | Type of roles. | 'Admin' 'DataAdmin' 'DataReader' 'ManageAdmin' 'ManageReader' 'Reader' (required) |
| roleAssignments | The Role assignments set for the assignment. | ResourceSetDescription |
| sasPolicies | Sas Policies set for the assignment. | ResourceSetDescription |
| segments | The Role assignments set for the assignment. | ResourceSetDescription |
| views | Views set for the assignment. | ResourceSetDescription |
| widgetTypes | Widget types set for the assignment. | ResourceSetDescription |
ResourceSetDescription
| Name | Description | Value |
|---|---|---|
| elements | The elements included in the set. | string[] |
| exceptions | The elements that are not included in the set, in case elements contains '*' indicating 'all'. | string[] |
AssignmentPrincipal
| Name | Description | Value |
|---|---|---|
| principalId | The principal id being assigned to. | string (required) |
| principalMetadata | Other metadata for the principal. | object |
| principalType | The Type of the principal ID. | string (required) |
Terraform (AzAPI provider) resource definition
The hubs/roleAssignments resource type can be deployed to:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.CustomerInsights/hubs/roleAssignments resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.CustomerInsights/hubs/roleAssignments@2017-01-01"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
conflationPolicies = {
elements = [
"string"
]
exceptions = [
"string"
]
}
connectors = {
elements = [
"string"
]
exceptions = [
"string"
]
}
description = {}
displayName = {}
interactions = {
elements = [
"string"
]
exceptions = [
"string"
]
}
kpis = {
elements = [
"string"
]
exceptions = [
"string"
]
}
links = {
elements = [
"string"
]
exceptions = [
"string"
]
}
principals = [
{
principalId = "string"
principalMetadata = {}
principalType = "string"
}
]
profiles = {
elements = [
"string"
]
exceptions = [
"string"
]
}
relationshipLinks = {
elements = [
"string"
]
exceptions = [
"string"
]
}
relationships = {
elements = [
"string"
]
exceptions = [
"string"
]
}
role = "string"
roleAssignments = {
elements = [
"string"
]
exceptions = [
"string"
]
}
sasPolicies = {
elements = [
"string"
]
exceptions = [
"string"
]
}
segments = {
elements = [
"string"
]
exceptions = [
"string"
]
}
views = {
elements = [
"string"
]
exceptions = [
"string"
]
}
widgetTypes = {
elements = [
"string"
]
exceptions = [
"string"
]
}
}
})
}
Property values
hubs/roleAssignments
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.CustomerInsights/hubs/roleAssignments@2017-01-01" |
| name | The resource name | string (required) Character limit: 1-128 Valid characters: Alphanumerics and underscores. Start with letter. |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: hubs |
| properties | The Role Assignment definition. | RoleAssignment |
RoleAssignment
| Name | Description | Value |
|---|---|---|
| conflationPolicies | Widget types set for the assignment. | ResourceSetDescription |
| connectors | Connectors set for the assignment. | ResourceSetDescription |
| description | Localized description for the metadata. | object |
| displayName | Localized display names for the metadata. | object |
| interactions | Interactions set for the assignment. | ResourceSetDescription |
| kpis | Kpis set for the assignment. | ResourceSetDescription |
| links | Links set for the assignment. | ResourceSetDescription |
| principals | The principals being assigned to. | AssignmentPrincipal[] (required) |
| profiles | Profiles set for the assignment. | ResourceSetDescription |
| relationshipLinks | The Role assignments set for the relationship links. | ResourceSetDescription |
| relationships | The Role assignments set for the relationships. | ResourceSetDescription |
| role | Type of roles. | "Admin" "DataAdmin" "DataReader" "ManageAdmin" "ManageReader" "Reader" (required) |
| roleAssignments | The Role assignments set for the assignment. | ResourceSetDescription |
| sasPolicies | Sas Policies set for the assignment. | ResourceSetDescription |
| segments | The Role assignments set for the assignment. | ResourceSetDescription |
| views | Views set for the assignment. | ResourceSetDescription |
| widgetTypes | Widget types set for the assignment. | ResourceSetDescription |
ResourceSetDescription
| Name | Description | Value |
|---|---|---|
| elements | The elements included in the set. | string[] |
| exceptions | The elements that are not included in the set, in case elements contains '*' indicating 'all'. | string[] |
AssignmentPrincipal
| Name | Description | Value |
|---|---|---|
| principalId | The principal id being assigned to. | string (required) |
| principalMetadata | Other metadata for the principal. | object |
| principalType | The Type of the principal ID. | string (required) |
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for