dscnode

package
v0.20240321.1111417 Latest Latest
Warning

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

 Go to latest Published: Mar 21, 2024 License: MPL-2.0 Imports: 11 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/automation/2020-01-13-preview/dscnode Documentation

The dscnode SDK allows for interaction with the Azure Resource Manager Service automation (API Version 2020-01-13-preview).

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/2020-01-13-preview/dscnode"

Client Initialization

client := dscnode.NewDscNodeClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: DscNodeClient.Delete

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

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

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

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

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

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

Example Usage: DscNodeClient.Update

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

payload := dscnode.DscNodeUpdateParameters{
	// ...
}


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 ValidateAutomationAccountID 

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

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

func ValidateNodeID 

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

ValidateNodeID checks that 'input' can be parsed as a Node 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 DeleteOperationResponse 

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

type DscNode 

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

type DscNodeClient 

type DscNodeClient struct {
	Client *resourcemanager.Client
}

func NewDscNodeClientWithBaseURI 

func NewDscNodeClientWithBaseURI(sdkApi sdkEnv.Api) (*DscNodeClient, error)

func (DscNodeClient) Delete 

func (c DscNodeClient) Delete(ctx context.Context, id NodeId) (result DeleteOperationResponse, err error)

Delete ...

func (DscNodeClient) Get 

func (c DscNodeClient) Get(ctx context.Context, id NodeId) (result GetOperationResponse, err error)

Get ...

func (DscNodeClient) ListByAutomationAccount 

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

ListByAutomationAccount ...

func (DscNodeClient) ListByAutomationAccountComplete 

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

ListByAutomationAccountComplete retrieves all the results into a single object

func (DscNodeClient) ListByAutomationAccountCompleteMatchingPredicate 

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

ListByAutomationAccountCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (DscNodeClient) Update 

func (c DscNodeClient) Update(ctx context.Context, id NodeId, input DscNodeUpdateParameters) (result UpdateOperationResponse, err error)

Update ...

type DscNodeConfigurationAssociationProperty 

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

type DscNodeExtensionHandlerAssociationProperty 

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

type DscNodeOperationPredicate 

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

func (DscNodeOperationPredicate) Matches 

func (p DscNodeOperationPredicate) Matches(input DscNode) bool

type DscNodeProperties 

type DscNodeProperties struct {
	AccountId         *string                                       `json:"accountId,omitempty"`
	Etag              *string                                       `json:"etag,omitempty"`
	ExtensionHandler  *[]DscNodeExtensionHandlerAssociationProperty `json:"extensionHandler,omitempty"`
	IP                *string                                       `json:"ip,omitempty"`
	LastSeen          *string                                       `json:"lastSeen,omitempty"`
	NodeConfiguration *DscNodeConfigurationAssociationProperty      `json:"nodeConfiguration,omitempty"`
	NodeId            *string                                       `json:"nodeId,omitempty"`
	RegistrationTime  *string                                       `json:"registrationTime,omitempty"`
	Status            *string                                       `json:"status,omitempty"`
	TotalCount        *int64                                        `json:"totalCount,omitempty"`
}

func (*DscNodeProperties) GetLastSeenAsTime 

func (o *DscNodeProperties) GetLastSeenAsTime() (*time.Time, error)

func (*DscNodeProperties) GetRegistrationTimeAsTime 

func (o *DscNodeProperties) GetRegistrationTimeAsTime() (*time.Time, error)

func (*DscNodeProperties) SetLastSeenAsTime 

func (o *DscNodeProperties) SetLastSeenAsTime(input time.Time)

func (*DscNodeProperties) SetRegistrationTimeAsTime 

func (o *DscNodeProperties) SetRegistrationTimeAsTime(input time.Time)

type DscNodeUpdateParameters 

type DscNodeUpdateParameters struct {
	NodeId     *string                            `json:"nodeId,omitempty"`
	Properties *DscNodeUpdateParametersProperties `json:"properties,omitempty"`
}

type DscNodeUpdateParametersProperties 

type DscNodeUpdateParametersProperties struct {
	NodeConfiguration *DscNodeConfigurationAssociationProperty `json:"nodeConfiguration,omitempty"`
}

type GetOperationResponse 

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

type ListByAutomationAccountCompleteResult 

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

type ListByAutomationAccountOperationOptions 

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

func DefaultListByAutomationAccountOperationOptions 

func DefaultListByAutomationAccountOperationOptions() ListByAutomationAccountOperationOptions

func (ListByAutomationAccountOperationOptions) ToHeaders added in v0.20240209.1164150 

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

func (ListByAutomationAccountOperationOptions) ToOData added in v0.20240209.1164150 

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

func (ListByAutomationAccountOperationOptions) ToQuery added in v0.20240209.1164150 

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

type ListByAutomationAccountOperationResponse 

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

type NodeId 

type NodeId struct {
	SubscriptionId        string
	ResourceGroupName     string
	AutomationAccountName string
	NodeId                string
}

NodeId is a struct representing the Resource ID for a Node

func NewNodeID 

func NewNodeID(subscriptionId string, resourceGroupName string, automationAccountName string, nodeId string) NodeId

NewNodeID returns a new NodeId struct

func ParseNodeID 

func ParseNodeID(input string) (*NodeId, error)

ParseNodeID parses 'input' into a NodeId

func ParseNodeIDInsensitively 

func ParseNodeIDInsensitively(input string) (*NodeId, error)

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

func (*NodeId) FromParseResult 

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

func (NodeId) ID 

func (id NodeId) ID() string

ID returns the formatted Node ID

func (NodeId) Segments 

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

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

func (NodeId) String 

func (id NodeId) String() string

String returns a human-readable description of this Node ID

type UpdateOperationResponse 

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

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.