Package version:

Interface VirtualMachineScaleSetIdentity

Identity for the virtual machine scale set.

interface VirtualMachineScaleSetIdentity {
    principalId?: string;
    tenantId?: string;
    type?: ResourceIdentityType;
    userAssignedIdentities?: {
        [propertyName: string]: UserAssignedIdentitiesValue;
    };
}

Properties

principalId?: string

The principal id of virtual machine scale set identity. This property will only be provided for a system assigned identity. NOTE: This property will not be serialized. It can only be populated by the server.

tenantId?: string

The tenant id associated with the virtual machine scale set. This property will only be provided for a system assigned identity. NOTE: This property will not be serialized. It can only be populated by the server.

The type of identity used for the virtual machine scale set. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine scale set.

userAssignedIdentities?: {
    [propertyName: string]: UserAssignedIdentitiesValue;
}

The list of user identities associated with the virtual machine scale set. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.