Edit

Share via

Get-AzGuestConfigurationAssignment

  • Preview
Module:
Az.GuestConfiguration Module

This cmdlet is part of a Preview module. Preview versions aren't recommended for use in production environments. For more information, see https://aka.ms/azps-refstatus.

Get information about a guest configuration assignment

Syntax

List (Default) 

Get-AzGuestConfigurationAssignment
    [-SubscriptionId <String[]>]
    [-DefaultProfile <PSObject>]
    [-PassThru]
    [<CommonParameters>]

Get2 

Get-AzGuestConfigurationAssignment
    -Name <String>
    -ResourceGroupName <String>
    -VmssName <String>
    [-SubscriptionId <String[]>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

Get1 

Get-AzGuestConfigurationAssignment
    -Name <String>
    -ResourceGroupName <String>
    -MachineName <String>
    [-SubscriptionId <String[]>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

Get 

Get-AzGuestConfigurationAssignment
    -Name <String>
    -ResourceGroupName <String>
    -VMName <String>
    [-SubscriptionId <String[]>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

List4 

Get-AzGuestConfigurationAssignment
    -ResourceGroupName <String>
    -VmssName <String>
    [-SubscriptionId <String[]>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

List3 

Get-AzGuestConfigurationAssignment
    -ResourceGroupName <String>
    -MachineName <String>
    [-SubscriptionId <String[]>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

List2 

Get-AzGuestConfigurationAssignment
    -ResourceGroupName <String>
    -VMName <String>
    [-SubscriptionId <String[]>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

List1 

Get-AzGuestConfigurationAssignment
    -ResourceGroupName <String>
    [-SubscriptionId <String[]>]
    [-DefaultProfile <PSObject>]
    [-PassThru]
    [<CommonParameters>]

Description

Get information about a guest configuration assignment

Examples

Example 1: Get a specific guest configuration assignment

Get-AzGuestConfigurationAssignment -ResourceGroupName test-rg -VMName test-vm  -GuestConfigurationAssignmentName test-assignment

Location      Name     ResourceGroupName
--------      ----     -----------------
westcentralus test-assignment test-rg

Get a specific guest configuration assignment

Example 2: List guest configuration assignments for a VM

Get-AzGuestConfigurationAssignment -ResourceGroupName test-rg -VMName test-vm

Location      Name     ResourceGroupName
--------      ----     -----------------
westcentralus test-assignment test-rg

List guest configuration assignments for a VM

Example 3: List guest configuration assignments for a VMSS

Get-AzGuestConfigurationAssignment -ResourceGroupName test-rg -VmssName test-vmss

Location      Name     ResourceGroupName
--------      ----     -----------------
westcentralus test-assignment test-rg

List guest configuration assignments for a VMSS

Example 4: List guest configuration assignments for a ARC machine

Get-AzGuestConfigurationAssignment -ResourceGroupName test-rg -MachineName test-machine

Location      Name     ResourceGroupName
--------      ----     -----------------
westcentralus test-assignment test-rg

List guest configuration assignments for a ARC machine

Example 5: List guest configuration assignments for a resource group

Get-AzGuestConfigurationAssignment -ResourceGroupName test-rg

Location      Name     ResourceGroupName
--------      ----     -----------------
westcentralus test-assignment1 test-rg
westcentralus test-assignment2 test-rg

List guest configuration assignments for a resource group

Example 6: List guest configuration assignments for a subscription

Get-AzGuestConfigurationAssignment -SubscriptionId xxxxx-xxxx-xxxxx-xxx

Location      Name     ResourceGroupName
--------      ----     -----------------
westcentralus test-assignment1 test-rg
westcentralus test-assignment2 test-rg

List guest configuration assignments for a subscription

Parameters

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Parameter properties

Type:PSObject
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AzureRMContext, AzureCredential

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-MachineName

The name of the ARC machine.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Get1
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
List3
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Name

The guest configuration assignment name.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:GuestConfigurationAssignmentName

Parameter sets

Get2
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Get1
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Get
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PassThru

Returns true when the command succeeds

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

List
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
List1
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ResourceGroupName

The resource group name.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Get2
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Get1
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Get
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
List4
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
List3
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
List2
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
List1
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SubscriptionId

Subscription ID which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Parameter properties

Type:

String[]

Default value:(Get-AzContext).Subscription.Id
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-VMName

The name of the virtual machine.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Get
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
List2
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-VmssName

The name of the virtual machine scale set.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Get2
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
List4
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Outputs

IGuestConfigurationAssignment