guestconfigurationhcrpassignments

package
v0.20230807.1063129 Latest Latest
Warning

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

Go to latest
Published: Aug 7, 2023 License: MPL-2.0 Imports: 12 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/guestconfiguration/2020-06-25/guestconfigurationhcrpassignments Documentation

The guestconfigurationhcrpassignments SDK allows for interaction with the Azure Resource Manager Service guestconfiguration (API Version 2020-06-25).

This readme covers example usages, but further information on using this SDK can be found in the project root.

Import Path

import "github.com/hashicorp/go-azure-sdk/resource-manager/guestconfiguration/2020-06-25/guestconfigurationhcrpassignments"

Client Initialization

client := guestconfigurationhcrpassignments.NewGuestConfigurationHCRPAssignmentsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: GuestConfigurationHCRPAssignmentsClient.CreateOrUpdate

ctx := context.TODO()
id := guestconfigurationhcrpassignments.NewGuestConfigurationAssignmentID("12345678-1234-9876-4563-123456789012", "example-resource-group", "machineValue", "guestConfigurationAssignmentValue")

payload := guestconfigurationhcrpassignments.GuestConfigurationAssignment{
	// ...
}


read, err := client.CreateOrUpdate(ctx, id, payload)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: GuestConfigurationHCRPAssignmentsClient.Delete

ctx := context.TODO()
id := guestconfigurationhcrpassignments.NewGuestConfigurationAssignmentID("12345678-1234-9876-4563-123456789012", "example-resource-group", "machineValue", "guestConfigurationAssignmentValue")

read, err := client.Delete(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: GuestConfigurationHCRPAssignmentsClient.Get

ctx := context.TODO()
id := guestconfigurationhcrpassignments.NewGuestConfigurationAssignmentID("12345678-1234-9876-4563-123456789012", "example-resource-group", "machineValue", "guestConfigurationAssignmentValue")

read, err := client.Get(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: GuestConfigurationHCRPAssignmentsClient.List

ctx := context.TODO()
id := guestconfigurationhcrpassignments.NewMachineID("12345678-1234-9876-4563-123456789012", "example-resource-group", "machineValue")

read, err := client.List(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForActionAfterReboot

func PossibleValuesForActionAfterReboot() []string

func PossibleValuesForAssignmentType

func PossibleValuesForAssignmentType() []string

func PossibleValuesForComplianceStatus

func PossibleValuesForComplianceStatus() []string

func PossibleValuesForConfigurationMode

func PossibleValuesForConfigurationMode() []string

func PossibleValuesForKind

func PossibleValuesForKind() []string

func PossibleValuesForProvisioningState

func PossibleValuesForProvisioningState() []string

func PossibleValuesForType

func PossibleValuesForType() []string

func ValidateGuestConfigurationAssignmentID

func ValidateGuestConfigurationAssignmentID(input interface{}, key string) (warnings []string, errors []error)

ValidateGuestConfigurationAssignmentID checks that 'input' can be parsed as a Guest Configuration Assignment ID

func ValidateMachineID

func ValidateMachineID(input interface{}, key string) (warnings []string, errors []error)

ValidateMachineID checks that 'input' can be parsed as a Machine ID

Types

type ActionAfterReboot

type ActionAfterReboot string
const (
	ActionAfterRebootContinueConfiguration ActionAfterReboot = "ContinueConfiguration"
	ActionAfterRebootStopConfiguration     ActionAfterReboot = "StopConfiguration"
)

func (*ActionAfterReboot) UnmarshalJSON

func (s *ActionAfterReboot) UnmarshalJSON(bytes []byte) error

type AssignmentInfo

type AssignmentInfo struct {
	Configuration *ConfigurationInfo `json:"configuration,omitempty"`
	Name          *string            `json:"name,omitempty"`
}

type AssignmentReport

type AssignmentReport struct {
	Assignment       *AssignmentInfo             `json:"assignment,omitempty"`
	ComplianceStatus *ComplianceStatus           `json:"complianceStatus,omitempty"`
	EndTime          *string                     `json:"endTime,omitempty"`
	Id               *string                     `json:"id,omitempty"`
	OperationType    *Type                       `json:"operationType,omitempty"`
	ReportId         *string                     `json:"reportId,omitempty"`
	Resources        *[]AssignmentReportResource `json:"resources,omitempty"`
	StartTime        *string                     `json:"startTime,omitempty"`
	VM               *VMInfo                     `json:"vm,omitempty"`
}

func (*AssignmentReport) GetEndTimeAsTime

func (o *AssignmentReport) GetEndTimeAsTime() (*time.Time, error)

func (*AssignmentReport) GetStartTimeAsTime

func (o *AssignmentReport) GetStartTimeAsTime() (*time.Time, error)

func (*AssignmentReport) SetEndTimeAsTime

func (o *AssignmentReport) SetEndTimeAsTime(input time.Time)

func (*AssignmentReport) SetStartTimeAsTime

func (o *AssignmentReport) SetStartTimeAsTime(input time.Time)

type AssignmentReportResource

type AssignmentReportResource struct {
	ComplianceStatus *ComplianceStatus                           `json:"complianceStatus,omitempty"`
	Properties       *interface{}                                `json:"properties,omitempty"`
	Reasons          *[]AssignmentReportResourceComplianceReason `json:"reasons,omitempty"`
	ResourceId       *string                                     `json:"resourceId,omitempty"`
}

type AssignmentReportResourceComplianceReason

type AssignmentReportResourceComplianceReason struct {
	Code   *string `json:"code,omitempty"`
	Phrase *string `json:"phrase,omitempty"`
}

type AssignmentType

type AssignmentType string
const (
	AssignmentTypeApplyAndAutoCorrect  AssignmentType = "ApplyAndAutoCorrect"
	AssignmentTypeApplyAndMonitor      AssignmentType = "ApplyAndMonitor"
	AssignmentTypeAudit                AssignmentType = "Audit"
	AssignmentTypeDeployAndAutoCorrect AssignmentType = "DeployAndAutoCorrect"
)

func (*AssignmentType) UnmarshalJSON

func (s *AssignmentType) UnmarshalJSON(bytes []byte) error

type ComplianceStatus

type ComplianceStatus string
const (
	ComplianceStatusCompliant    ComplianceStatus = "Compliant"
	ComplianceStatusNonCompliant ComplianceStatus = "NonCompliant"
	ComplianceStatusPending      ComplianceStatus = "Pending"
)

func (*ComplianceStatus) UnmarshalJSON

func (s *ComplianceStatus) UnmarshalJSON(bytes []byte) error

type ConfigurationInfo

type ConfigurationInfo struct {
	Name    *string `json:"name,omitempty"`
	Version *string `json:"version,omitempty"`
}

type ConfigurationMode

type ConfigurationMode string
const (
	ConfigurationModeApplyAndAutoCorrect ConfigurationMode = "ApplyAndAutoCorrect"
	ConfigurationModeApplyAndMonitor     ConfigurationMode = "ApplyAndMonitor"
	ConfigurationModeApplyOnly           ConfigurationMode = "ApplyOnly"
)

func (*ConfigurationMode) UnmarshalJSON

func (s *ConfigurationMode) UnmarshalJSON(bytes []byte) error

type ConfigurationParameter

type ConfigurationParameter struct {
	Name  *string `json:"name,omitempty"`
	Value *string `json:"value,omitempty"`
}

type ConfigurationSetting

type ConfigurationSetting struct {
	ActionAfterReboot              *ActionAfterReboot `json:"actionAfterReboot,omitempty"`
	AllowModuleOverwrite           *bool              `json:"allowModuleOverwrite,omitempty"`
	ConfigurationMode              *ConfigurationMode `json:"configurationMode,omitempty"`
	ConfigurationModeFrequencyMins *float64           `json:"configurationModeFrequencyMins,omitempty"`
	RebootIfNeeded                 *bool              `json:"rebootIfNeeded,omitempty"`
	RefreshFrequencyMins           *float64           `json:"refreshFrequencyMins,omitempty"`
}

type CreateOrUpdateOperationResponse

type CreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *GuestConfigurationAssignment
}

type DeleteOperationResponse

type DeleteOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type GetOperationResponse

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *GuestConfigurationAssignment
}

type GuestConfigurationAssignment

type GuestConfigurationAssignment struct {
	Id         *string                                 `json:"id,omitempty"`
	Location   *string                                 `json:"location,omitempty"`
	Name       *string                                 `json:"name,omitempty"`
	Properties *GuestConfigurationAssignmentProperties `json:"properties,omitempty"`
	Type       *string                                 `json:"type,omitempty"`
}

type GuestConfigurationAssignmentId

type GuestConfigurationAssignmentId struct {
	SubscriptionId                   string
	ResourceGroupName                string
	MachineName                      string
	GuestConfigurationAssignmentName string
}

GuestConfigurationAssignmentId is a struct representing the Resource ID for a Guest Configuration Assignment

func NewGuestConfigurationAssignmentID

func NewGuestConfigurationAssignmentID(subscriptionId string, resourceGroupName string, machineName string, guestConfigurationAssignmentName string) GuestConfigurationAssignmentId

NewGuestConfigurationAssignmentID returns a new GuestConfigurationAssignmentId struct

func ParseGuestConfigurationAssignmentID

func ParseGuestConfigurationAssignmentID(input string) (*GuestConfigurationAssignmentId, error)

ParseGuestConfigurationAssignmentID parses 'input' into a GuestConfigurationAssignmentId

func ParseGuestConfigurationAssignmentIDInsensitively

func ParseGuestConfigurationAssignmentIDInsensitively(input string) (*GuestConfigurationAssignmentId, error)

ParseGuestConfigurationAssignmentIDInsensitively parses 'input' case-insensitively into a GuestConfigurationAssignmentId note: this method should only be used for API response data and not user input

func (GuestConfigurationAssignmentId) ID

ID returns the formatted Guest Configuration Assignment ID

func (GuestConfigurationAssignmentId) Segments

Segments returns a slice of Resource ID Segments which comprise this Guest Configuration Assignment ID

func (GuestConfigurationAssignmentId) String

String returns a human-readable description of this Guest Configuration Assignment ID

type GuestConfigurationAssignmentList

type GuestConfigurationAssignmentList struct {
	Value *[]GuestConfigurationAssignment `json:"value,omitempty"`
}

type GuestConfigurationAssignmentProperties

type GuestConfigurationAssignmentProperties struct {
	AssignmentHash              *string                       `json:"assignmentHash,omitempty"`
	ComplianceStatus            *ComplianceStatus             `json:"complianceStatus,omitempty"`
	Context                     *string                       `json:"context,omitempty"`
	GuestConfiguration          *GuestConfigurationNavigation `json:"guestConfiguration,omitempty"`
	LastComplianceStatusChecked *string                       `json:"lastComplianceStatusChecked,omitempty"`
	LatestAssignmentReport      *AssignmentReport             `json:"latestAssignmentReport,omitempty"`
	LatestReportId              *string                       `json:"latestReportId,omitempty"`
	ParameterHash               *string                       `json:"parameterHash,omitempty"`
	ProvisioningState           *ProvisioningState            `json:"provisioningState,omitempty"`
	ResourceType                *string                       `json:"resourceType,omitempty"`
	TargetResourceId            *string                       `json:"targetResourceId,omitempty"`
	VMSSVMList                  *[]VMSSVMInfo                 `json:"vmssVMList,omitempty"`
}

func (*GuestConfigurationAssignmentProperties) GetLastComplianceStatusCheckedAsTime

func (o *GuestConfigurationAssignmentProperties) GetLastComplianceStatusCheckedAsTime() (*time.Time, error)

func (*GuestConfigurationAssignmentProperties) SetLastComplianceStatusCheckedAsTime

func (o *GuestConfigurationAssignmentProperties) SetLastComplianceStatusCheckedAsTime(input time.Time)

type GuestConfigurationHCRPAssignmentsClient

type GuestConfigurationHCRPAssignmentsClient struct {
	Client *resourcemanager.Client
}

func NewGuestConfigurationHCRPAssignmentsClientWithBaseURI

func NewGuestConfigurationHCRPAssignmentsClientWithBaseURI(sdkApi sdkEnv.Api) (*GuestConfigurationHCRPAssignmentsClient, error)

func (GuestConfigurationHCRPAssignmentsClient) CreateOrUpdate

CreateOrUpdate ...

func (GuestConfigurationHCRPAssignmentsClient) Delete

Delete ...

func (GuestConfigurationHCRPAssignmentsClient) Get

Get ...

func (GuestConfigurationHCRPAssignmentsClient) List

List ...

type GuestConfigurationNavigation

type GuestConfigurationNavigation struct {
	AssignmentType                  *AssignmentType           `json:"assignmentType,omitempty"`
	ConfigurationParameter          *[]ConfigurationParameter `json:"configurationParameter,omitempty"`
	ConfigurationProtectedParameter *[]ConfigurationParameter `json:"configurationProtectedParameter,omitempty"`
	ConfigurationSetting            *ConfigurationSetting     `json:"configurationSetting,omitempty"`
	ContentHash                     *string                   `json:"contentHash,omitempty"`
	ContentType                     *string                   `json:"contentType,omitempty"`
	ContentUri                      *string                   `json:"contentUri,omitempty"`
	Kind                            *Kind                     `json:"kind,omitempty"`
	Name                            *string                   `json:"name,omitempty"`
	Version                         *string                   `json:"version,omitempty"`
}

type Kind

type Kind string
const (
	KindDSC Kind = "DSC"
)

func (*Kind) UnmarshalJSON

func (s *Kind) UnmarshalJSON(bytes []byte) error

type ListOperationResponse

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *GuestConfigurationAssignmentList
}

type MachineId

type MachineId struct {
	SubscriptionId    string
	ResourceGroupName string
	MachineName       string
}

MachineId is a struct representing the Resource ID for a Machine

func NewMachineID

func NewMachineID(subscriptionId string, resourceGroupName string, machineName string) MachineId

NewMachineID returns a new MachineId struct

func ParseMachineID

func ParseMachineID(input string) (*MachineId, error)

ParseMachineID parses 'input' into a MachineId

func ParseMachineIDInsensitively

func ParseMachineIDInsensitively(input string) (*MachineId, error)

ParseMachineIDInsensitively parses 'input' case-insensitively into a MachineId note: this method should only be used for API response data and not user input

func (MachineId) ID

func (id MachineId) ID() string

ID returns the formatted Machine ID

func (MachineId) Segments

func (id MachineId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Machine ID

func (MachineId) String

func (id MachineId) String() string

String returns a human-readable description of this Machine ID

type ProvisioningState

type ProvisioningState string
const (
	ProvisioningStateCanceled  ProvisioningState = "Canceled"
	ProvisioningStateCreated   ProvisioningState = "Created"
	ProvisioningStateFailed    ProvisioningState = "Failed"
	ProvisioningStateSucceeded ProvisioningState = "Succeeded"
)

func (*ProvisioningState) UnmarshalJSON

func (s *ProvisioningState) UnmarshalJSON(bytes []byte) error

type Type

type Type string
const (
	TypeConsistency Type = "Consistency"
	TypeInitial     Type = "Initial"
)

func (*Type) UnmarshalJSON

func (s *Type) UnmarshalJSON(bytes []byte) error

type VMInfo

type VMInfo struct {
	Id   *string `json:"id,omitempty"`
	Uuid *string `json:"uuid,omitempty"`
}

type VMSSVMInfo

type VMSSVMInfo struct {
	ComplianceStatus      *ComplianceStatus `json:"complianceStatus,omitempty"`
	LastComplianceChecked *string           `json:"lastComplianceChecked,omitempty"`
	LatestReportId        *string           `json:"latestReportId,omitempty"`
	VMId                  *string           `json:"vmId,omitempty"`
	VMResourceId          *string           `json:"vmResourceId,omitempty"`
}

func (*VMSSVMInfo) GetLastComplianceCheckedAsTime

func (o *VMSSVMInfo) GetLastComplianceCheckedAsTime() (*time.Time, error)

func (*VMSSVMInfo) SetLastComplianceCheckedAsTime

func (o *VMSSVMInfo) SetLastComplianceCheckedAsTime(input time.Time)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL