devicecapacitycheck

README

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

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

Client Initialization

client := devicecapacitycheck.NewDeviceCapacityCheckClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: DeviceCapacityCheckClient.CheckResourceCreationFeasibility

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

payload := devicecapacitycheck.DeviceCapacityRequestInfo{
	// ...
}


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

Documentation

Index

• func ValidateDataBoxEdgeDeviceID(input interface{}, key string) (warnings []string, errors []error)
• type CheckResourceCreationFeasibilityOperationOptions
  • func DefaultCheckResourceCreationFeasibilityOperationOptions() CheckResourceCreationFeasibilityOperationOptions
  • func (o CheckResourceCreationFeasibilityOperationOptions) ToHeaders() *client.Headers
  • func (o CheckResourceCreationFeasibilityOperationOptions) ToOData() *odata.Query
  • func (o CheckResourceCreationFeasibilityOperationOptions) ToQuery() *client.QueryParams
• type CheckResourceCreationFeasibilityOperationResponse
• 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) FromParseResult(input resourceids.ParseResult) error
  • func (id DataBoxEdgeDeviceId) ID() string
  • func (id DataBoxEdgeDeviceId) Segments() []resourceids.Segment
  • func (id DataBoxEdgeDeviceId) String() string
• type DeviceCapacityCheckClient
  • func NewDeviceCapacityCheckClientWithBaseURI(sdkApi sdkEnv.Api) (*DeviceCapacityCheckClient, error)
  • func (c DeviceCapacityCheckClient) CheckResourceCreationFeasibility(ctx context.Context, id DataBoxEdgeDeviceId, input DeviceCapacityRequestInfo, ...) (result CheckResourceCreationFeasibilityOperationResponse, err error)
  • func (c DeviceCapacityCheckClient) CheckResourceCreationFeasibilityThenPoll(ctx context.Context, id DataBoxEdgeDeviceId, input DeviceCapacityRequestInfo, ...) error
• type DeviceCapacityRequestInfo
• type DeviceCapacityRequestInfoProperties
• type VMPlacementRequestResult

Functions

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 CheckResourceCreationFeasibilityOperationOptions

type CheckResourceCreationFeasibilityOperationOptions struct {
	CapacityName *string
}

func DefaultCheckResourceCreationFeasibilityOperationOptions

func DefaultCheckResourceCreationFeasibilityOperationOptions() CheckResourceCreationFeasibilityOperationOptions

func (CheckResourceCreationFeasibilityOperationOptions) ToHeaders

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

func (CheckResourceCreationFeasibilityOperationOptions) ToOData

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

func (CheckResourceCreationFeasibilityOperationOptions) ToQuery

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

type CheckResourceCreationFeasibilityOperationResponse

type CheckResourceCreationFeasibilityOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

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) FromParseResult

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

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 DeviceCapacityCheckClient

type DeviceCapacityCheckClient struct {
	Client *resourcemanager.Client
}

func NewDeviceCapacityCheckClientWithBaseURI

func NewDeviceCapacityCheckClientWithBaseURI(sdkApi sdkEnv.Api) (*DeviceCapacityCheckClient, error)

func (DeviceCapacityCheckClient) CheckResourceCreationFeasibility

func (c DeviceCapacityCheckClient) CheckResourceCreationFeasibility(ctx context.Context, id DataBoxEdgeDeviceId, input DeviceCapacityRequestInfo, options CheckResourceCreationFeasibilityOperationOptions) (result CheckResourceCreationFeasibilityOperationResponse, err error)

CheckResourceCreationFeasibility ...

func (DeviceCapacityCheckClient) CheckResourceCreationFeasibilityThenPoll

func (c DeviceCapacityCheckClient) CheckResourceCreationFeasibilityThenPoll(ctx context.Context, id DataBoxEdgeDeviceId, input DeviceCapacityRequestInfo, options CheckResourceCreationFeasibilityOperationOptions) error

CheckResourceCreationFeasibilityThenPoll performs CheckResourceCreationFeasibility then polls until it's completed

type DeviceCapacityRequestInfo

type DeviceCapacityRequestInfo struct {
	Properties DeviceCapacityRequestInfoProperties `json:"properties"`
}

type DeviceCapacityRequestInfoProperties

type DeviceCapacityRequestInfoProperties struct {
	VMPlacementQuery   [][]string                  `json:"vmPlacementQuery"`
	VMPlacementResults *[]VMPlacementRequestResult `json:"vmPlacementResults,omitempty"`
}

type VMPlacementRequestResult

type VMPlacementRequestResult struct {
	IsFeasible  *bool     `json:"isFeasible,omitempty"`
	Message     *string   `json:"message,omitempty"`
	MessageCode *string   `json:"messageCode,omitempty"`
	VMSize      *[]string `json:"vmSize,omitempty"`
}