@azure/arm-guestconfiguration package

Classes

GuestConfigurationClient

Interfaces

AssignmentInfo

Information about the guest configuration assignment.
AssignmentReport

model interface 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.
GuestConfigurationAssignment

Guest configuration assignment is an association between a machine and guest configuration.
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.
GuestConfigurationAssignmentReportsGetOptionalParams

Optional parameters.
GuestConfigurationAssignmentReportsListOptionalParams

Optional parameters.
GuestConfigurationAssignmentReportsOperations

Interface representing a GuestConfigurationAssignmentReports operations.
GuestConfigurationAssignmentReportsVmssGetOptionalParams

Optional parameters.
GuestConfigurationAssignmentReportsVmssListOptionalParams

Optional parameters.
GuestConfigurationAssignmentReportsVmssOperations

Interface representing a GuestConfigurationAssignmentReportsVmss operations.
GuestConfigurationAssignmentsCreateOrUpdateOptionalParams

Optional parameters.
GuestConfigurationAssignmentsDeleteOptionalParams

Optional parameters.
GuestConfigurationAssignmentsGetOptionalParams

Optional parameters.
GuestConfigurationAssignmentsListOptionalParams

Optional parameters.
GuestConfigurationAssignmentsListRGListOptionalParams

Optional parameters.
GuestConfigurationAssignmentsListSubscriptionListOptionalParams

Optional parameters.
GuestConfigurationAssignmentsOperations

Interface representing a GuestConfigurationAssignments operations.
GuestConfigurationAssignmentsVmssCreateOrUpdateOptionalParams

Optional parameters.
GuestConfigurationAssignmentsVmssDeleteOptionalParams

Optional parameters.
GuestConfigurationAssignmentsVmssGetOptionalParams

Optional parameters.
GuestConfigurationAssignmentsVmssListOptionalParams

Optional parameters.
GuestConfigurationAssignmentsVmssOperations

Interface representing a GuestConfigurationAssignmentsVmss operations.
GuestConfigurationClientOptionalParams

Optional parameters for the client.
GuestConfigurationConnectedVMwarevSphereAssignmentsCreateOrUpdateOptionalParams

Optional parameters.
GuestConfigurationConnectedVMwarevSphereAssignmentsDeleteOptionalParams

Optional parameters.
GuestConfigurationConnectedVMwarevSphereAssignmentsGetOptionalParams

Optional parameters.
GuestConfigurationConnectedVMwarevSphereAssignmentsListOptionalParams

Optional parameters.
GuestConfigurationConnectedVMwarevSphereAssignmentsOperations

Interface representing a GuestConfigurationConnectedVMwarevSphereAssignments operations.
GuestConfigurationConnectedVMwarevSphereAssignmentsReportsGetOptionalParams

Optional parameters.
GuestConfigurationConnectedVMwarevSphereAssignmentsReportsListOptionalParams

Optional parameters.
GuestConfigurationConnectedVMwarevSphereAssignmentsReportsOperations

Interface representing a GuestConfigurationConnectedVMwarevSphereAssignmentsReports operations.
GuestConfigurationHcrpAssignmentReportsGetOptionalParams

Optional parameters.
GuestConfigurationHcrpAssignmentReportsListOptionalParams

Optional parameters.
GuestConfigurationHcrpAssignmentReportsOperations

Interface representing a GuestConfigurationHcrpAssignmentReports operations.
GuestConfigurationHcrpAssignmentsCreateOrUpdateOptionalParams

Optional parameters.
GuestConfigurationHcrpAssignmentsDeleteOptionalParams

Optional parameters.
GuestConfigurationHcrpAssignmentsGetOptionalParams

Optional parameters.
GuestConfigurationHcrpAssignmentsListOptionalParams

Optional parameters.
GuestConfigurationHcrpAssignmentsOperations

Interface representing a GuestConfigurationHcrpAssignments operations.
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.
OperationProperties

Provider, Resource, Operation and description values.
OperationsListOptionalParams

Optional parameters.
OperationsOperations

Interface representing a Operations operations.
PageSettings

Options for the byPage method
PagedAsyncIterableIterator

An interface that allows async iterable iteration both to completion and by page.
ProxyResource

ARM proxy resource.
SystemData

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

Information about the VM.
VmssvmInfo

Information about VMSS VM

Type Aliases

ActionAfterReboot

Specifies what happens after a reboot during the application of a configuration. The possible values are ContinueConfiguration and StopConfiguration
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

Specifies the assignment type and execution of the configuration. Possible values are Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect and ApplyAndMonitor.
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
AzureSupportedClouds

The supported values for cloud setting as a string literal type
ComplianceStatus

A value indicating compliance status of the machine for the assigned guest configuration.
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

Specifies how the LCM(Local Configuration Manager) actually applies the configuration to the target nodes. Possible values are ApplyOnly, ApplyAndMonitor, and ApplyAndAutoCorrect.
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
ContinuablePage

An interface that describes a page of results.
CreatedByType

The kind of entity that created the resource.
KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports.

Known values supported by the service

User: The entity was created by a user.
Application: The entity was created by an application.
ManagedIdentity: The entity was created by a managed identity.
Key: The entity was created by a key.
Kind

Kind of the guest configuration. For example:DSC
KnownKind can be used interchangeably with Kind, this enum contains the known values that the service supports.

Known values supported by the service

DSC
ProvisioningState

The provisioning state, which only appears in the response.
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

Type of report, Consistency or Initial
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

AzureClouds

An enum to describe Azure Cloud environments.
KnownActionAfterReboot

Specifies what happens after a reboot during the application of a configuration. The possible values are ContinueConfiguration and StopConfiguration
KnownAssignmentType

Specifies the assignment type and execution of the configuration. Possible values are Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect and ApplyAndMonitor.
KnownComplianceStatus

A value indicating compliance status of the machine for the assigned guest configuration.
KnownConfigurationMode

Specifies how the LCM(Local Configuration Manager) actually applies the configuration to the target nodes. Possible values are ApplyOnly, ApplyAndMonitor, and ApplyAndAutoCorrect.
KnownCreatedByType

The kind of entity that created the resource.
KnownKind

Kind of the guest configuration. For example:DSC
KnownProvisioningState

The provisioning state, which only appears in the response.
KnownType

Type of report, Consistency or Initial
KnownVersions

The available API versions.

Functions

isRestError(unknown)

Typeguard for RestError

Variables

RestError

A custom error type for failed pipeline requests.

Function Details

isRestError(unknown)

Typeguard for RestError

function isRestError(e: unknown): e

Parameters

e

unknown

Something caught by a catch clause.

Returns

e

Variable Details

RestError

A custom error type for failed pipeline requests.

RestError: RestErrorConstructor

Type

RestErrorConstructor