Share via

VirtualMachineScaleSetIdentity interface

  • Reference
Package:
@azure/arm-compute-profile-2020-09-01-hybrid

Identity for the virtual machine scale set.

Properties

principalId

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

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.
type

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

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}'.

Property Details

principalId

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.

principalId?: string

Property Value

string

tenantId

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.

tenantId?: string

Property Value

string

type

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.

type?: ResourceIdentityType

Property Value

ResourceIdentityType

userAssignedIdentities

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}'.

userAssignedIdentities?: {[propertyName: string]: VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue}

Property Value

{[propertyName: string]: VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue}