Share via

@azure/arm-guestconfiguration package

Classes

GuestConfigurationClient

Interfaces

AssignmentInfo

Information about the guest configuration assignment.
AssignmentReport
AssignmentReportDetails

Details of the guest configuration assignment report.
AssignmentReportResource

The guest configuration assignment resource.
AssignmentReportResourceComplianceReason

Reason and code for the compliance of the guest configuration assignment resource.
ConfigurationInfo

Information about the configuration.
ConfigurationParameter

Represents a configuration parameter.
ConfigurationSetting

Configuration setting of LCM (Local Configuration Manager).
ErrorResponse

Error response of an operation failure
ErrorResponseError
GuestConfigurationAssignment

Guest configuration assignment is an association between a machine and guest configuration.
GuestConfigurationAssignmentList

The response of the list guest configuration assignment operation.
GuestConfigurationAssignmentProperties

Guest configuration assignment properties.
GuestConfigurationAssignmentReport

Report for the guest configuration assignment. Report contains information such as compliance status, reason, and more.
GuestConfigurationAssignmentReportList

List of guest configuration assignment reports.
GuestConfigurationAssignmentReportProperties

Report for the guest configuration assignment. Report contains information such as compliance status, reason, and more.
GuestConfigurationAssignmentReports

Interface representing a GuestConfigurationAssignmentReports.
GuestConfigurationAssignmentReportsGetOptionalParams

Optional parameters.
GuestConfigurationAssignmentReportsListOptionalParams

Optional parameters.
GuestConfigurationAssignmentReportsVmss

Interface representing a GuestConfigurationAssignmentReportsVmss.
GuestConfigurationAssignmentReportsVmssGetOptionalParams

Optional parameters.
GuestConfigurationAssignmentReportsVmssListOptionalParams

Optional parameters.
GuestConfigurationAssignments

Interface representing a GuestConfigurationAssignments.
GuestConfigurationAssignmentsCreateOrUpdateOptionalParams

Optional parameters.
GuestConfigurationAssignmentsDeleteOptionalParams

Optional parameters.
GuestConfigurationAssignmentsGetOptionalParams

Optional parameters.
GuestConfigurationAssignmentsListOptionalParams

Optional parameters.
GuestConfigurationAssignmentsRGListOptionalParams

Optional parameters.
GuestConfigurationAssignmentsSubscriptionListOptionalParams

Optional parameters.
GuestConfigurationAssignmentsVmss

Interface representing a GuestConfigurationAssignmentsVmss.
GuestConfigurationAssignmentsVmssCreateOrUpdateOptionalParams

Optional parameters.
GuestConfigurationAssignmentsVmssDeleteOptionalParams

Optional parameters.
GuestConfigurationAssignmentsVmssGetOptionalParams

Optional parameters.
GuestConfigurationAssignmentsVmssListOptionalParams

Optional parameters.
GuestConfigurationClientOptionalParams

Optional parameters.
GuestConfigurationConnectedVMwarevSphereAssignments

Interface representing a GuestConfigurationConnectedVMwarevSphereAssignments.
GuestConfigurationConnectedVMwarevSphereAssignmentsCreateOrUpdateOptionalParams

Optional parameters.
GuestConfigurationConnectedVMwarevSphereAssignmentsDeleteOptionalParams

Optional parameters.
GuestConfigurationConnectedVMwarevSphereAssignmentsGetOptionalParams

Optional parameters.
GuestConfigurationConnectedVMwarevSphereAssignmentsListOptionalParams

Optional parameters.
GuestConfigurationConnectedVMwarevSphereAssignmentsReports

Interface representing a GuestConfigurationConnectedVMwarevSphereAssignmentsReports.
GuestConfigurationConnectedVMwarevSphereAssignmentsReportsGetOptionalParams

Optional parameters.
GuestConfigurationConnectedVMwarevSphereAssignmentsReportsListOptionalParams

Optional parameters.
GuestConfigurationHcrpAssignmentReports

Interface representing a GuestConfigurationHcrpAssignmentReports.
GuestConfigurationHcrpAssignmentReportsGetOptionalParams

Optional parameters.
GuestConfigurationHcrpAssignmentReportsListOptionalParams

Optional parameters.
GuestConfigurationHcrpAssignments

Interface representing a GuestConfigurationHcrpAssignments.
GuestConfigurationHcrpAssignmentsCreateOrUpdateOptionalParams

Optional parameters.
GuestConfigurationHcrpAssignmentsDeleteOptionalParams

Optional parameters.
GuestConfigurationHcrpAssignmentsGetOptionalParams

Optional parameters.
GuestConfigurationHcrpAssignmentsListOptionalParams

Optional parameters.
GuestConfigurationNavigation

Guest configuration is an artifact that encapsulates DSC configuration and its dependencies. The artifact is a zip file containing DSC configuration (as MOF) and dependent resources and other dependencies like modules.
Operation

GuestConfiguration REST API operation
OperationDisplay

Provider, Resource, Operation and description values.
OperationList

The response model for the list of Automation operations
OperationProperties

Provider, Resource, Operation and description values.
Operations

Interface representing a Operations.
OperationsListOptionalParams

Optional parameters.
ProxyResource

ARM proxy resource.
Resource

The core properties of ARM resources
SystemData

Metadata pertaining to creation and last modification of the resource.
VMInfo

Information about the VM.
VmssvmInfo

Information about VMSS VM

Type Aliases

ActionAfterReboot

Defines values for ActionAfterReboot.
KnownActionAfterReboot can be used interchangeably with ActionAfterReboot, this enum contains the known values that the service supports.

Known values supported by the service

ContinueConfiguration
StopConfiguration
AssignmentType

Defines values for AssignmentType.
KnownAssignmentType can be used interchangeably with AssignmentType, this enum contains the known values that the service supports.

Known values supported by the service

Audit
DeployAndAutoCorrect
ApplyAndAutoCorrect
ApplyAndMonitor
ComplianceStatus

Defines values for ComplianceStatus.
KnownComplianceStatus can be used interchangeably with ComplianceStatus, this enum contains the known values that the service supports.

Known values supported by the service

Compliant
NonCompliant
Pending
ConfigurationMode

Defines values for ConfigurationMode.
KnownConfigurationMode can be used interchangeably with ConfigurationMode, this enum contains the known values that the service supports.

Known values supported by the service

ApplyOnly
ApplyAndMonitor
ApplyAndAutoCorrect
CreatedByType

Defines values for CreatedByType.
KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports.

Known values supported by the service

User
Application
ManagedIdentity
Key
GuestConfigurationAssignmentReportsGetResponse

Contains response data for the get operation.
GuestConfigurationAssignmentReportsListResponse

Contains response data for the list operation.
GuestConfigurationAssignmentReportsVmssGetResponse

Contains response data for the get operation.
GuestConfigurationAssignmentReportsVmssListResponse

Contains response data for the list operation.
GuestConfigurationAssignmentsCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.
GuestConfigurationAssignmentsGetResponse

Contains response data for the get operation.
GuestConfigurationAssignmentsListResponse

Contains response data for the list operation.
GuestConfigurationAssignmentsRGListResponse

Contains response data for the rGList operation.
GuestConfigurationAssignmentsSubscriptionListResponse

Contains response data for the subscriptionList operation.
GuestConfigurationAssignmentsVmssCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.
GuestConfigurationAssignmentsVmssDeleteResponse

Contains response data for the delete operation.
GuestConfigurationAssignmentsVmssGetResponse

Contains response data for the get operation.
GuestConfigurationAssignmentsVmssListResponse

Contains response data for the list operation.
GuestConfigurationConnectedVMwarevSphereAssignmentsCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.
GuestConfigurationConnectedVMwarevSphereAssignmentsGetResponse

Contains response data for the get operation.
GuestConfigurationConnectedVMwarevSphereAssignmentsListResponse

Contains response data for the list operation.
GuestConfigurationConnectedVMwarevSphereAssignmentsReportsGetResponse

Contains response data for the get operation.
GuestConfigurationConnectedVMwarevSphereAssignmentsReportsListResponse

Contains response data for the list operation.
GuestConfigurationHcrpAssignmentReportsGetResponse

Contains response data for the get operation.
GuestConfigurationHcrpAssignmentReportsListResponse

Contains response data for the list operation.
GuestConfigurationHcrpAssignmentsCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.
GuestConfigurationHcrpAssignmentsGetResponse

Contains response data for the get operation.
GuestConfigurationHcrpAssignmentsListResponse

Contains response data for the list operation.
Kind

Defines values for Kind.
KnownKind can be used interchangeably with Kind, this enum contains the known values that the service supports.

Known values supported by the service

DSC
OperationsListResponse

Contains response data for the list operation.
ProvisioningState

Defines values for ProvisioningState.
KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded
Failed
Canceled
Created
Type

Defines values for Type.
KnownType can be used interchangeably with Type, this enum contains the known values that the service supports.

Known values supported by the service

Consistency
Initial

Enums

KnownActionAfterReboot

Known values of ActionAfterReboot that the service accepts.
KnownAssignmentType

Known values of AssignmentType that the service accepts.
KnownComplianceStatus

Known values of ComplianceStatus that the service accepts.
KnownConfigurationMode

Known values of ConfigurationMode that the service accepts.
KnownCreatedByType

Known values of CreatedByType that the service accepts.
KnownKind

Known values of Kind that the service accepts.
KnownProvisioningState

Known values of ProvisioningState that the service accepts.
KnownType

Known values of Type that the service accepts.

Functions

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

Function Details

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

function getContinuationToken(page: unknown): string | undefined

Parameters

page

unknown

An object from accessing value on the IteratorResult from a byPage iterator.

Returns

string | undefined

The continuation token that can be passed into byPage() during future calls.