devicecapacityinfo

README

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

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

Client Initialization

client := devicecapacityinfo.NewDeviceCapacityInfoClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: DeviceCapacityInfoClient.GetDeviceCapacityInfo

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

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

Documentation

Index

• func ValidateDataBoxEdgeDeviceID(input interface{}, key string) (warnings []string, errors []error)
• type ClusterCapacityViewData
  • func (o *ClusterCapacityViewData) GetLastRefreshedTimeAsTime() (*time.Time, error)
  • func (o *ClusterCapacityViewData) SetLastRefreshedTimeAsTime(input time.Time)
• type ClusterGpuCapacity
• type ClusterMemoryCapacity
• type ClusterStorageViewData
• 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 DeviceCapacityInfo
• type DeviceCapacityInfoClient
  • func NewDeviceCapacityInfoClientWithBaseURI(sdkApi sdkEnv.Api) (*DeviceCapacityInfoClient, error)
  • func (c DeviceCapacityInfoClient) GetDeviceCapacityInfo(ctx context.Context, id DataBoxEdgeDeviceId) (result GetDeviceCapacityInfoOperationResponse, err error)
• type DeviceCapacityInfoProperties
  • func (o *DeviceCapacityInfoProperties) GetTimeStampAsTime() (*time.Time, error)
  • func (o *DeviceCapacityInfoProperties) SetTimeStampAsTime(input time.Time)
• type GetDeviceCapacityInfoOperationResponse
• type HostCapacity
• type NumaNodeData
• type VMMemory

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 ClusterCapacityViewData

type ClusterCapacityViewData struct {
	Fqdn                        *string                `json:"fqdn,omitempty"`
	GpuCapacity                 *ClusterGpuCapacity    `json:"gpuCapacity,omitempty"`
	LastRefreshedTime           *string                `json:"lastRefreshedTime,omitempty"`
	MemoryCapacity              *ClusterMemoryCapacity `json:"memoryCapacity,omitempty"`
	TotalProvisionedNonHpnCores *int64                 `json:"totalProvisionedNonHpnCores,omitempty"`
}

func (*ClusterCapacityViewData) GetLastRefreshedTimeAsTime

func (o *ClusterCapacityViewData) GetLastRefreshedTimeAsTime() (*time.Time, error)

func (*ClusterCapacityViewData) SetLastRefreshedTimeAsTime

func (o *ClusterCapacityViewData) SetLastRefreshedTimeAsTime(input time.Time)

type ClusterGpuCapacity

type ClusterGpuCapacity struct {
	GpuFreeUnitsCount                *int64  `json:"gpuFreeUnitsCount,omitempty"`
	GpuReservedForFailoverUnitsCount *int64  `json:"gpuReservedForFailoverUnitsCount,omitempty"`
	GpuTotalUnitsCount               *int64  `json:"gpuTotalUnitsCount,omitempty"`
	GpuType                          *string `json:"gpuType,omitempty"`
	GpuUsedUnitsCount                *int64  `json:"gpuUsedUnitsCount,omitempty"`
}

type ClusterMemoryCapacity

type ClusterMemoryCapacity struct {
	ClusterFailoverMemoryMb      *float64 `json:"clusterFailoverMemoryMb,omitempty"`
	ClusterFragmentationMemoryMb *float64 `json:"clusterFragmentationMemoryMb,omitempty"`
	ClusterFreeMemoryMb          *float64 `json:"clusterFreeMemoryMb,omitempty"`
	ClusterHypervReserveMemoryMb *float64 `json:"clusterHypervReserveMemoryMb,omitempty"`
	ClusterInfraVMMemoryMb       *float64 `json:"clusterInfraVmMemoryMb,omitempty"`
	ClusterMemoryUsedByVMsMb     *float64 `json:"clusterMemoryUsedByVmsMb,omitempty"`
	ClusterNonFailoverVMMb       *float64 `json:"clusterNonFailoverVmMb,omitempty"`
	ClusterTotalMemoryMb         *float64 `json:"clusterTotalMemoryMb,omitempty"`
	ClusterUsedMemoryMb          *float64 `json:"clusterUsedMemoryMb,omitempty"`
}

type ClusterStorageViewData

type ClusterStorageViewData struct {
	ClusterFreeStorageMb  *float64 `json:"clusterFreeStorageMb,omitempty"`
	ClusterTotalStorageMb *float64 `json:"clusterTotalStorageMb,omitempty"`
}

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 DeviceCapacityInfo

type DeviceCapacityInfo struct {
	Id         *string                       `json:"id,omitempty"`
	Name       *string                       `json:"name,omitempty"`
	Properties *DeviceCapacityInfoProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData        `json:"systemData,omitempty"`
	Type       *string                       `json:"type,omitempty"`
}

type DeviceCapacityInfoClient

type DeviceCapacityInfoClient struct {
	Client *resourcemanager.Client
}

func NewDeviceCapacityInfoClientWithBaseURI

func NewDeviceCapacityInfoClientWithBaseURI(sdkApi sdkEnv.Api) (*DeviceCapacityInfoClient, error)

func (DeviceCapacityInfoClient) GetDeviceCapacityInfo

func (c DeviceCapacityInfoClient) GetDeviceCapacityInfo(ctx context.Context, id DataBoxEdgeDeviceId) (result GetDeviceCapacityInfoOperationResponse, err error)

GetDeviceCapacityInfo ...

type DeviceCapacityInfoProperties

type DeviceCapacityInfoProperties struct {
	ClusterComputeCapacityInfo *ClusterCapacityViewData `json:"clusterComputeCapacityInfo,omitempty"`
	ClusterStorageCapacityInfo *ClusterStorageViewData  `json:"clusterStorageCapacityInfo,omitempty"`
	NodeCapacityInfos          *map[string]HostCapacity `json:"nodeCapacityInfos,omitempty"`
	TimeStamp                  *string                  `json:"timeStamp,omitempty"`
}

func (*DeviceCapacityInfoProperties) GetTimeStampAsTime

func (o *DeviceCapacityInfoProperties) GetTimeStampAsTime() (*time.Time, error)

func (*DeviceCapacityInfoProperties) SetTimeStampAsTime

func (o *DeviceCapacityInfoProperties) SetTimeStampAsTime(input time.Time)

type GetDeviceCapacityInfoOperationResponse

type GetDeviceCapacityInfoOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *DeviceCapacityInfo
}

type HostCapacity

type HostCapacity struct {
	AvailableGpuCount                *int64               `json:"availableGpuCount,omitempty"`
	EffectiveAvailableMemoryMbOnHost *int64               `json:"effectiveAvailableMemoryMbOnHost,omitempty"`
	GpuType                          *string              `json:"gpuType,omitempty"`
	HostName                         *string              `json:"hostName,omitempty"`
	NumaNodesData                    *[]NumaNodeData      `json:"numaNodesData,omitempty"`
	VMUsedMemory                     *map[string]VMMemory `json:"vmUsedMemory,omitempty"`
}

type NumaNodeData

type NumaNodeData struct {
	EffectiveAvailableMemoryInMb *int64   `json:"effectiveAvailableMemoryInMb,omitempty"`
	FreeVCPUIndexesForHpn        *[]int64 `json:"freeVCpuIndexesForHpn,omitempty"`
	LogicalCoreCountPerCore      *int64   `json:"logicalCoreCountPerCore,omitempty"`
	NumaNodeIndex                *int64   `json:"numaNodeIndex,omitempty"`
	TotalMemoryInMb              *int64   `json:"totalMemoryInMb,omitempty"`
	VCPUIndexesForHpn            *[]int64 `json:"vCpuIndexesForHpn,omitempty"`
	VCPUIndexesForRoot           *[]int64 `json:"vCpuIndexesForRoot,omitempty"`
}

type VMMemory

type VMMemory struct {
	CurrentMemoryUsageMB *int64 `json:"currentMemoryUsageMB,omitempty"`
	StartupMemoryMB      *int64 `json:"startupMemoryMB,omitempty"`
}