virtualapplianceskus

README

github.com/hashicorp/go-azure-sdk/resource-manager/network/2023-04-01/virtualapplianceskus Documentation

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

Client Initialization

client := virtualapplianceskus.NewVirtualApplianceSkusClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: VirtualApplianceSkusClient.Get

ctx := context.TODO()
id := virtualapplianceskus.NewNetworkVirtualApplianceSkuID("12345678-1234-9876-4563-123456789012", "networkVirtualApplianceSkuValue")

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: VirtualApplianceSkusClient.List

ctx := context.TODO()
id := virtualapplianceskus.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

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

Documentation

Index

• func ValidateNetworkVirtualApplianceSkuID(input interface{}, key string) (warnings []string, errors []error)
• type GetOperationResponse
• type ListCompleteResult
• type ListOperationResponse
• type NetworkVirtualApplianceSku
• type NetworkVirtualApplianceSkuId
  • func NewNetworkVirtualApplianceSkuID(subscriptionId string, networkVirtualApplianceSkuName string) NetworkVirtualApplianceSkuId
  • func ParseNetworkVirtualApplianceSkuID(input string) (*NetworkVirtualApplianceSkuId, error)
  • func ParseNetworkVirtualApplianceSkuIDInsensitively(input string) (*NetworkVirtualApplianceSkuId, error)
  • func (id NetworkVirtualApplianceSkuId) ID() string
  • func (id NetworkVirtualApplianceSkuId) Segments() []resourceids.Segment
  • func (id NetworkVirtualApplianceSkuId) String() string
• type NetworkVirtualApplianceSkuInstances
• type NetworkVirtualApplianceSkuOperationPredicate
  • func (p NetworkVirtualApplianceSkuOperationPredicate) Matches(input NetworkVirtualApplianceSku) bool
• type NetworkVirtualApplianceSkuPropertiesFormat
• type VirtualApplianceSkusClient
  • func NewVirtualApplianceSkusClientWithBaseURI(sdkApi sdkEnv.Api) (*VirtualApplianceSkusClient, error)
  • func (c VirtualApplianceSkusClient) Get(ctx context.Context, id NetworkVirtualApplianceSkuId) (result GetOperationResponse, err error)
  • func (c VirtualApplianceSkusClient) List(ctx context.Context, id commonids.SubscriptionId) (result ListOperationResponse, err error)
  • func (c VirtualApplianceSkusClient) ListComplete(ctx context.Context, id commonids.SubscriptionId) (ListCompleteResult, error)
  • func (c VirtualApplianceSkusClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, ...) (result ListCompleteResult, err error)

Functions

func ValidateNetworkVirtualApplianceSkuID

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

ValidateNetworkVirtualApplianceSkuID checks that 'input' can be parsed as a Network Virtual Appliance Sku ID

Types

type GetOperationResponse

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

type ListCompleteResult

type ListCompleteResult struct {
	Items []NetworkVirtualApplianceSku
}

type ListOperationResponse

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]NetworkVirtualApplianceSku
}

type NetworkVirtualApplianceSku

type NetworkVirtualApplianceSku struct {
	Etag       *string                                     `json:"etag,omitempty"`
	Id         *string                                     `json:"id,omitempty"`
	Location   *string                                     `json:"location,omitempty"`
	Name       *string                                     `json:"name,omitempty"`
	Properties *NetworkVirtualApplianceSkuPropertiesFormat `json:"properties,omitempty"`
	Tags       *map[string]string                          `json:"tags,omitempty"`
	Type       *string                                     `json:"type,omitempty"`
}

type NetworkVirtualApplianceSkuId

type NetworkVirtualApplianceSkuId struct {
	SubscriptionId                 string
	NetworkVirtualApplianceSkuName string
}

NetworkVirtualApplianceSkuId is a struct representing the Resource ID for a Network Virtual Appliance Sku

func NewNetworkVirtualApplianceSkuID

func NewNetworkVirtualApplianceSkuID(subscriptionId string, networkVirtualApplianceSkuName string) NetworkVirtualApplianceSkuId

NewNetworkVirtualApplianceSkuID returns a new NetworkVirtualApplianceSkuId struct

func ParseNetworkVirtualApplianceSkuID

func ParseNetworkVirtualApplianceSkuID(input string) (*NetworkVirtualApplianceSkuId, error)

ParseNetworkVirtualApplianceSkuID parses 'input' into a NetworkVirtualApplianceSkuId

func ParseNetworkVirtualApplianceSkuIDInsensitively

func ParseNetworkVirtualApplianceSkuIDInsensitively(input string) (*NetworkVirtualApplianceSkuId, error)

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

func (NetworkVirtualApplianceSkuId) ID

func (id NetworkVirtualApplianceSkuId) ID() string

ID returns the formatted Network Virtual Appliance Sku ID

func (NetworkVirtualApplianceSkuId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Network Virtual Appliance Sku ID

func (NetworkVirtualApplianceSkuId) String

func (id NetworkVirtualApplianceSkuId) String() string

String returns a human-readable description of this Network Virtual Appliance Sku ID

type NetworkVirtualApplianceSkuInstances

type NetworkVirtualApplianceSkuInstances struct {
	InstanceCount *int64  `json:"instanceCount,omitempty"`
	ScaleUnit     *string `json:"scaleUnit,omitempty"`
}

type NetworkVirtualApplianceSkuOperationPredicate

type NetworkVirtualApplianceSkuOperationPredicate struct {
	Etag     *string
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (NetworkVirtualApplianceSkuOperationPredicate) Matches

func (p NetworkVirtualApplianceSkuOperationPredicate) Matches(input NetworkVirtualApplianceSku) bool

type NetworkVirtualApplianceSkuPropertiesFormat

type NetworkVirtualApplianceSkuPropertiesFormat struct {
	AvailableScaleUnits *[]NetworkVirtualApplianceSkuInstances `json:"availableScaleUnits,omitempty"`
	AvailableVersions   *[]string                              `json:"availableVersions,omitempty"`
	Vendor              *string                                `json:"vendor,omitempty"`
}

type VirtualApplianceSkusClient

type VirtualApplianceSkusClient struct {
	Client *resourcemanager.Client
}

func NewVirtualApplianceSkusClientWithBaseURI

func NewVirtualApplianceSkusClientWithBaseURI(sdkApi sdkEnv.Api) (*VirtualApplianceSkusClient, error)

func (VirtualApplianceSkusClient) Get

func (c VirtualApplianceSkusClient) Get(ctx context.Context, id NetworkVirtualApplianceSkuId) (result GetOperationResponse, err error)

Get ...

func (VirtualApplianceSkusClient) List

func (c VirtualApplianceSkusClient) List(ctx context.Context, id commonids.SubscriptionId) (result ListOperationResponse, err error)

List ...

func (VirtualApplianceSkusClient) ListComplete

func (c VirtualApplianceSkusClient) ListComplete(ctx context.Context, id commonids.SubscriptionId) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (VirtualApplianceSkusClient) ListCompleteMatchingPredicate

func (c VirtualApplianceSkusClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate NetworkVirtualApplianceSkuOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate