Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v1
  3. API Docs
  4. customerinsights
  5. getRoleAssignment
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

azure-native.customerinsights.getRoleAssignment

Explore with Pulumi AI

These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

Gets the role assignment in the hub. API Version: 2017-04-26.

Using getRoleAssignment

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getRoleAssignment(args: GetRoleAssignmentArgs, opts?: InvokeOptions): Promise<GetRoleAssignmentResult>
function getRoleAssignmentOutput(args: GetRoleAssignmentOutputArgs, opts?: InvokeOptions): Output<GetRoleAssignmentResult>
Copy
def get_role_assignment(assignment_name: Optional[str] = None,
                        hub_name: Optional[str] = None,
                        resource_group_name: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetRoleAssignmentResult
def get_role_assignment_output(assignment_name: Optional[pulumi.Input[str]] = None,
                        hub_name: Optional[pulumi.Input[str]] = None,
                        resource_group_name: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetRoleAssignmentResult]
Copy
func LookupRoleAssignment(ctx *Context, args *LookupRoleAssignmentArgs, opts ...InvokeOption) (*LookupRoleAssignmentResult, error)
func LookupRoleAssignmentOutput(ctx *Context, args *LookupRoleAssignmentOutputArgs, opts ...InvokeOption) LookupRoleAssignmentResultOutput
Copy

> Note: This function is named LookupRoleAssignment in the Go SDK.

public static class GetRoleAssignment 
{
    public static Task<GetRoleAssignmentResult> InvokeAsync(GetRoleAssignmentArgs args, InvokeOptions? opts = null)
    public static Output<GetRoleAssignmentResult> Invoke(GetRoleAssignmentInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetRoleAssignmentResult> getRoleAssignment(GetRoleAssignmentArgs args, InvokeOptions options)
public static Output<GetRoleAssignmentResult> getRoleAssignment(GetRoleAssignmentArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:customerinsights:getRoleAssignment
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

AssignmentName
This property is required.
Changes to this property will trigger replacement.
string
The name of the role assignment.
HubName
This property is required.
Changes to this property will trigger replacement.
string
The name of the hub.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
AssignmentName
This property is required.
Changes to this property will trigger replacement.
string
The name of the role assignment.
HubName
This property is required.
Changes to this property will trigger replacement.
string
The name of the hub.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
assignmentName
This property is required.
Changes to this property will trigger replacement.
String
The name of the role assignment.
hubName
This property is required.
Changes to this property will trigger replacement.
String
The name of the hub.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
assignmentName
This property is required.
Changes to this property will trigger replacement.
string
The name of the role assignment.
hubName
This property is required.
Changes to this property will trigger replacement.
string
The name of the hub.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
assignment_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the role assignment.
hub_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the hub.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group.
assignmentName
This property is required.
Changes to this property will trigger replacement.
String
The name of the role assignment.
hubName
This property is required.
Changes to this property will trigger replacement.
String
The name of the hub.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.

getRoleAssignment Result

The following output properties are available:

AssignmentName string
The name of the metadata object.
Id string
Resource ID.
Name string
Resource name.
Principals List<Pulumi.AzureNative.CustomerInsights.Outputs.AssignmentPrincipalResponse>
The principals being assigned to.
ProvisioningState string
Provisioning state.
Role string
Type of roles.
TenantId string
The hub name.
Type string
Resource type.
ConflationPolicies Pulumi.AzureNative.CustomerInsights.Outputs.ResourceSetDescriptionResponse
Widget types set for the assignment.
Connectors Pulumi.AzureNative.CustomerInsights.Outputs.ResourceSetDescriptionResponse
Connectors set for the assignment.
Description Dictionary<string, string>
Localized description for the metadata.
DisplayName Dictionary<string, string>
Localized display names for the metadata.
Interactions Pulumi.AzureNative.CustomerInsights.Outputs.ResourceSetDescriptionResponse
Interactions set for the assignment.
Kpis Pulumi.AzureNative.CustomerInsights.Outputs.ResourceSetDescriptionResponse
Kpis set for the assignment.
Links Pulumi.AzureNative.CustomerInsights.Outputs.ResourceSetDescriptionResponse
Links set for the assignment.
Profiles Pulumi.AzureNative.CustomerInsights.Outputs.ResourceSetDescriptionResponse
Profiles set for the assignment.
RelationshipLinks Pulumi.AzureNative.CustomerInsights.Outputs.ResourceSetDescriptionResponse
The Role assignments set for the relationship links.
Relationships Pulumi.AzureNative.CustomerInsights.Outputs.ResourceSetDescriptionResponse
The Role assignments set for the relationships.
RoleAssignments Pulumi.AzureNative.CustomerInsights.Outputs.ResourceSetDescriptionResponse
The Role assignments set for the assignment.
SasPolicies Pulumi.AzureNative.CustomerInsights.Outputs.ResourceSetDescriptionResponse
Sas Policies set for the assignment.
Segments Pulumi.AzureNative.CustomerInsights.Outputs.ResourceSetDescriptionResponse
The Role assignments set for the assignment.
Views Pulumi.AzureNative.CustomerInsights.Outputs.ResourceSetDescriptionResponse
Views set for the assignment.
WidgetTypes Pulumi.AzureNative.CustomerInsights.Outputs.ResourceSetDescriptionResponse
Widget types set for the assignment.
AssignmentName string
The name of the metadata object.
Id string
Resource ID.
Name string
Resource name.
Principals []AssignmentPrincipalResponse
The principals being assigned to.
ProvisioningState string
Provisioning state.
Role string
Type of roles.
TenantId string
The hub name.
Type string
Resource type.
ConflationPolicies ResourceSetDescriptionResponse
Widget types set for the assignment.
Connectors ResourceSetDescriptionResponse
Connectors set for the assignment.
Description map[string]string
Localized description for the metadata.
DisplayName map[string]string
Localized display names for the metadata.
Interactions ResourceSetDescriptionResponse
Interactions set for the assignment.
Kpis ResourceSetDescriptionResponse
Kpis set for the assignment.
Links ResourceSetDescriptionResponse
Links set for the assignment.
Profiles ResourceSetDescriptionResponse
Profiles set for the assignment.
RelationshipLinks ResourceSetDescriptionResponse
The Role assignments set for the relationship links.
Relationships ResourceSetDescriptionResponse
The Role assignments set for the relationships.
RoleAssignments ResourceSetDescriptionResponse
The Role assignments set for the assignment.
SasPolicies ResourceSetDescriptionResponse
Sas Policies set for the assignment.
Segments ResourceSetDescriptionResponse
The Role assignments set for the assignment.
Views ResourceSetDescriptionResponse
Views set for the assignment.
WidgetTypes ResourceSetDescriptionResponse
Widget types set for the assignment.
assignmentName String
The name of the metadata object.
id String
Resource ID.
name String
Resource name.
principals List<AssignmentPrincipalResponse>
The principals being assigned to.
provisioningState String
Provisioning state.
role String
Type of roles.
tenantId String
The hub name.
type String
Resource type.
conflationPolicies ResourceSetDescriptionResponse
Widget types set for the assignment.
connectors ResourceSetDescriptionResponse
Connectors set for the assignment.
description Map<String,String>
Localized description for the metadata.
displayName Map<String,String>
Localized display names for the metadata.
interactions ResourceSetDescriptionResponse
Interactions set for the assignment.
kpis ResourceSetDescriptionResponse
Kpis set for the assignment.
links ResourceSetDescriptionResponse
Links set for the assignment.
profiles ResourceSetDescriptionResponse
Profiles set for the assignment.
relationshipLinks ResourceSetDescriptionResponse
The Role assignments set for the relationship links.
relationships ResourceSetDescriptionResponse
The Role assignments set for the relationships.
roleAssignments ResourceSetDescriptionResponse
The Role assignments set for the assignment.
sasPolicies ResourceSetDescriptionResponse
Sas Policies set for the assignment.
segments ResourceSetDescriptionResponse
The Role assignments set for the assignment.
views ResourceSetDescriptionResponse
Views set for the assignment.
widgetTypes ResourceSetDescriptionResponse
Widget types set for the assignment.
assignmentName string
The name of the metadata object.
id string
Resource ID.
name string
Resource name.
principals AssignmentPrincipalResponse[]
The principals being assigned to.
provisioningState string
Provisioning state.
role string
Type of roles.
tenantId string
The hub name.
type string
Resource type.
conflationPolicies ResourceSetDescriptionResponse
Widget types set for the assignment.
connectors ResourceSetDescriptionResponse
Connectors set for the assignment.
description {[key: string]: string}
Localized description for the metadata.
displayName {[key: string]: string}
Localized display names for the metadata.
interactions ResourceSetDescriptionResponse
Interactions set for the assignment.
kpis ResourceSetDescriptionResponse
Kpis set for the assignment.
links ResourceSetDescriptionResponse
Links set for the assignment.
profiles ResourceSetDescriptionResponse
Profiles set for the assignment.
relationshipLinks ResourceSetDescriptionResponse
The Role assignments set for the relationship links.
relationships ResourceSetDescriptionResponse
The Role assignments set for the relationships.
roleAssignments ResourceSetDescriptionResponse
The Role assignments set for the assignment.
sasPolicies ResourceSetDescriptionResponse
Sas Policies set for the assignment.
segments ResourceSetDescriptionResponse
The Role assignments set for the assignment.
views ResourceSetDescriptionResponse
Views set for the assignment.
widgetTypes ResourceSetDescriptionResponse
Widget types set for the assignment.
assignment_name str
The name of the metadata object.
id str
Resource ID.
name str
Resource name.
principals Sequence[AssignmentPrincipalResponse]
The principals being assigned to.
provisioning_state str
Provisioning state.
role str
Type of roles.
tenant_id str
The hub name.
type str
Resource type.
conflation_policies ResourceSetDescriptionResponse
Widget types set for the assignment.
connectors ResourceSetDescriptionResponse
Connectors set for the assignment.
description Mapping[str, str]
Localized description for the metadata.
display_name Mapping[str, str]
Localized display names for the metadata.
interactions ResourceSetDescriptionResponse
Interactions set for the assignment.
kpis ResourceSetDescriptionResponse
Kpis set for the assignment.
links ResourceSetDescriptionResponse
Links set for the assignment.
profiles ResourceSetDescriptionResponse
Profiles set for the assignment.
relationship_links ResourceSetDescriptionResponse
The Role assignments set for the relationship links.
relationships ResourceSetDescriptionResponse
The Role assignments set for the relationships.
role_assignments ResourceSetDescriptionResponse
The Role assignments set for the assignment.
sas_policies ResourceSetDescriptionResponse
Sas Policies set for the assignment.
segments ResourceSetDescriptionResponse
The Role assignments set for the assignment.
views ResourceSetDescriptionResponse
Views set for the assignment.
widget_types ResourceSetDescriptionResponse
Widget types set for the assignment.
assignmentName String
The name of the metadata object.
id String
Resource ID.
name String
Resource name.
principals List<Property Map>
The principals being assigned to.
provisioningState String
Provisioning state.
role String
Type of roles.
tenantId String
The hub name.
type String
Resource type.
conflationPolicies Property Map
Widget types set for the assignment.
connectors Property Map
Connectors set for the assignment.
description Map<String>
Localized description for the metadata.
displayName Map<String>
Localized display names for the metadata.
interactions Property Map
Interactions set for the assignment.
kpis Property Map
Kpis set for the assignment.
links Property Map
Links set for the assignment.
profiles Property Map
Profiles set for the assignment.
relationshipLinks Property Map
The Role assignments set for the relationship links.
relationships Property Map
The Role assignments set for the relationships.
roleAssignments Property Map
The Role assignments set for the assignment.
sasPolicies Property Map
Sas Policies set for the assignment.
segments Property Map
The Role assignments set for the assignment.
views Property Map
Views set for the assignment.
widgetTypes Property Map
Widget types set for the assignment.

Supporting Types

AssignmentPrincipalResponse

PrincipalId This property is required. string
The principal id being assigned to.
PrincipalType This property is required. string
The Type of the principal ID.
PrincipalMetadata Dictionary<string, string>
Other metadata for the principal.
PrincipalId This property is required. string
The principal id being assigned to.
PrincipalType This property is required. string
The Type of the principal ID.
PrincipalMetadata map[string]string
Other metadata for the principal.
principalId This property is required. String
The principal id being assigned to.
principalType This property is required. String
The Type of the principal ID.
principalMetadata Map<String,String>
Other metadata for the principal.
principalId This property is required. string
The principal id being assigned to.
principalType This property is required. string
The Type of the principal ID.
principalMetadata {[key: string]: string}
Other metadata for the principal.
principal_id This property is required. str
The principal id being assigned to.
principal_type This property is required. str
The Type of the principal ID.
principal_metadata Mapping[str, str]
Other metadata for the principal.
principalId This property is required. String
The principal id being assigned to.
principalType This property is required. String
The Type of the principal ID.
principalMetadata Map<String>
Other metadata for the principal.

ResourceSetDescriptionResponse

Elements List<string>
The elements included in the set.
Exceptions List<string>
The elements that are not included in the set, in case elements contains '*' indicating 'all'.
Elements []string
The elements included in the set.
Exceptions []string
The elements that are not included in the set, in case elements contains '*' indicating 'all'.
elements List<String>
The elements included in the set.
exceptions List<String>
The elements that are not included in the set, in case elements contains '*' indicating 'all'.
elements string[]
The elements included in the set.
exceptions string[]
The elements that are not included in the set, in case elements contains '*' indicating 'all'.
elements Sequence[str]
The elements included in the set.
exceptions Sequence[str]
The elements that are not included in the set, in case elements contains '*' indicating 'all'.
elements List<String>
The elements included in the set.
exceptions List<String>
The elements that are not included in the set, in case elements contains '*' indicating 'all'.

Package Details

Repository
azure-native-v1 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native