GuestConfigurationAssignments interface

Package:

@azure/arm-guestconfiguration

Interface representing a GuestConfigurationAssignments.

Methods

createOrUpdate(string, string, string, GuestConfigurationAssignment, GuestConfigurationAssignmentsCreateOrUpdateOptionalParams)	Creates an association between a VM and guest configuration
delete(string, string, string, GuestConfigurationAssignmentsDeleteOptionalParams)	Delete a guest configuration assignment
get(string, string, string, GuestConfigurationAssignmentsGetOptionalParams)	Get information about a guest configuration assignment
list(string, string, GuestConfigurationAssignmentsListOptionalParams)	List all guest configuration assignments for a virtual machine.
listRGList(string, GuestConfigurationAssignmentsRGListOptionalParams)	List all guest configuration assignments for a resource group.
listSubscriptionList(GuestConfigurationAssignmentsSubscriptionListOptionalParams)	List all guest configuration assignments for a subscription.

Method Details

createOrUpdate(string, string, string, GuestConfigurationAssignment, GuestConfigurationAssignmentsCreateOrUpdateOptionalParams)

Creates an association between a VM and guest configuration

function createOrUpdate(guestConfigurationAssignmentName: string, resourceGroupName: string, vmName: string, parameters: GuestConfigurationAssignment, options?: GuestConfigurationAssignmentsCreateOrUpdateOptionalParams): Promise<GuestConfigurationAssignment>

Parameters

guestConfigurationAssignmentName

string

Name of the guest configuration assignment.

resourceGroupName

string

The resource group name.

vmName

string

The name of the virtual machine.

parameters

GuestConfigurationAssignment

Parameters supplied to the create or update guest configuration assignment.

options

GuestConfigurationAssignmentsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<GuestConfigurationAssignment>

delete(string, string, string, GuestConfigurationAssignmentsDeleteOptionalParams)

Delete a guest configuration assignment

function delete(resourceGroupName: string, guestConfigurationAssignmentName: string, vmName: string, options?: GuestConfigurationAssignmentsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The resource group name.

guestConfigurationAssignmentName

string

Name of the guest configuration assignment

vmName

string

The name of the virtual machine.

options

GuestConfigurationAssignmentsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, GuestConfigurationAssignmentsGetOptionalParams)

Get information about a guest configuration assignment

function get(resourceGroupName: string, guestConfigurationAssignmentName: string, vmName: string, options?: GuestConfigurationAssignmentsGetOptionalParams): Promise<GuestConfigurationAssignment>

Parameters

resourceGroupName

string

The resource group name.

guestConfigurationAssignmentName

string

The guest configuration assignment name.

vmName

string

The name of the virtual machine.

options

GuestConfigurationAssignmentsGetOptionalParams

The options parameters.

Returns

Promise<GuestConfigurationAssignment>

list(string, string, GuestConfigurationAssignmentsListOptionalParams)

List all guest configuration assignments for a virtual machine.

function list(resourceGroupName: string, vmName: string, options?: GuestConfigurationAssignmentsListOptionalParams): PagedAsyncIterableIterator<GuestConfigurationAssignment, GuestConfigurationAssignment[], PageSettings>

Parameters

resourceGroupName

string

The resource group name.

vmName

string

The name of the virtual machine.

options

GuestConfigurationAssignmentsListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<GuestConfigurationAssignment, GuestConfigurationAssignment[], PageSettings>

listRGList(string, GuestConfigurationAssignmentsRGListOptionalParams)

List all guest configuration assignments for a resource group.

function listRGList(resourceGroupName: string, options?: GuestConfigurationAssignmentsRGListOptionalParams): PagedAsyncIterableIterator<GuestConfigurationAssignment, GuestConfigurationAssignment[], PageSettings>

Parameters

resourceGroupName

string

The resource group name.

options

GuestConfigurationAssignmentsRGListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<GuestConfigurationAssignment, GuestConfigurationAssignment[], PageSettings>

listSubscriptionList(GuestConfigurationAssignmentsSubscriptionListOptionalParams)

List all guest configuration assignments for a subscription.

function listSubscriptionList(options?: GuestConfigurationAssignmentsSubscriptionListOptionalParams): PagedAsyncIterableIterator<GuestConfigurationAssignment, GuestConfigurationAssignment[], PageSettings>

Parameters

options

GuestConfigurationAssignmentsSubscriptionListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<GuestConfigurationAssignment, GuestConfigurationAssignment[], PageSettings>