guestconfiguration

package
v67.3.0+incompatible Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 10, 2023 License: MIT Imports: 9 Imported by: 0

Documentation

Overview

Deprecated: Please note, this package has been deprecated. A replacement package is available github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/guestconfiguration/armguestconfiguration(https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/guestconfiguration/armguestconfiguration). We strongly encourage you to upgrade to continue receiving updates. See [Migration Guide](https://aka.ms/azsdk/golang/t2/migration) for guidance on upgrading. Refer to our [deprecation policy](https://azure.github.io/azure-sdk/policies_support.html) for more details.

Package guestconfiguration implements the Azure ARM Guestconfiguration service API version 2020-06-25.

Guest Configuration Client

Index

Constants

View Source 
const (
	// DefaultBaseURI is the default URI used for the service Guestconfiguration
	DefaultBaseURI = "https://management.azure.com"
)

Variables

This section is empty.

Functions

func UserAgent 

func UserAgent() string

UserAgent returns the UserAgent string to use when sending http.Requests.

func Version 

func Version() string

Version returns the semantic version (see http://semver.org) of the client.

Types

type ActionAfterReboot 

type ActionAfterReboot string

ActionAfterReboot enumerates the values for action after reboot. 

const (
	// ActionAfterRebootContinueConfiguration ...
	ActionAfterRebootContinueConfiguration ActionAfterReboot = "ContinueConfiguration"
	// ActionAfterRebootStopConfiguration ...
	ActionAfterRebootStopConfiguration ActionAfterReboot = "StopConfiguration"
)

func PossibleActionAfterRebootValues 

func PossibleActionAfterRebootValues() []ActionAfterReboot

PossibleActionAfterRebootValues returns an array of possible values for the ActionAfterReboot const type.

type Assignment 

type Assignment struct {
	autorest.Response `json:"-"`
	// Properties - Properties of the Guest configuration assignment.
	Properties *AssignmentProperties `json:"properties,omitempty"`
	// ID - READ-ONLY; ARM resource id of the guest configuration assignment.
	ID *string `json:"id,omitempty"`
	// Name - Name of the guest configuration assignment.
	Name *string `json:"name,omitempty"`
	// Location - Region where the VM is located.
	Location *string `json:"location,omitempty"`
	// Type - READ-ONLY; The type of the resource.
	Type *string `json:"type,omitempty"`
}

Assignment guest configuration assignment is an association between a machine and guest configuration.

func (Assignment) MarshalJSON 

func (a Assignment) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Assignment.

type AssignmentInfo 

type AssignmentInfo struct {
	// Name - READ-ONLY; Name of the guest configuration assignment.
	Name *string `json:"name,omitempty"`
	// Configuration - Information about the configuration.
	Configuration *ConfigurationInfo `json:"configuration,omitempty"`
}

AssignmentInfo information about the guest configuration assignment.

func (AssignmentInfo) MarshalJSON 

func (ai AssignmentInfo) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AssignmentInfo.

type AssignmentList 

type AssignmentList struct {
	autorest.Response `json:"-"`
	// Value - Result of the list guest configuration assignment operation.
	Value *[]Assignment `json:"value,omitempty"`
}

AssignmentList the response of the list guest configuration assignment operation.

type AssignmentProperties 

type AssignmentProperties struct {
	// TargetResourceID - READ-ONLY; VM resource Id.
	TargetResourceID *string `json:"targetResourceId,omitempty"`
	// GuestConfiguration - The guest configuration to assign.
	GuestConfiguration *Navigation `json:"guestConfiguration,omitempty"`
	// ComplianceStatus - READ-ONLY; A value indicating compliance status of the machine for the assigned guest configuration. Possible values include: 'ComplianceStatusCompliant', 'ComplianceStatusNonCompliant', 'ComplianceStatusPending'
	ComplianceStatus ComplianceStatus `json:"complianceStatus,omitempty"`
	// LastComplianceStatusChecked - READ-ONLY; Date and time when last compliance status was checked.
	LastComplianceStatusChecked *date.Time `json:"lastComplianceStatusChecked,omitempty"`
	// LatestReportID - READ-ONLY; Id of the latest report for the guest configuration assignment.
	LatestReportID *string `json:"latestReportId,omitempty"`
	// LatestAssignmentReport - Last reported guest configuration assignment report.
	LatestAssignmentReport *AssignmentReport `json:"latestAssignmentReport,omitempty"`
	// Context - The source which initiated the guest configuration assignment. Ex: Azure Policy
	Context *string `json:"context,omitempty"`
	// AssignmentHash - READ-ONLY; Combined hash of the configuration package and parameters.
	AssignmentHash *string `json:"assignmentHash,omitempty"`
	// ProvisioningState - READ-ONLY; The provisioning state, which only appears in the response. Possible values include: 'ProvisioningStateSucceeded', 'ProvisioningStateFailed', 'ProvisioningStateCanceled', 'ProvisioningStateCreated'
	ProvisioningState ProvisioningState `json:"provisioningState,omitempty"`
}

AssignmentProperties guest configuration assignment properties.

func (AssignmentProperties) MarshalJSON 

func (ap AssignmentProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AssignmentProperties.

type AssignmentReport 

type AssignmentReport struct {
	// ID - READ-ONLY; ARM resource id of the report for the guest configuration assignment.
	ID *string `json:"id,omitempty"`
	// ReportID - READ-ONLY; GUID that identifies the guest configuration assignment report under a subscription, resource group.
	ReportID *string `json:"reportId,omitempty"`
	// Assignment - Configuration details of the guest configuration assignment.
	Assignment *AssignmentInfo `json:"assignment,omitempty"`
	// VM - Information about the VM.
	VM *VMInfo `json:"vm,omitempty"`
	// StartTime - READ-ONLY; Start date and time of the guest configuration assignment compliance status check.
	StartTime *date.Time `json:"startTime,omitempty"`
	// EndTime - READ-ONLY; End date and time of the guest configuration assignment compliance status check.
	EndTime *date.Time `json:"endTime,omitempty"`
	// ComplianceStatus - READ-ONLY; A value indicating compliance status of the machine for the assigned guest configuration. Possible values include: 'ComplianceStatusCompliant', 'ComplianceStatusNonCompliant', 'ComplianceStatusPending'
	ComplianceStatus ComplianceStatus `json:"complianceStatus,omitempty"`
	// OperationType - READ-ONLY; Type of report, Consistency or Initial. Possible values include: 'TypeConsistency', 'TypeInitial'
	OperationType Type `json:"operationType,omitempty"`
	// Resources - The list of resources for which guest configuration assignment compliance is checked.
	Resources *[]AssignmentReportResource `json:"resources,omitempty"`
}

AssignmentReport ...

func (AssignmentReport) MarshalJSON 

func (ar AssignmentReport) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AssignmentReport.

type AssignmentReportDetails 

type AssignmentReportDetails struct {
	// ComplianceStatus - READ-ONLY; A value indicating compliance status of the machine for the assigned guest configuration. Possible values include: 'ComplianceStatusCompliant', 'ComplianceStatusNonCompliant', 'ComplianceStatusPending'
	ComplianceStatus ComplianceStatus `json:"complianceStatus,omitempty"`
	// StartTime - READ-ONLY; Start date and time of the guest configuration assignment compliance status check.
	StartTime *date.Time `json:"startTime,omitempty"`
	// EndTime - READ-ONLY; End date and time of the guest configuration assignment compliance status check.
	EndTime *date.Time `json:"endTime,omitempty"`
	// JobID - READ-ONLY; GUID of the report.
	JobID *string `json:"jobId,omitempty"`
	// OperationType - READ-ONLY; Type of report, Consistency or Initial. Possible values include: 'TypeConsistency', 'TypeInitial'
	OperationType Type `json:"operationType,omitempty"`
	// Resources - The list of resources for which guest configuration assignment compliance is checked.
	Resources *[]AssignmentReportResource `json:"resources,omitempty"`
}

AssignmentReportDetails details of the guest configuration assignment report.

func (AssignmentReportDetails) MarshalJSON 

func (ard AssignmentReportDetails) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AssignmentReportDetails.

type AssignmentReportList 

type AssignmentReportList struct {
	autorest.Response `json:"-"`
	// Value - List of reports for the guest configuration. Report contains information such as compliance status, reason and more.
	Value *[]AssignmentReportType `json:"value,omitempty"`
}

AssignmentReportList list of guest configuration assignment reports.

type AssignmentReportProperties 

type AssignmentReportProperties struct {
	// ComplianceStatus - READ-ONLY; A value indicating compliance status of the machine for the assigned guest configuration. Possible values include: 'ComplianceStatusCompliant', 'ComplianceStatusNonCompliant', 'ComplianceStatusPending'
	ComplianceStatus ComplianceStatus `json:"complianceStatus,omitempty"`
	// ReportID - READ-ONLY; GUID that identifies the guest configuration assignment report under a subscription, resource group.
	ReportID *string `json:"reportId,omitempty"`
	// Assignment - Configuration details of the guest configuration assignment.
	Assignment *AssignmentInfo `json:"assignment,omitempty"`
	// VM - Information about the VM.
	VM *VMInfo `json:"vm,omitempty"`
	// StartTime - READ-ONLY; Start date and time of the guest configuration assignment compliance status check.
	StartTime *date.Time `json:"startTime,omitempty"`
	// EndTime - READ-ONLY; End date and time of the guest configuration assignment compliance status check.
	EndTime *date.Time `json:"endTime,omitempty"`
	// Details - Details of the assignment report.
	Details *AssignmentReportDetails `json:"details,omitempty"`
}

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

func (AssignmentReportProperties) MarshalJSON 

func (arp AssignmentReportProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AssignmentReportProperties.

type AssignmentReportResource 

type AssignmentReportResource struct {
	// ComplianceStatus - READ-ONLY; A value indicating compliance status of the machine for the assigned guest configuration. Possible values include: 'ComplianceStatusCompliant', 'ComplianceStatusNonCompliant', 'ComplianceStatusPending'
	ComplianceStatus ComplianceStatus `json:"complianceStatus,omitempty"`
	// ResourceID - READ-ONLY; Name of the guest configuration assignment resource setting.
	ResourceID *string `json:"resourceId,omitempty"`
	// Reasons - Compliance reason and reason code for a resource.
	Reasons *[]AssignmentReportResourceComplianceReason `json:"reasons,omitempty"`
	// Properties - READ-ONLY; Properties of a guest configuration assignment resource.
	Properties interface{} `json:"properties,omitempty"`
}

AssignmentReportResource the guest configuration assignment resource.

func (AssignmentReportResource) MarshalJSON 

func (arr AssignmentReportResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AssignmentReportResource.

type AssignmentReportResourceComplianceReason 

type AssignmentReportResourceComplianceReason struct {
	// Phrase - READ-ONLY; Reason for the compliance of the guest configuration assignment resource.
	Phrase *string `json:"phrase,omitempty"`
	// Code - READ-ONLY; Code for the compliance of the guest configuration assignment resource.
	Code *string `json:"code,omitempty"`
}

AssignmentReportResourceComplianceReason reason and code for the compliance of the guest configuration assignment resource.

func (AssignmentReportResourceComplianceReason) MarshalJSON 

func (arrcr AssignmentReportResourceComplianceReason) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AssignmentReportResourceComplianceReason.

type AssignmentReportType 

type AssignmentReportType struct {
	autorest.Response `json:"-"`
	// ID - READ-ONLY; ARM resource id of the report for the guest configuration assignment.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; GUID that identifies the guest configuration assignment report under a subscription, resource group.
	Name *string `json:"name,omitempty"`
	// Properties - Properties of the guest configuration report.
	Properties *AssignmentReportProperties `json:"properties,omitempty"`
}

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

func (AssignmentReportType) MarshalJSON 

func (art AssignmentReportType) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AssignmentReportType.

type AssignmentReportsClient 

type AssignmentReportsClient struct {
	BaseClient
}

AssignmentReportsClient is the guest Configuration Client

func NewAssignmentReportsClient 

func NewAssignmentReportsClient(subscriptionID string) AssignmentReportsClient

NewAssignmentReportsClient creates an instance of the AssignmentReportsClient client.

func NewAssignmentReportsClientWithBaseURI 

func NewAssignmentReportsClientWithBaseURI(baseURI string, subscriptionID string) AssignmentReportsClient

NewAssignmentReportsClientWithBaseURI creates an instance of the AssignmentReportsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (AssignmentReportsClient) Get 

func (client AssignmentReportsClient) Get(ctx context.Context, resourceGroupName string, guestConfigurationAssignmentName string, reportID string, VMName string) (result AssignmentReportType, err error)

Get get a report for the guest configuration assignment, by reportId. Parameters: resourceGroupName - the resource group name. guestConfigurationAssignmentName - the guest configuration assignment name. reportID - the GUID for the guest configuration assignment report. VMName - the name of the virtual machine.

func (AssignmentReportsClient) GetPreparer 

func (client AssignmentReportsClient) GetPreparer(ctx context.Context, resourceGroupName string, guestConfigurationAssignmentName string, reportID string, VMName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (AssignmentReportsClient) GetResponder 

func (client AssignmentReportsClient) GetResponder(resp *http.Response) (result AssignmentReportType, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (AssignmentReportsClient) GetSender 

func (client AssignmentReportsClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (AssignmentReportsClient) List 

func (client AssignmentReportsClient) List(ctx context.Context, resourceGroupName string, guestConfigurationAssignmentName string, VMName string) (result AssignmentReportList, err error)

List list all reports for the guest configuration assignment, latest report first. Parameters: resourceGroupName - the resource group name. guestConfigurationAssignmentName - the guest configuration assignment name. VMName - the name of the virtual machine.

func (AssignmentReportsClient) ListPreparer 

func (client AssignmentReportsClient) ListPreparer(ctx context.Context, resourceGroupName string, guestConfigurationAssignmentName string, VMName string) (*http.Request, error)

ListPreparer prepares the List request.

func (AssignmentReportsClient) ListResponder 

func (client AssignmentReportsClient) ListResponder(resp *http.Response) (result AssignmentReportList, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (AssignmentReportsClient) ListSender 

func (client AssignmentReportsClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

type AssignmentType 

type AssignmentType string

AssignmentType enumerates the values for assignment type. 

const (
	// AssignmentTypeApplyAndAutoCorrect ...
	AssignmentTypeApplyAndAutoCorrect AssignmentType = "ApplyAndAutoCorrect"
	// AssignmentTypeApplyAndMonitor ...
	AssignmentTypeApplyAndMonitor AssignmentType = "ApplyAndMonitor"
	// AssignmentTypeAudit ...
	AssignmentTypeAudit AssignmentType = "Audit"
	// AssignmentTypeDeployAndAutoCorrect ...
	AssignmentTypeDeployAndAutoCorrect AssignmentType = "DeployAndAutoCorrect"
)

func PossibleAssignmentTypeValues 

func PossibleAssignmentTypeValues() []AssignmentType

PossibleAssignmentTypeValues returns an array of possible values for the AssignmentType const type.

type AssignmentsClient 

type AssignmentsClient struct {
	BaseClient
}

AssignmentsClient is the guest Configuration Client

func NewAssignmentsClient 

func NewAssignmentsClient(subscriptionID string) AssignmentsClient

NewAssignmentsClient creates an instance of the AssignmentsClient client.

func NewAssignmentsClientWithBaseURI 

func NewAssignmentsClientWithBaseURI(baseURI string, subscriptionID string) AssignmentsClient

NewAssignmentsClientWithBaseURI creates an instance of the AssignmentsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (AssignmentsClient) CreateOrUpdate 

func (client AssignmentsClient) CreateOrUpdate(ctx context.Context, guestConfigurationAssignmentName string, parameters Assignment, resourceGroupName string, VMName string) (result Assignment, err error)

CreateOrUpdate creates an association between a VM and guest configuration Parameters: guestConfigurationAssignmentName - name of the guest configuration assignment. parameters - parameters supplied to the create or update guest configuration assignment. resourceGroupName - the resource group name. VMName - the name of the virtual machine.

func (AssignmentsClient) CreateOrUpdatePreparer 

func (client AssignmentsClient) CreateOrUpdatePreparer(ctx context.Context, guestConfigurationAssignmentName string, parameters Assignment, resourceGroupName string, VMName string) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (AssignmentsClient) CreateOrUpdateResponder 

func (client AssignmentsClient) CreateOrUpdateResponder(resp *http.Response) (result Assignment, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (AssignmentsClient) CreateOrUpdateSender 

func (client AssignmentsClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)

CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.

func (AssignmentsClient) Delete 

func (client AssignmentsClient) Delete(ctx context.Context, resourceGroupName string, guestConfigurationAssignmentName string, VMName string) (result autorest.Response, err error)

Delete delete a guest configuration assignment Parameters: resourceGroupName - the resource group name. guestConfigurationAssignmentName - name of the guest configuration assignment VMName - the name of the virtual machine.

func (AssignmentsClient) DeletePreparer 

func (client AssignmentsClient) DeletePreparer(ctx context.Context, resourceGroupName string, guestConfigurationAssignmentName string, VMName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (AssignmentsClient) DeleteResponder 

func (client AssignmentsClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (AssignmentsClient) DeleteSender 

func (client AssignmentsClient) DeleteSender(req *http.Request) (*http.Response, error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (AssignmentsClient) Get 

func (client AssignmentsClient) Get(ctx context.Context, resourceGroupName string, guestConfigurationAssignmentName string, VMName string) (result Assignment, err error)

Get get information about a guest configuration assignment Parameters: resourceGroupName - the resource group name. guestConfigurationAssignmentName - the guest configuration assignment name. VMName - the name of the virtual machine.

func (AssignmentsClient) GetPreparer 

func (client AssignmentsClient) GetPreparer(ctx context.Context, resourceGroupName string, guestConfigurationAssignmentName string, VMName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (AssignmentsClient) GetResponder 

func (client AssignmentsClient) GetResponder(resp *http.Response) (result Assignment, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (AssignmentsClient) GetSender 

func (client AssignmentsClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (AssignmentsClient) List 

func (client AssignmentsClient) List(ctx context.Context, resourceGroupName string, VMName string) (result AssignmentList, err error)

List list all guest configuration assignments for a virtual machine. Parameters: resourceGroupName - the resource group name. VMName - the name of the virtual machine.

func (AssignmentsClient) ListPreparer 

func (client AssignmentsClient) ListPreparer(ctx context.Context, resourceGroupName string, VMName string) (*http.Request, error)

ListPreparer prepares the List request.

func (AssignmentsClient) ListResponder 

func (client AssignmentsClient) ListResponder(resp *http.Response) (result AssignmentList, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (AssignmentsClient) ListSender 

func (client AssignmentsClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

type BaseClient 

type BaseClient struct {
	autorest.Client
	BaseURI        string
	SubscriptionID string
}

BaseClient is the base client for Guestconfiguration.

func New 

func New(subscriptionID string) BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI 

func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient

NewWithBaseURI creates an instance of the BaseClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

type ComplianceStatus 

type ComplianceStatus string

ComplianceStatus enumerates the values for compliance status. 

const (
	// ComplianceStatusCompliant ...
	ComplianceStatusCompliant ComplianceStatus = "Compliant"
	// ComplianceStatusNonCompliant ...
	ComplianceStatusNonCompliant ComplianceStatus = "NonCompliant"
	// ComplianceStatusPending ...
	ComplianceStatusPending ComplianceStatus = "Pending"
)

func PossibleComplianceStatusValues 

func PossibleComplianceStatusValues() []ComplianceStatus

PossibleComplianceStatusValues returns an array of possible values for the ComplianceStatus const type.

type ConfigurationInfo 

type ConfigurationInfo struct {
	// Name - READ-ONLY; Name of the configuration.
	Name *string `json:"name,omitempty"`
	// Version - READ-ONLY; Version of the configuration.
	Version *string `json:"version,omitempty"`
}

ConfigurationInfo information about the configuration.

func (ConfigurationInfo) MarshalJSON 

func (ci ConfigurationInfo) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ConfigurationInfo.

type ConfigurationMode 

type ConfigurationMode string

ConfigurationMode enumerates the values for configuration mode. 

const (
	// ConfigurationModeApplyAndAutoCorrect ...
	ConfigurationModeApplyAndAutoCorrect ConfigurationMode = "ApplyAndAutoCorrect"
	// ConfigurationModeApplyAndMonitor ...
	ConfigurationModeApplyAndMonitor ConfigurationMode = "ApplyAndMonitor"
	// ConfigurationModeApplyOnly ...
	ConfigurationModeApplyOnly ConfigurationMode = "ApplyOnly"
)

func PossibleConfigurationModeValues 

func PossibleConfigurationModeValues() []ConfigurationMode

PossibleConfigurationModeValues returns an array of possible values for the ConfigurationMode const type.

type ConfigurationParameter 

type ConfigurationParameter struct {
	// Name - Name of the configuration parameter.
	Name *string `json:"name,omitempty"`
	// Value - Value of the configuration parameter.
	Value *string `json:"value,omitempty"`
}

ConfigurationParameter represents a configuration parameter.

type ConfigurationSetting 

type ConfigurationSetting struct {
	// ConfigurationMode - Specifies how the LCM(Local Configuration Manager) actually applies the configuration to the target nodes. Possible values are ApplyOnly, ApplyAndMonitor, and ApplyAndAutoCorrect. Possible values include: 'ConfigurationModeApplyOnly', 'ConfigurationModeApplyAndMonitor', 'ConfigurationModeApplyAndAutoCorrect'
	ConfigurationMode ConfigurationMode `json:"configurationMode,omitempty"`
	// AllowModuleOverwrite - If true - new configurations downloaded from the pull service are allowed to overwrite the old ones on the target node. Otherwise, false
	AllowModuleOverwrite *bool `json:"allowModuleOverwrite,omitempty"`
	// ActionAfterReboot - Specifies what happens after a reboot during the application of a configuration. The possible values are ContinueConfiguration and StopConfiguration. Possible values include: 'ActionAfterRebootContinueConfiguration', 'ActionAfterRebootStopConfiguration'
	ActionAfterReboot ActionAfterReboot `json:"actionAfterReboot,omitempty"`
	// RefreshFrequencyMins - The time interval, in minutes, at which the LCM checks a pull service to get updated configurations. This value is ignored if the LCM is not configured in pull mode. The default value is 30.
	RefreshFrequencyMins *float64 `json:"refreshFrequencyMins,omitempty"`
	// RebootIfNeeded - Set this to true to automatically reboot the node after a configuration that requires reboot is applied. Otherwise, you will have to manually reboot the node for any configuration that requires it. The default value is false. To use this setting when a reboot condition is enacted by something other than DSC (such as Windows Installer), combine this setting with the xPendingReboot module.
	RebootIfNeeded *bool `json:"rebootIfNeeded,omitempty"`
	// ConfigurationModeFrequencyMins - How often, in minutes, the current configuration is checked and applied. This property is ignored if the ConfigurationMode property is set to ApplyOnly. The default value is 15.
	ConfigurationModeFrequencyMins *float64 `json:"configurationModeFrequencyMins,omitempty"`
}

ConfigurationSetting configuration setting of LCM (Local Configuration Manager).

type ErrorResponse 

type ErrorResponse struct {
	Error *ErrorResponseError `json:"error,omitempty"`
}

ErrorResponse error response of an operation failure

type ErrorResponseError 

type ErrorResponseError struct {
	// Code - Error code.
	Code *string `json:"code,omitempty"`
	// Message - Detail error message indicating why the operation failed.
	Message *string `json:"message,omitempty"`
}

ErrorResponseError ...

type HCRPAssignmentReportsClient 

type HCRPAssignmentReportsClient struct {
	BaseClient
}

HCRPAssignmentReportsClient is the guest Configuration Client

func NewHCRPAssignmentReportsClient 

func NewHCRPAssignmentReportsClient(subscriptionID string) HCRPAssignmentReportsClient

NewHCRPAssignmentReportsClient creates an instance of the HCRPAssignmentReportsClient client.

func NewHCRPAssignmentReportsClientWithBaseURI 

func NewHCRPAssignmentReportsClientWithBaseURI(baseURI string, subscriptionID string) HCRPAssignmentReportsClient

NewHCRPAssignmentReportsClientWithBaseURI creates an instance of the HCRPAssignmentReportsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (HCRPAssignmentReportsClient) Get 

func (client HCRPAssignmentReportsClient) Get(ctx context.Context, resourceGroupName string, guestConfigurationAssignmentName string, reportID string, machineName string) (result AssignmentReportType, err error)

Get get a report for the guest configuration assignment, by reportId. Parameters: resourceGroupName - the resource group name. guestConfigurationAssignmentName - the guest configuration assignment name. reportID - the GUID for the guest configuration assignment report. machineName - the name of the ARC machine.

func (HCRPAssignmentReportsClient) GetPreparer 

func (client HCRPAssignmentReportsClient) GetPreparer(ctx context.Context, resourceGroupName string, guestConfigurationAssignmentName string, reportID string, machineName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (HCRPAssignmentReportsClient) GetResponder 

func (client HCRPAssignmentReportsClient) GetResponder(resp *http.Response) (result AssignmentReportType, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (HCRPAssignmentReportsClient) GetSender 

func (client HCRPAssignmentReportsClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (HCRPAssignmentReportsClient) List 

func (client HCRPAssignmentReportsClient) List(ctx context.Context, resourceGroupName string, guestConfigurationAssignmentName string, machineName string) (result AssignmentReportList, err error)

List list all reports for the guest configuration assignment, latest report first. Parameters: resourceGroupName - the resource group name. guestConfigurationAssignmentName - the guest configuration assignment name. machineName - the name of the ARC machine.

func (HCRPAssignmentReportsClient) ListPreparer 

func (client HCRPAssignmentReportsClient) ListPreparer(ctx context.Context, resourceGroupName string, guestConfigurationAssignmentName string, machineName string) (*http.Request, error)

ListPreparer prepares the List request.

func (HCRPAssignmentReportsClient) ListResponder 

func (client HCRPAssignmentReportsClient) ListResponder(resp *http.Response) (result AssignmentReportList, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (HCRPAssignmentReportsClient) ListSender 

func (client HCRPAssignmentReportsClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

type HCRPAssignmentsClient 

type HCRPAssignmentsClient struct {
	BaseClient
}

HCRPAssignmentsClient is the guest Configuration Client

func NewHCRPAssignmentsClient 

func NewHCRPAssignmentsClient(subscriptionID string) HCRPAssignmentsClient

NewHCRPAssignmentsClient creates an instance of the HCRPAssignmentsClient client.

func NewHCRPAssignmentsClientWithBaseURI 

func NewHCRPAssignmentsClientWithBaseURI(baseURI string, subscriptionID string) HCRPAssignmentsClient

NewHCRPAssignmentsClientWithBaseURI creates an instance of the HCRPAssignmentsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (HCRPAssignmentsClient) CreateOrUpdate 

func (client HCRPAssignmentsClient) CreateOrUpdate(ctx context.Context, guestConfigurationAssignmentName string, parameters Assignment, resourceGroupName string, machineName string) (result Assignment, err error)

CreateOrUpdate creates an association between a ARC machine and guest configuration Parameters: guestConfigurationAssignmentName - name of the guest configuration assignment. parameters - parameters supplied to the create or update guest configuration assignment. resourceGroupName - the resource group name. machineName - the name of the ARC machine.

func (HCRPAssignmentsClient) CreateOrUpdatePreparer 

func (client HCRPAssignmentsClient) CreateOrUpdatePreparer(ctx context.Context, guestConfigurationAssignmentName string, parameters Assignment, resourceGroupName string, machineName string) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (HCRPAssignmentsClient) CreateOrUpdateResponder 

func (client HCRPAssignmentsClient) CreateOrUpdateResponder(resp *http.Response) (result Assignment, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (HCRPAssignmentsClient) CreateOrUpdateSender 

func (client HCRPAssignmentsClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)

CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.

func (HCRPAssignmentsClient) Delete 

func (client HCRPAssignmentsClient) Delete(ctx context.Context, resourceGroupName string, guestConfigurationAssignmentName string, machineName string) (result autorest.Response, err error)

Delete delete a guest configuration assignment Parameters: resourceGroupName - the resource group name. guestConfigurationAssignmentName - name of the guest configuration assignment machineName - the name of the ARC machine.

func (HCRPAssignmentsClient) DeletePreparer 

func (client HCRPAssignmentsClient) DeletePreparer(ctx context.Context, resourceGroupName string, guestConfigurationAssignmentName string, machineName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (HCRPAssignmentsClient) DeleteResponder 

func (client HCRPAssignmentsClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (HCRPAssignmentsClient) DeleteSender 

func (client HCRPAssignmentsClient) DeleteSender(req *http.Request) (*http.Response, error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (HCRPAssignmentsClient) Get 

func (client HCRPAssignmentsClient) Get(ctx context.Context, resourceGroupName string, guestConfigurationAssignmentName string, machineName string) (result Assignment, err error)

Get get information about a guest configuration assignment Parameters: resourceGroupName - the resource group name. guestConfigurationAssignmentName - the guest configuration assignment name. machineName - the name of the ARC machine.

func (HCRPAssignmentsClient) GetPreparer 

func (client HCRPAssignmentsClient) GetPreparer(ctx context.Context, resourceGroupName string, guestConfigurationAssignmentName string, machineName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (HCRPAssignmentsClient) GetResponder 

func (client HCRPAssignmentsClient) GetResponder(resp *http.Response) (result Assignment, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (HCRPAssignmentsClient) GetSender 

func (client HCRPAssignmentsClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (HCRPAssignmentsClient) List 

func (client HCRPAssignmentsClient) List(ctx context.Context, resourceGroupName string, machineName string) (result AssignmentList, err error)

List list all guest configuration assignments for an ARC machine. Parameters: resourceGroupName - the resource group name. machineName - the name of the ARC machine.

func (HCRPAssignmentsClient) ListPreparer 

func (client HCRPAssignmentsClient) ListPreparer(ctx context.Context, resourceGroupName string, machineName string) (*http.Request, error)

ListPreparer prepares the List request.

func (HCRPAssignmentsClient) ListResponder 

func (client HCRPAssignmentsClient) ListResponder(resp *http.Response) (result AssignmentList, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (HCRPAssignmentsClient) ListSender 

func (client HCRPAssignmentsClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

type Kind 

type Kind string

Kind enumerates the values for kind. 

const (
	// KindDSC ...
	KindDSC Kind = "DSC"
)

func PossibleKindValues 

func PossibleKindValues() []Kind

PossibleKindValues returns an array of possible values for the Kind const type. 

type Navigation struct {
	// Kind - Kind of the guest configuration. For example:DSC. Possible values include: 'KindDSC'
	Kind Kind `json:"kind,omitempty"`
	// Name - Name of the guest configuration.
	Name *string `json:"name,omitempty"`
	// Version - Version of the guest configuration.
	Version *string `json:"version,omitempty"`
	// ContentURI - Uri of the storage where guest configuration package is uploaded.
	ContentURI *string `json:"contentUri,omitempty"`
	// ContentHash - Combined hash of the guest configuration package and configuration parameters.
	ContentHash *string `json:"contentHash,omitempty"`
	// AssignmentType - Specifies the assignment type and execution of the configuration. Possible values are Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect and ApplyAndMonitor. Possible values include: 'AssignmentTypeAudit', 'AssignmentTypeDeployAndAutoCorrect', 'AssignmentTypeApplyAndAutoCorrect', 'AssignmentTypeApplyAndMonitor'
	AssignmentType AssignmentType `json:"assignmentType,omitempty"`
	// ConfigurationParameter - The configuration parameters for the guest configuration.
	ConfigurationParameter *[]ConfigurationParameter `json:"configurationParameter,omitempty"`
	// ConfigurationSetting - The configuration setting for the guest configuration.
	ConfigurationSetting *ConfigurationSetting `json:"configurationSetting,omitempty"`
}

Navigation 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.

type Operation 

type Operation struct {
	// Name - Operation name: For ex. providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/write or read
	Name *string `json:"name,omitempty"`
	// Display - Provider, Resource, Operation and description values.
	Display *OperationDisplay `json:"display,omitempty"`
	// OperationProperties - Provider, Resource, Operation and description values.
	*OperationProperties `json:"properties,omitempty"`
}

Operation guestConfiguration REST API operation

func (Operation) MarshalJSON 

func (o Operation) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Operation.

func (*Operation) UnmarshalJSON 

func (o *Operation) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for Operation struct.

type OperationDisplay 

type OperationDisplay struct {
	// Provider - Service provider: Microsoft.GuestConfiguration
	Provider *string `json:"provider,omitempty"`
	// Resource - Resource on which the operation is performed:  For ex.
	Resource *string `json:"resource,omitempty"`
	// Operation - Operation type: Read, write, delete, etc.
	Operation *string `json:"operation,omitempty"`
	// Description - Description about operation.
	Description *string `json:"description,omitempty"`
}

OperationDisplay provider, Resource, Operation and description values.

type OperationList 

type OperationList struct {
	autorest.Response `json:"-"`
	// Value - List of Automation operations supported by the Automation resource provider.
	Value *[]Operation `json:"value,omitempty"`
}

OperationList the response model for the list of Automation operations

type OperationProperties 

type OperationProperties struct {
	// StatusCode - Service provider: Microsoft.GuestConfiguration
	StatusCode *string `json:"statusCode,omitempty"`
}

OperationProperties provider, Resource, Operation and description values.

type OperationsClient 

type OperationsClient struct {
	BaseClient
}

OperationsClient is the guest Configuration Client

func NewOperationsClient 

func NewOperationsClient(subscriptionID string) OperationsClient

NewOperationsClient creates an instance of the OperationsClient client.

func NewOperationsClientWithBaseURI 

func NewOperationsClientWithBaseURI(baseURI string, subscriptionID string) OperationsClient

NewOperationsClientWithBaseURI creates an instance of the OperationsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (OperationsClient) List 

func (client OperationsClient) List(ctx context.Context) (result OperationList, err error)

List lists all of the available GuestConfiguration REST API operations.

func (OperationsClient) ListPreparer 

func (client OperationsClient) ListPreparer(ctx context.Context) (*http.Request, error)

ListPreparer prepares the List request.

func (OperationsClient) ListResponder 

func (client OperationsClient) ListResponder(resp *http.Response) (result OperationList, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (OperationsClient) ListSender 

func (client OperationsClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

type ProvisioningState 

type ProvisioningState string

ProvisioningState enumerates the values for provisioning state. 

const (
	// ProvisioningStateCanceled ...
	ProvisioningStateCanceled ProvisioningState = "Canceled"
	// ProvisioningStateCreated ...
	ProvisioningStateCreated ProvisioningState = "Created"
	// ProvisioningStateFailed ...
	ProvisioningStateFailed ProvisioningState = "Failed"
	// ProvisioningStateSucceeded ...
	ProvisioningStateSucceeded ProvisioningState = "Succeeded"
)

func PossibleProvisioningStateValues 

func PossibleProvisioningStateValues() []ProvisioningState

PossibleProvisioningStateValues returns an array of possible values for the ProvisioningState const type.

type ProxyResource 

type ProxyResource struct {
	// ID - READ-ONLY; ARM resource id of the guest configuration assignment.
	ID *string `json:"id,omitempty"`
	// Name - Name of the guest configuration assignment.
	Name *string `json:"name,omitempty"`
	// Location - Region where the VM is located.
	Location *string `json:"location,omitempty"`
	// Type - READ-ONLY; The type of the resource.
	Type *string `json:"type,omitempty"`
}

ProxyResource ARM proxy resource.

func (ProxyResource) MarshalJSON 

func (pr ProxyResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ProxyResource.

type Resource 

type Resource struct {
	// ID - READ-ONLY; ARM resource id of the guest configuration assignment.
	ID *string `json:"id,omitempty"`
	// Name - Name of the guest configuration assignment.
	Name *string `json:"name,omitempty"`
	// Location - Region where the VM is located.
	Location *string `json:"location,omitempty"`
	// Type - READ-ONLY; The type of the resource.
	Type *string `json:"type,omitempty"`
}

Resource the core properties of ARM resources

func (Resource) MarshalJSON 

func (r Resource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Resource.

type TrackedResource 

type TrackedResource struct {
	// Tags - Resource tags.
	Tags map[string]*string `json:"tags"`
	// ID - READ-ONLY; ARM resource id of the guest configuration assignment.
	ID *string `json:"id,omitempty"`
	// Name - Name of the guest configuration assignment.
	Name *string `json:"name,omitempty"`
	// Location - Region where the VM is located.
	Location *string `json:"location,omitempty"`
	// Type - READ-ONLY; The type of the resource.
	Type *string `json:"type,omitempty"`
}

TrackedResource the resource model definition for a ARM tracked top level resource

func (TrackedResource) MarshalJSON 

func (tr TrackedResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for TrackedResource.

type Type 

type Type string

Type enumerates the values for type. 

const (
	// TypeConsistency ...
	TypeConsistency Type = "Consistency"
	// TypeInitial ...
	TypeInitial Type = "Initial"
)

func PossibleTypeValues 

func PossibleTypeValues() []Type

PossibleTypeValues returns an array of possible values for the Type const type.

type VMInfo 

type VMInfo struct {
	// ID - READ-ONLY; Azure resource Id of the VM.
	ID *string `json:"id,omitempty"`
	// UUID - READ-ONLY; UUID(Universally Unique Identifier) of the VM.
	UUID *string `json:"uuid,omitempty"`
}

VMInfo information about the VM.

func (VMInfo) MarshalJSON 

func (vi VMInfo) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for VMInfo.

Source Files

View all Source files

Directories

Path Synopsis
Deprecated: Please note, this package has been deprecated.
 Deprecated: Please note, this package has been deprecated.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.