nodes

README

github.com/hashicorp/go-azure-sdk/resource-manager/databoxedge/2023-07-01/nodes Documentation

The nodes SDK allows for interaction with the Azure Resource Manager Service databoxedge (API Version 2023-07-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/databoxedge/2023-07-01/nodes"

Client Initialization

client := nodes.NewNodesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: NodesClient.ListByDataBoxEdgeDevice

ctx := context.TODO()
id := nodes.NewDataBoxEdgeDeviceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "dataBoxEdgeDeviceValue")

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

Documentation

Index

• func PossibleValuesForNodeStatus() []string
• func ValidateDataBoxEdgeDeviceID(input interface{}, key string) (warnings []string, errors []error)
• type DataBoxEdgeDeviceId
  • func NewDataBoxEdgeDeviceID(subscriptionId string, resourceGroupName string, dataBoxEdgeDeviceName string) DataBoxEdgeDeviceId
  • func ParseDataBoxEdgeDeviceID(input string) (*DataBoxEdgeDeviceId, error)
  • func ParseDataBoxEdgeDeviceIDInsensitively(input string) (*DataBoxEdgeDeviceId, error)
  • func (id DataBoxEdgeDeviceId) ID() string
  • func (id DataBoxEdgeDeviceId) Segments() []resourceids.Segment
  • func (id DataBoxEdgeDeviceId) String() string
• type ListByDataBoxEdgeDeviceCompleteResult
• type ListByDataBoxEdgeDeviceOperationResponse
• type Node
• type NodeOperationPredicate
  • func (p NodeOperationPredicate) Matches(input Node) bool
• type NodeProperties
• type NodeStatus
  • func (s *NodeStatus) UnmarshalJSON(bytes []byte) error
• type NodesClient
  • func NewNodesClientWithBaseURI(sdkApi sdkEnv.Api) (*NodesClient, error)
  • func (c NodesClient) ListByDataBoxEdgeDevice(ctx context.Context, id DataBoxEdgeDeviceId) (result ListByDataBoxEdgeDeviceOperationResponse, err error)
  • func (c NodesClient) ListByDataBoxEdgeDeviceComplete(ctx context.Context, id DataBoxEdgeDeviceId) (ListByDataBoxEdgeDeviceCompleteResult, error)
  • func (c NodesClient) ListByDataBoxEdgeDeviceCompleteMatchingPredicate(ctx context.Context, id DataBoxEdgeDeviceId, predicate NodeOperationPredicate) (result ListByDataBoxEdgeDeviceCompleteResult, err error)

Functions

func PossibleValuesForNodeStatus

func PossibleValuesForNodeStatus() []string

func ValidateDataBoxEdgeDeviceID

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

ValidateDataBoxEdgeDeviceID checks that 'input' can be parsed as a Data Box Edge Device ID

Types

type DataBoxEdgeDeviceId

type DataBoxEdgeDeviceId struct {
	SubscriptionId        string
	ResourceGroupName     string
	DataBoxEdgeDeviceName string
}

DataBoxEdgeDeviceId is a struct representing the Resource ID for a Data Box Edge Device

func NewDataBoxEdgeDeviceID

func NewDataBoxEdgeDeviceID(subscriptionId string, resourceGroupName string, dataBoxEdgeDeviceName string) DataBoxEdgeDeviceId

NewDataBoxEdgeDeviceID returns a new DataBoxEdgeDeviceId struct

func ParseDataBoxEdgeDeviceID

func ParseDataBoxEdgeDeviceID(input string) (*DataBoxEdgeDeviceId, error)

ParseDataBoxEdgeDeviceID parses 'input' into a DataBoxEdgeDeviceId

func ParseDataBoxEdgeDeviceIDInsensitively

func ParseDataBoxEdgeDeviceIDInsensitively(input string) (*DataBoxEdgeDeviceId, error)

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

func (DataBoxEdgeDeviceId) ID

func (id DataBoxEdgeDeviceId) ID() string

ID returns the formatted Data Box Edge Device ID

func (DataBoxEdgeDeviceId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Data Box Edge Device ID

func (DataBoxEdgeDeviceId) String

func (id DataBoxEdgeDeviceId) String() string

String returns a human-readable description of this Data Box Edge Device ID

type ListByDataBoxEdgeDeviceCompleteResult

type ListByDataBoxEdgeDeviceCompleteResult struct {
	Items []Node
}

type ListByDataBoxEdgeDeviceOperationResponse

type ListByDataBoxEdgeDeviceOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]Node
}

type Node

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

type NodeOperationPredicate

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

func (NodeOperationPredicate) Matches

func (p NodeOperationPredicate) Matches(input Node) bool

type NodeProperties

type NodeProperties struct {
	NodeChassisSerialNumber     *string     `json:"nodeChassisSerialNumber,omitempty"`
	NodeDisplayName             *string     `json:"nodeDisplayName,omitempty"`
	NodeFriendlySoftwareVersion *string     `json:"nodeFriendlySoftwareVersion,omitempty"`
	NodeHcsVersion              *string     `json:"nodeHcsVersion,omitempty"`
	NodeInstanceId              *string     `json:"nodeInstanceId,omitempty"`
	NodeSerialNumber            *string     `json:"nodeSerialNumber,omitempty"`
	NodeStatus                  *NodeStatus `json:"nodeStatus,omitempty"`
}

type NodeStatus

type NodeStatus string

const (
	NodeStatusDown         NodeStatus = "Down"
	NodeStatusRebooting    NodeStatus = "Rebooting"
	NodeStatusShuttingDown NodeStatus = "ShuttingDown"
	NodeStatusUnknown      NodeStatus = "Unknown"
	NodeStatusUp           NodeStatus = "Up"
)

func (*NodeStatus) UnmarshalJSON

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

type NodesClient

type NodesClient struct {
	Client *resourcemanager.Client
}

func NewNodesClientWithBaseURI

func NewNodesClientWithBaseURI(sdkApi sdkEnv.Api) (*NodesClient, error)

func (NodesClient) ListByDataBoxEdgeDevice

func (c NodesClient) ListByDataBoxEdgeDevice(ctx context.Context, id DataBoxEdgeDeviceId) (result ListByDataBoxEdgeDeviceOperationResponse, err error)

ListByDataBoxEdgeDevice ...

func (NodesClient) ListByDataBoxEdgeDeviceComplete

func (c NodesClient) ListByDataBoxEdgeDeviceComplete(ctx context.Context, id DataBoxEdgeDeviceId) (ListByDataBoxEdgeDeviceCompleteResult, error)

ListByDataBoxEdgeDeviceComplete retrieves all the results into a single object

func (NodesClient) ListByDataBoxEdgeDeviceCompleteMatchingPredicate

func (c NodesClient) ListByDataBoxEdgeDeviceCompleteMatchingPredicate(ctx context.Context, id DataBoxEdgeDeviceId, predicate NodeOperationPredicate) (result ListByDataBoxEdgeDeviceCompleteResult, err error)

ListByDataBoxEdgeDeviceCompleteMatchingPredicate retrieves all the results and then applies the predicate