dscconfiguration

package
v0.20231121.1184305 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/automation/2023-11-01/dscconfiguration Documentation

The dscconfiguration SDK allows for interaction with the Azure Resource Manager Service automation (API Version 2023-11-01).

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/automation/2023-11-01/dscconfiguration"

Client Initialization

client := dscconfiguration.NewDscConfigurationClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: DscConfigurationClient.CreateOrUpdate

ctx := context.TODO()
id := dscconfiguration.NewConfigurationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "automationAccountValue", "configurationValue")

payload := dscconfiguration.DscConfigurationCreateOrUpdateParameters{
	// ...
}


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: DscConfigurationClient.Delete

ctx := context.TODO()
id := dscconfiguration.NewConfigurationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "automationAccountValue", "configurationValue")

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: DscConfigurationClient.Get

ctx := context.TODO()
id := dscconfiguration.NewConfigurationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "automationAccountValue", "configurationValue")

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: DscConfigurationClient.GetContent

ctx := context.TODO()
id := dscconfiguration.NewConfigurationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "automationAccountValue", "configurationValue")

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

Example Usage: DscConfigurationClient.ListByAutomationAccount

ctx := context.TODO()
id := dscconfiguration.NewAutomationAccountID("12345678-1234-9876-4563-123456789012", "example-resource-group", "automationAccountValue")

// alternatively `client.ListByAutomationAccount(ctx, id, dscconfiguration.DefaultListByAutomationAccountOperationOptions())` can be used to do batched pagination
items, err := client.ListByAutomationAccountComplete(ctx, id, dscconfiguration.DefaultListByAutomationAccountOperationOptions())
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: DscConfigurationClient.Update

ctx := context.TODO()
id := dscconfiguration.NewConfigurationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "automationAccountValue", "configurationValue")

payload := dscconfiguration.DscConfigurationUpdateParameters{
	// ...
}


read, err := client.Update(ctx, id, payload)
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 PossibleValuesForContentSourceType 

func PossibleValuesForContentSourceType() []string

func PossibleValuesForDscConfigurationProvisioningState 

func PossibleValuesForDscConfigurationProvisioningState() []string

func PossibleValuesForDscConfigurationState 

func PossibleValuesForDscConfigurationState() []string

func ValidateAutomationAccountID 

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

ValidateAutomationAccountID checks that 'input' can be parsed as a Automation Account ID

func ValidateConfigurationID 

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

ValidateConfigurationID checks that 'input' can be parsed as a Configuration ID

Types

type AutomationAccountId 

type AutomationAccountId struct {
	SubscriptionId        string
	ResourceGroupName     string
	AutomationAccountName string
}

AutomationAccountId is a struct representing the Resource ID for a Automation Account

func NewAutomationAccountID 

func NewAutomationAccountID(subscriptionId string, resourceGroupName string, automationAccountName string) AutomationAccountId

NewAutomationAccountID returns a new AutomationAccountId struct

func ParseAutomationAccountID 

func ParseAutomationAccountID(input string) (*AutomationAccountId, error)

ParseAutomationAccountID parses 'input' into a AutomationAccountId

func ParseAutomationAccountIDInsensitively 

func ParseAutomationAccountIDInsensitively(input string) (*AutomationAccountId, error)

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

func (AutomationAccountId) ID 

func (id AutomationAccountId) ID() string

ID returns the formatted Automation Account ID

func (AutomationAccountId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Automation Account ID

func (AutomationAccountId) String 

func (id AutomationAccountId) String() string

String returns a human-readable description of this Automation Account ID

type ConfigurationId 

type ConfigurationId struct {
	SubscriptionId        string
	ResourceGroupName     string
	AutomationAccountName string
	ConfigurationName     string
}

ConfigurationId is a struct representing the Resource ID for a Configuration

func NewConfigurationID 

func NewConfigurationID(subscriptionId string, resourceGroupName string, automationAccountName string, configurationName string) ConfigurationId

NewConfigurationID returns a new ConfigurationId struct

func ParseConfigurationID 

func ParseConfigurationID(input string) (*ConfigurationId, error)

ParseConfigurationID parses 'input' into a ConfigurationId

func ParseConfigurationIDInsensitively 

func ParseConfigurationIDInsensitively(input string) (*ConfigurationId, error)

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

func (ConfigurationId) ID 

func (id ConfigurationId) ID() string

ID returns the formatted Configuration ID

func (ConfigurationId) Segments 

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

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

func (ConfigurationId) String 

func (id ConfigurationId) String() string

String returns a human-readable description of this Configuration ID

type ContentHash 

type ContentHash struct {
	Algorithm string `json:"algorithm"`
	Value     string `json:"value"`
}

type ContentSource 

type ContentSource struct {
	Hash    *ContentHash       `json:"hash,omitempty"`
	Type    *ContentSourceType `json:"type,omitempty"`
	Value   *string            `json:"value,omitempty"`
	Version *string            `json:"version,omitempty"`
}

type ContentSourceType 

type ContentSourceType string
const (
	ContentSourceTypeEmbeddedContent ContentSourceType = "embeddedContent"
	ContentSourceTypeUri             ContentSourceType = "uri"
)

func (*ContentSourceType) UnmarshalJSON 

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

type CreateOrUpdateOperationResponse 

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

type DeleteOperationResponse 

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

type DscConfiguration 

type DscConfiguration struct {
	Etag       *string                     `json:"etag,omitempty"`
	Id         *string                     `json:"id,omitempty"`
	Location   *string                     `json:"location,omitempty"`
	Name       *string                     `json:"name,omitempty"`
	Properties *DscConfigurationProperties `json:"properties,omitempty"`
	Tags       *map[string]string          `json:"tags,omitempty"`
	Type       *string                     `json:"type,omitempty"`
}

type DscConfigurationClient 

type DscConfigurationClient struct {
	Client *resourcemanager.Client
}

func NewDscConfigurationClientWithBaseURI 

func NewDscConfigurationClientWithBaseURI(sdkApi sdkEnv.Api) (*DscConfigurationClient, error)

func (DscConfigurationClient) CreateOrUpdate 

func (c DscConfigurationClient) CreateOrUpdate(ctx context.Context, id ConfigurationId, input DscConfigurationCreateOrUpdateParameters) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (DscConfigurationClient) Delete 

func (c DscConfigurationClient) Delete(ctx context.Context, id ConfigurationId) (result DeleteOperationResponse, err error)

Delete ...

func (DscConfigurationClient) Get 

func (c DscConfigurationClient) Get(ctx context.Context, id ConfigurationId) (result GetOperationResponse, err error)

Get ...

func (DscConfigurationClient) GetContent 

func (c DscConfigurationClient) GetContent(ctx context.Context, id ConfigurationId) (result GetContentOperationResponse, err error)

GetContent ...

func (DscConfigurationClient) ListByAutomationAccount 

func (c DscConfigurationClient) ListByAutomationAccount(ctx context.Context, id AutomationAccountId, options ListByAutomationAccountOperationOptions) (result ListByAutomationAccountOperationResponse, err error)

ListByAutomationAccount ...

func (DscConfigurationClient) ListByAutomationAccountComplete 

func (c DscConfigurationClient) ListByAutomationAccountComplete(ctx context.Context, id AutomationAccountId, options ListByAutomationAccountOperationOptions) (ListByAutomationAccountCompleteResult, error)

ListByAutomationAccountComplete retrieves all the results into a single object

func (DscConfigurationClient) ListByAutomationAccountCompleteMatchingPredicate 

func (c DscConfigurationClient) ListByAutomationAccountCompleteMatchingPredicate(ctx context.Context, id AutomationAccountId, options ListByAutomationAccountOperationOptions, predicate DscConfigurationOperationPredicate) (result ListByAutomationAccountCompleteResult, err error)

ListByAutomationAccountCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (DscConfigurationClient) Update 

func (c DscConfigurationClient) Update(ctx context.Context, id ConfigurationId, input DscConfigurationUpdateParameters) (result UpdateOperationResponse, err error)

Update ...

type DscConfigurationCreateOrUpdateParameters 

type DscConfigurationCreateOrUpdateParameters struct {
	Location   *string                                  `json:"location,omitempty"`
	Name       *string                                  `json:"name,omitempty"`
	Properties DscConfigurationCreateOrUpdateProperties `json:"properties"`
	Tags       *map[string]string                       `json:"tags,omitempty"`
}

type DscConfigurationCreateOrUpdateProperties 

type DscConfigurationCreateOrUpdateProperties struct {
	Description *string                               `json:"description,omitempty"`
	LogProgress *bool                                 `json:"logProgress,omitempty"`
	LogVerbose  *bool                                 `json:"logVerbose,omitempty"`
	Parameters  *map[string]DscConfigurationParameter `json:"parameters,omitempty"`
	Source      ContentSource                         `json:"source"`
}

type DscConfigurationOperationPredicate 

type DscConfigurationOperationPredicate struct {
	Etag     *string
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (DscConfigurationOperationPredicate) Matches 

func (p DscConfigurationOperationPredicate) Matches(input DscConfiguration) bool

type DscConfigurationParameter 

type DscConfigurationParameter struct {
	DefaultValue *string `json:"defaultValue,omitempty"`
	IsMandatory  *bool   `json:"isMandatory,omitempty"`
	Position     *int64  `json:"position,omitempty"`
	Type         *string `json:"type,omitempty"`
}

type DscConfigurationProperties 

type DscConfigurationProperties struct {
	CreationTime           *string                               `json:"creationTime,omitempty"`
	Description            *string                               `json:"description,omitempty"`
	JobCount               *int64                                `json:"jobCount,omitempty"`
	LastModifiedTime       *string                               `json:"lastModifiedTime,omitempty"`
	LogVerbose             *bool                                 `json:"logVerbose,omitempty"`
	NodeConfigurationCount *int64                                `json:"nodeConfigurationCount,omitempty"`
	Parameters             *map[string]DscConfigurationParameter `json:"parameters,omitempty"`
	ProvisioningState      *DscConfigurationProvisioningState    `json:"provisioningState,omitempty"`
	Source                 *ContentSource                        `json:"source,omitempty"`
	State                  *DscConfigurationState                `json:"state,omitempty"`
}

func (*DscConfigurationProperties) GetCreationTimeAsTime 

func (o *DscConfigurationProperties) GetCreationTimeAsTime() (*time.Time, error)

func (*DscConfigurationProperties) GetLastModifiedTimeAsTime 

func (o *DscConfigurationProperties) GetLastModifiedTimeAsTime() (*time.Time, error)

func (*DscConfigurationProperties) SetCreationTimeAsTime 

func (o *DscConfigurationProperties) SetCreationTimeAsTime(input time.Time)

func (*DscConfigurationProperties) SetLastModifiedTimeAsTime 

func (o *DscConfigurationProperties) SetLastModifiedTimeAsTime(input time.Time)

type DscConfigurationProvisioningState 

type DscConfigurationProvisioningState string
const (
	DscConfigurationProvisioningStateSucceeded DscConfigurationProvisioningState = "Succeeded"
)

func (*DscConfigurationProvisioningState) UnmarshalJSON 

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

type DscConfigurationState 

type DscConfigurationState string
const (
	DscConfigurationStateEdit      DscConfigurationState = "Edit"
	DscConfigurationStateNew       DscConfigurationState = "New"
	DscConfigurationStatePublished DscConfigurationState = "Published"
)

func (*DscConfigurationState) UnmarshalJSON 

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

type DscConfigurationUpdateParameters 

type DscConfigurationUpdateParameters struct {
	Name       *string                                   `json:"name,omitempty"`
	Properties *DscConfigurationCreateOrUpdateProperties `json:"properties,omitempty"`
	Tags       *map[string]string                        `json:"tags,omitempty"`
}

type GetContentOperationResponse 

type GetContentOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]byte
}

type GetOperationResponse 

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

type ListByAutomationAccountCompleteResult 

type ListByAutomationAccountCompleteResult struct {
	Items []DscConfiguration
}

type ListByAutomationAccountOperationOptions 

type ListByAutomationAccountOperationOptions struct {
	Filter      *string
	Inlinecount *string
	Skip        *int64
	Top         *int64
}

func DefaultListByAutomationAccountOperationOptions 

func DefaultListByAutomationAccountOperationOptions() ListByAutomationAccountOperationOptions

func (ListByAutomationAccountOperationOptions) ToHeaders 

func (o ListByAutomationAccountOperationOptions) ToHeaders() *client.Headers

func (ListByAutomationAccountOperationOptions) ToOData 

func (o ListByAutomationAccountOperationOptions) ToOData() *odata.Query

func (ListByAutomationAccountOperationOptions) ToQuery 

func (o ListByAutomationAccountOperationOptions) ToQuery() *client.QueryParams

type ListByAutomationAccountOperationResponse 

type ListByAutomationAccountOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]DscConfiguration
}

type UpdateOperationResponse 

type UpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *DscConfiguration
}

Source Files

View all Source files

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.