dscnodeconfiguration

package
v0.20240320.1144505 Latest Latest
Warning

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

 Go to latest Published: Mar 20, 2024 License: MPL-2.0 Imports: 13 Imported by: 0

README

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

The dscnodeconfiguration 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/dscnodeconfiguration"

Client Initialization

client := dscnodeconfiguration.NewDscNodeConfigurationClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: DscNodeConfigurationClient.CreateOrUpdate

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

payload := dscnodeconfiguration.DscNodeConfigurationCreateOrUpdateParameters{
	// ...
}


if err := client.CreateOrUpdateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: DscNodeConfigurationClient.Delete

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

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

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

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: DscNodeConfigurationClient.ListByAutomationAccount

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

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForContentSourceType 

func PossibleValuesForContentSourceType() []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 ValidateNodeConfigurationID 

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

ValidateNodeConfigurationID checks that 'input' can be parsed as a Node 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) FromParseResult 

func (id *AutomationAccountId) FromParseResult(input resourceids.ParseResult) error

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 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 {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *DscNodeConfiguration
}

type DeleteOperationResponse 

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

type DscConfigurationAssociationProperty 

type DscConfigurationAssociationProperty struct {
	Name *string `json:"name,omitempty"`
}

type DscNodeConfiguration 

type DscNodeConfiguration struct {
	Id         *string                         `json:"id,omitempty"`
	Name       *string                         `json:"name,omitempty"`
	Properties *DscNodeConfigurationProperties `json:"properties,omitempty"`
	Type       *string                         `json:"type,omitempty"`
}

type DscNodeConfigurationClient 

type DscNodeConfigurationClient struct {
	Client *resourcemanager.Client
}

func NewDscNodeConfigurationClientWithBaseURI 

func NewDscNodeConfigurationClientWithBaseURI(sdkApi sdkEnv.Api) (*DscNodeConfigurationClient, error)

func (DscNodeConfigurationClient) CreateOrUpdate 

func (c DscNodeConfigurationClient) CreateOrUpdate(ctx context.Context, id NodeConfigurationId, input DscNodeConfigurationCreateOrUpdateParameters) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (DscNodeConfigurationClient) CreateOrUpdateThenPoll 

func (c DscNodeConfigurationClient) CreateOrUpdateThenPoll(ctx context.Context, id NodeConfigurationId, input DscNodeConfigurationCreateOrUpdateParameters) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (DscNodeConfigurationClient) Delete 

func (c DscNodeConfigurationClient) Delete(ctx context.Context, id NodeConfigurationId) (result DeleteOperationResponse, err error)

Delete ...

func (DscNodeConfigurationClient) Get 

func (c DscNodeConfigurationClient) Get(ctx context.Context, id NodeConfigurationId) (result GetOperationResponse, err error)

Get ...

func (DscNodeConfigurationClient) ListByAutomationAccount 

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

ListByAutomationAccount ...

func (DscNodeConfigurationClient) ListByAutomationAccountComplete 

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

ListByAutomationAccountComplete retrieves all the results into a single object

func (DscNodeConfigurationClient) ListByAutomationAccountCompleteMatchingPredicate 

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

ListByAutomationAccountCompleteMatchingPredicate retrieves all the results and then applies the predicate

type DscNodeConfigurationCreateOrUpdateParameters 

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

type DscNodeConfigurationCreateOrUpdateParametersProperties 

type DscNodeConfigurationCreateOrUpdateParametersProperties struct {
	Configuration                   DscConfigurationAssociationProperty `json:"configuration"`
	IncrementNodeConfigurationBuild *bool                               `json:"incrementNodeConfigurationBuild,omitempty"`
	Source                          ContentSource                       `json:"source"`
}

type DscNodeConfigurationOperationPredicate 

type DscNodeConfigurationOperationPredicate struct {
	Id   *string
	Name *string
	Type *string
}

func (DscNodeConfigurationOperationPredicate) Matches 

func (p DscNodeConfigurationOperationPredicate) Matches(input DscNodeConfiguration) bool

type DscNodeConfigurationProperties 

type DscNodeConfigurationProperties struct {
	Configuration                   *DscConfigurationAssociationProperty `json:"configuration,omitempty"`
	CreationTime                    *string                              `json:"creationTime,omitempty"`
	IncrementNodeConfigurationBuild *bool                                `json:"incrementNodeConfigurationBuild,omitempty"`
	LastModifiedTime                *string                              `json:"lastModifiedTime,omitempty"`
	NodeCount                       *int64                               `json:"nodeCount,omitempty"`
	Source                          *string                              `json:"source,omitempty"`
}

func (*DscNodeConfigurationProperties) GetCreationTimeAsTime 

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

func (*DscNodeConfigurationProperties) GetLastModifiedTimeAsTime 

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

func (*DscNodeConfigurationProperties) SetCreationTimeAsTime 

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

func (*DscNodeConfigurationProperties) SetLastModifiedTimeAsTime 

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

type GetOperationResponse 

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

type ListByAutomationAccountCompleteResult 

type ListByAutomationAccountCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []DscNodeConfiguration
}

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        *[]DscNodeConfiguration
}

type NodeConfigurationId 

type NodeConfigurationId struct {
	SubscriptionId        string
	ResourceGroupName     string
	AutomationAccountName string
	NodeConfigurationName string
}

NodeConfigurationId is a struct representing the Resource ID for a Node Configuration

func NewNodeConfigurationID 

func NewNodeConfigurationID(subscriptionId string, resourceGroupName string, automationAccountName string, nodeConfigurationName string) NodeConfigurationId

NewNodeConfigurationID returns a new NodeConfigurationId struct

func ParseNodeConfigurationID 

func ParseNodeConfigurationID(input string) (*NodeConfigurationId, error)

ParseNodeConfigurationID parses 'input' into a NodeConfigurationId

func ParseNodeConfigurationIDInsensitively 

func ParseNodeConfigurationIDInsensitively(input string) (*NodeConfigurationId, error)

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

func (*NodeConfigurationId) FromParseResult 

func (id *NodeConfigurationId) FromParseResult(input resourceids.ParseResult) error

func (NodeConfigurationId) ID 

func (id NodeConfigurationId) ID() string

ID returns the formatted Node Configuration ID

func (NodeConfigurationId) Segments 

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

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

func (NodeConfigurationId) String 

func (id NodeConfigurationId) String() string

String returns a human-readable description of this Node Configuration ID

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.