VivaEngagementRoleMember

Parameters

Parameter	Attribute	DataType	Description	Allowed Values
Role	Key	String	Name of the engagement role.
Members	Write	String[]	User principal names of the users to assign to the role.
Credential	Write	PSCredential	Credentials of the workload's Admin
ApplicationId	Write	String	Id of the Azure Active Directory application to authenticate with.
TenantId	Write	String	Id of the Azure Active Directory tenant used for authentication.
CertificateThumbprint	Write	String	Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication.
CertificatePassword	Write	PSCredential	Username can be made up to anything but password will be used for CertificatePassword
CertificatePath	Write	String	Path to certificate used in service principal usually a PFX file.
ManagedIdentity	Write	Boolean	Managed ID being used for authentication.
AccessTokens	Write	String[]	Access token used for authentication.

Description

Manage a Viva Engage roles assigned to a user.

Permissions

Graph

To authenticate with the Graph API, this resource requires the following permissions:

Delegated permissions

• Read

• EngagementRole.Read.All, User.ReadBasic.All

• Update

• EngagementRole.ReadWrite.All, User.ReadBasic.All

Application permissions

• Read

• EngagementRole.Read.All, User.ReadBasic.All

• Update

• EngagementRole.ReadWrite.All, User.ReadBasic.All

Examples

Example 1

This example is used to test new resources and showcase the usage of new resources being worked on. It is not meant to use as a production baseline.

Configuration Example
{
    param
    (
        [Parameter()]
        [System.String]
        $ApplicationId,

        [Parameter()]
        [System.String]
        $TenantId,

        [Parameter()]
        [System.String]
        $CertificateThumbprint
    )

    Import-DscResource -ModuleName Microsoft365DSC

    Node localhost
    {
        VivaEngagementRoleMember "VivaEngagementRoleMember-Example1"
        {
            Members               = @("admin@contoso.com");
            Role                  = "Network Admin";
            ApplicationId         = $ApplicationId;
            TenantId              = $TenantId;
            CertificateThumbprint = $CertificateThumbprint;
        }
        VivaEngagementRoleMember "VivaEngagementRoleMember-Example2"
        {
            Members               = @("admin@contoso.com","NestorW@contoso.com");
            Role                  = "Verified Admin";
            ApplicationId         = $ApplicationId;
            TenantId              = $TenantId;
            CertificateThumbprint = $CertificateThumbprint;
        }
        VivaEngagementRoleMember "VivaEngagementRoleMember-Example3"
        {
            Members               = @("NestorW@contoso.com","AllanD@contoso.com");
            Role                  = "Corporate Communicator";
            ApplicationId         = $ApplicationId;
            TenantId              = $TenantId;
            CertificateThumbprint = $CertificateThumbprint;
        }
    }
}

Example 2

This example is used to test new resources and showcase the usage of new resources being worked on. It is not meant to use as a production baseline.

Configuration Example
{
    param
    (
        [Parameter()]
        [System.String]
        $ApplicationId,

        [Parameter()]
        [System.String]
        $TenantId,

        [Parameter()]
        [System.String]
        $CertificateThumbprint
    )

    Import-DscResource -ModuleName Microsoft365DSC

    Node localhost
    {
        VivaEngagementRoleMember "VivaEngagementRoleMember-Example1"
        {
            Members               = @();
            Role                  = "Network Admin";
            ApplicationId         = $ApplicationId;
            TenantId              = $TenantId;
            CertificateThumbprint = $CertificateThumbprint;
        }
        VivaEngagementRoleMember "VivaEngagementRoleMember-Example2"
        {
            Members               = @();
            Role                  = "Verified Admin";
            ApplicationId         = $ApplicationId;
            TenantId              = $TenantId;
            CertificateThumbprint = $CertificateThumbprint;
        }
        VivaEngagementRoleMember "VivaEngagementRoleMember-Example3"
        {
            Members               = @();
            Role                  = "Corporate Communicator";
            ApplicationId         = $ApplicationId;
            TenantId              = $TenantId;
            CertificateThumbprint = $CertificateThumbprint;
        }
    }
}