Share via

VirtualMachineIdentity Class

  • Reference
Package:
com.azure.resourcemanager.compute.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-compute:2.39.0
  • java.lang.Object
    • com.azure.resourcemanager.compute.models.VirtualMachineIdentity

public final class VirtualMachineIdentity

Identity for the virtual machine.

Constructor Summary

Constructor Description
VirtualMachineIdentity()

Creates an instance of VirtualMachineIdentity class.

Method Summary

Modifier and Type Method and Description
String principalId()

Get the principalId property: The principal id of virtual machine identity.
String tenantId()

Get the tenantId property: The tenant id associated with the virtual machine.
ResourceIdentityType type()

Get the type property: The type of identity used for the virtual machine.
Map<String,VirtualMachineIdentityUserAssignedIdentities> userAssignedIdentities()

Get the userAssignedIdentities property: The list of user identities associated with the Virtual Machine.
void validate()

Validates the instance.
VirtualMachineIdentity withType(ResourceIdentityType type)

Set the type property: The type of identity used for the virtual machine.
VirtualMachineIdentity withUserAssignedIdentities(Map<String,VirtualMachineIdentityUserAssignedIdentities> userAssignedIdentities)

Set the userAssignedIdentities property: The list of user identities associated with the Virtual Machine.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

VirtualMachineIdentity

public VirtualMachineIdentity()

Creates an instance of VirtualMachineIdentity class.

Method Details

principalId

public String principalId()

Get the principalId property: The principal id of virtual machine identity. This property will only be provided for a system assigned identity.

Returns:

the principalId value.

tenantId

public String tenantId()

Get the tenantId property: The tenant id associated with the virtual machine. This property will only be provided for a system assigned identity.

Returns:

the tenantId value.

type

public ResourceIdentityType type()

Get the type property: The type of identity used for the virtual machine. 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.

Returns:

the type value.

userAssignedIdentities

public Map userAssignedIdentities()

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

Returns:

the userAssignedIdentities value.

validate

public void validate()

Validates the instance.

withType

public VirtualMachineIdentity withType(ResourceIdentityType type)

Set the type property: The type of identity used for the virtual machine. 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.

Parameters:

type - the type value to set.

Returns:

the VirtualMachineIdentity object itself.

withUserAssignedIdentities

public VirtualMachineIdentity withUserAssignedIdentities(Map userAssignedIdentities)

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

Parameters:

userAssignedIdentities - the userAssignedIdentities value to set.

Returns:

the VirtualMachineIdentity object itself.

Applies to