virtualappliancesites

package
v0.20240624.1135538 Latest Latest
Warning

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

Go to latest
Published: Jun 24, 2024 License: MPL-2.0 Imports: 12 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/network/2022-07-01/virtualappliancesites Documentation

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

Client Initialization

client := virtualappliancesites.NewVirtualApplianceSitesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: VirtualApplianceSitesClient.CreateOrUpdate

ctx := context.TODO()
id := virtualappliancesites.NewVirtualApplianceSiteID("12345678-1234-9876-4563-123456789012", "example-resource-group", "networkVirtualApplianceValue", "virtualApplianceSiteValue")

payload := virtualappliancesites.VirtualApplianceSite{
	// ...
}


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

Example Usage: VirtualApplianceSitesClient.Delete

ctx := context.TODO()
id := virtualappliancesites.NewVirtualApplianceSiteID("12345678-1234-9876-4563-123456789012", "example-resource-group", "networkVirtualApplianceValue", "virtualApplianceSiteValue")

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

Example Usage: VirtualApplianceSitesClient.Get

ctx := context.TODO()
id := virtualappliancesites.NewVirtualApplianceSiteID("12345678-1234-9876-4563-123456789012", "example-resource-group", "networkVirtualApplianceValue", "virtualApplianceSiteValue")

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

ctx := context.TODO()
id := virtualappliancesites.NewNetworkVirtualApplianceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "networkVirtualApplianceValue")

// 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

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForProvisioningState

func PossibleValuesForProvisioningState() []string

func ValidateNetworkVirtualApplianceID

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

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

func ValidateVirtualApplianceSiteID

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

ValidateVirtualApplianceSiteID checks that 'input' can be parsed as a Virtual Appliance Site ID

Types

type BreakOutCategoryPolicies

type BreakOutCategoryPolicies struct {
	Allow    *bool `json:"allow,omitempty"`
	Default  *bool `json:"default,omitempty"`
	Optimize *bool `json:"optimize,omitempty"`
}

type CreateOrUpdateOperationResponse

type CreateOrUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *VirtualApplianceSite
}

type DeleteOperationResponse

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

type GetOperationResponse

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

type ListCompleteResult

type ListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []VirtualApplianceSite
}

type ListOperationResponse

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

type NetworkVirtualApplianceId

type NetworkVirtualApplianceId struct {
	SubscriptionId              string
	ResourceGroupName           string
	NetworkVirtualApplianceName string
}

NetworkVirtualApplianceId is a struct representing the Resource ID for a Network Virtual Appliance

func NewNetworkVirtualApplianceID

func NewNetworkVirtualApplianceID(subscriptionId string, resourceGroupName string, networkVirtualApplianceName string) NetworkVirtualApplianceId

NewNetworkVirtualApplianceID returns a new NetworkVirtualApplianceId struct

func ParseNetworkVirtualApplianceID

func ParseNetworkVirtualApplianceID(input string) (*NetworkVirtualApplianceId, error)

ParseNetworkVirtualApplianceID parses 'input' into a NetworkVirtualApplianceId

func ParseNetworkVirtualApplianceIDInsensitively

func ParseNetworkVirtualApplianceIDInsensitively(input string) (*NetworkVirtualApplianceId, error)

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

func (*NetworkVirtualApplianceId) FromParseResult

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

func (NetworkVirtualApplianceId) ID

ID returns the formatted Network Virtual Appliance ID

func (NetworkVirtualApplianceId) Segments

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

func (NetworkVirtualApplianceId) String

func (id NetworkVirtualApplianceId) String() string

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

type Office365PolicyProperties

type Office365PolicyProperties struct {
	BreakOutCategories *BreakOutCategoryPolicies `json:"breakOutCategories,omitempty"`
}

type ProvisioningState

type ProvisioningState string
const (
	ProvisioningStateDeleting  ProvisioningState = "Deleting"
	ProvisioningStateFailed    ProvisioningState = "Failed"
	ProvisioningStateSucceeded ProvisioningState = "Succeeded"
	ProvisioningStateUpdating  ProvisioningState = "Updating"
)

func (*ProvisioningState) UnmarshalJSON

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

type VirtualApplianceSite

type VirtualApplianceSite struct {
	Etag       *string                         `json:"etag,omitempty"`
	Id         *string                         `json:"id,omitempty"`
	Name       *string                         `json:"name,omitempty"`
	Properties *VirtualApplianceSiteProperties `json:"properties,omitempty"`
	Type       *string                         `json:"type,omitempty"`
}

type VirtualApplianceSiteId

type VirtualApplianceSiteId struct {
	SubscriptionId              string
	ResourceGroupName           string
	NetworkVirtualApplianceName string
	VirtualApplianceSiteName    string
}

VirtualApplianceSiteId is a struct representing the Resource ID for a Virtual Appliance Site

func NewVirtualApplianceSiteID

func NewVirtualApplianceSiteID(subscriptionId string, resourceGroupName string, networkVirtualApplianceName string, virtualApplianceSiteName string) VirtualApplianceSiteId

NewVirtualApplianceSiteID returns a new VirtualApplianceSiteId struct

func ParseVirtualApplianceSiteID

func ParseVirtualApplianceSiteID(input string) (*VirtualApplianceSiteId, error)

ParseVirtualApplianceSiteID parses 'input' into a VirtualApplianceSiteId

func ParseVirtualApplianceSiteIDInsensitively

func ParseVirtualApplianceSiteIDInsensitively(input string) (*VirtualApplianceSiteId, error)

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

func (*VirtualApplianceSiteId) FromParseResult

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

func (VirtualApplianceSiteId) ID

ID returns the formatted Virtual Appliance Site ID

func (VirtualApplianceSiteId) Segments

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

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

func (VirtualApplianceSiteId) String

func (id VirtualApplianceSiteId) String() string

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

type VirtualApplianceSiteOperationPredicate

type VirtualApplianceSiteOperationPredicate struct {
	Etag *string
	Id   *string
	Name *string
	Type *string
}

func (VirtualApplianceSiteOperationPredicate) Matches

type VirtualApplianceSiteProperties

type VirtualApplianceSiteProperties struct {
	AddressPrefix     *string                    `json:"addressPrefix,omitempty"`
	O365Policy        *Office365PolicyProperties `json:"o365Policy,omitempty"`
	ProvisioningState *ProvisioningState         `json:"provisioningState,omitempty"`
}

type VirtualApplianceSitesClient

type VirtualApplianceSitesClient struct {
	Client *resourcemanager.Client
}

func NewVirtualApplianceSitesClientWithBaseURI

func NewVirtualApplianceSitesClientWithBaseURI(sdkApi sdkEnv.Api) (*VirtualApplianceSitesClient, error)

func (VirtualApplianceSitesClient) CreateOrUpdate

CreateOrUpdate ...

func (VirtualApplianceSitesClient) CreateOrUpdateThenPoll

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (VirtualApplianceSitesClient) Delete

Delete ...

func (VirtualApplianceSitesClient) DeleteThenPoll

DeleteThenPoll performs Delete then polls until it's completed

func (VirtualApplianceSitesClient) Get

Get ...

func (VirtualApplianceSitesClient) List

List ...

func (VirtualApplianceSitesClient) ListComplete

ListComplete retrieves all the results into a single object

func (VirtualApplianceSitesClient) ListCompleteMatchingPredicate

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL