networkvirtualappliances

package
v0.20240301.1091357 Latest Latest
Warning

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

 Go to latest Published: Mar 1, 2024 License: MPL-2.0 Imports: 13 Imported by: 0

README

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

The networkvirtualappliances 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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/network/2023-04-01/networkvirtualappliances"

Client Initialization

client := networkvirtualappliances.NewNetworkVirtualAppliancesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: NetworkVirtualAppliancesClient.CreateOrUpdate

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

payload := networkvirtualappliances.NetworkVirtualAppliance{
	// ...
}


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

Example Usage: NetworkVirtualAppliancesClient.Delete

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

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

Example Usage: NetworkVirtualAppliancesClient.Get

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

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

Example Usage: NetworkVirtualAppliancesClient.InboundSecurityRuleCreateOrUpdate

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

payload := networkvirtualappliances.InboundSecurityRule{
	// ...
}


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

Example Usage: NetworkVirtualAppliancesClient.List

ctx := context.TODO()
id := commonids.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
}

Example Usage: NetworkVirtualAppliancesClient.ListByResourceGroup

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

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

Example Usage: NetworkVirtualAppliancesClient.UpdateTags

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

payload := networkvirtualappliances.TagsObject{
	// ...
}


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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForInboundSecurityRulesProtocol 

func PossibleValuesForInboundSecurityRulesProtocol() []string

func PossibleValuesForProvisioningState 

func PossibleValuesForProvisioningState() []string

func ValidateInboundSecurityRuleID 

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

ValidateInboundSecurityRuleID checks that 'input' can be parsed as a Inbound Security Rule ID

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

Types

type CreateOrUpdateOperationResponse 

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

type DelegationProperties 

type DelegationProperties struct {
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty"`
	ServiceName       *string            `json:"serviceName,omitempty"`
}

type DeleteOperationResponse 

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

type GetOperationOptions 

type GetOperationOptions struct {
	Expand *string
}

func DefaultGetOperationOptions 

func DefaultGetOperationOptions() GetOperationOptions

func (GetOperationOptions) ToHeaders 

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

func (GetOperationOptions) ToOData 

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

func (GetOperationOptions) ToQuery 

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

type GetOperationResponse 

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

type InboundSecurityRule 

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

type InboundSecurityRuleCreateOrUpdateOperationResponse 

type InboundSecurityRuleCreateOrUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *InboundSecurityRule
}

type InboundSecurityRuleId 

type InboundSecurityRuleId struct {
	SubscriptionId              string
	ResourceGroupName           string
	NetworkVirtualApplianceName string
	InboundSecurityRuleName     string
}

InboundSecurityRuleId is a struct representing the Resource ID for a Inbound Security Rule

func NewInboundSecurityRuleID 

func NewInboundSecurityRuleID(subscriptionId string, resourceGroupName string, networkVirtualApplianceName string, inboundSecurityRuleName string) InboundSecurityRuleId

NewInboundSecurityRuleID returns a new InboundSecurityRuleId struct

func ParseInboundSecurityRuleID 

func ParseInboundSecurityRuleID(input string) (*InboundSecurityRuleId, error)

ParseInboundSecurityRuleID parses 'input' into a InboundSecurityRuleId

func ParseInboundSecurityRuleIDInsensitively 

func ParseInboundSecurityRuleIDInsensitively(input string) (*InboundSecurityRuleId, error)

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

func (*InboundSecurityRuleId) FromParseResult 

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

func (InboundSecurityRuleId) ID 

func (id InboundSecurityRuleId) ID() string

ID returns the formatted Inbound Security Rule ID

func (InboundSecurityRuleId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Inbound Security Rule ID

func (InboundSecurityRuleId) String 

func (id InboundSecurityRuleId) String() string

String returns a human-readable description of this Inbound Security Rule ID

type InboundSecurityRuleProperties 

type InboundSecurityRuleProperties struct {
	ProvisioningState *ProvisioningState      `json:"provisioningState,omitempty"`
	Rules             *[]InboundSecurityRules `json:"rules,omitempty"`
}

type InboundSecurityRules 

type InboundSecurityRules struct {
	DestinationPortRange *int64                        `json:"destinationPortRange,omitempty"`
	Protocol             *InboundSecurityRulesProtocol `json:"protocol,omitempty"`
	SourceAddressPrefix  *string                       `json:"sourceAddressPrefix,omitempty"`
}

type InboundSecurityRulesProtocol 

type InboundSecurityRulesProtocol string
const (
	InboundSecurityRulesProtocolTCP InboundSecurityRulesProtocol = "TCP"
	InboundSecurityRulesProtocolUDP InboundSecurityRulesProtocol = "UDP"
)

func (*InboundSecurityRulesProtocol) UnmarshalJSON 

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

type ListByResourceGroupCompleteResult 

type ListByResourceGroupCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []NetworkVirtualAppliance
}

type ListByResourceGroupOperationResponse 

type ListByResourceGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]NetworkVirtualAppliance
}

type ListCompleteResult 

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

type ListOperationResponse 

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

type NetworkVirtualAppliance 

type NetworkVirtualAppliance struct {
	Etag       *string                                  `json:"etag,omitempty"`
	Id         *string                                  `json:"id,omitempty"`
	Identity   *identity.SystemAndUserAssignedMap       `json:"identity,omitempty"`
	Location   *string                                  `json:"location,omitempty"`
	Name       *string                                  `json:"name,omitempty"`
	Properties *NetworkVirtualAppliancePropertiesFormat `json:"properties,omitempty"`
	Tags       *map[string]string                       `json:"tags,omitempty"`
	Type       *string                                  `json:"type,omitempty"`
}

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 

func (id NetworkVirtualApplianceId) ID() string

ID returns the formatted Network Virtual Appliance ID

func (NetworkVirtualApplianceId) Segments 

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

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 NetworkVirtualApplianceOperationPredicate 

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

func (NetworkVirtualApplianceOperationPredicate) Matches 

func (p NetworkVirtualApplianceOperationPredicate) Matches(input NetworkVirtualAppliance) bool

type NetworkVirtualAppliancePropertiesFormat 

type NetworkVirtualAppliancePropertiesFormat struct {
	AdditionalNics              *[]VirtualApplianceAdditionalNicProperties `json:"additionalNics,omitempty"`
	AddressPrefix               *string                                    `json:"addressPrefix,omitempty"`
	BootStrapConfigurationBlobs *[]string                                  `json:"bootStrapConfigurationBlobs,omitempty"`
	CloudInitConfiguration      *string                                    `json:"cloudInitConfiguration,omitempty"`
	CloudInitConfigurationBlobs *[]string                                  `json:"cloudInitConfigurationBlobs,omitempty"`
	Delegation                  *DelegationProperties                      `json:"delegation,omitempty"`
	DeploymentType              *string                                    `json:"deploymentType,omitempty"`
	InboundSecurityRules        *[]SubResource                             `json:"inboundSecurityRules,omitempty"`
	NvaSku                      *VirtualApplianceSkuProperties             `json:"nvaSku,omitempty"`
	PartnerManagedResource      *PartnerManagedResourceProperties          `json:"partnerManagedResource,omitempty"`
	ProvisioningState           *ProvisioningState                         `json:"provisioningState,omitempty"`
	SshPublicKey                *string                                    `json:"sshPublicKey,omitempty"`
	VirtualApplianceAsn         *int64                                     `json:"virtualApplianceAsn,omitempty"`
	VirtualApplianceNics        *[]VirtualApplianceNicProperties           `json:"virtualApplianceNics,omitempty"`
	VirtualApplianceSites       *[]SubResource                             `json:"virtualApplianceSites,omitempty"`
	VirtualHub                  *SubResource                               `json:"virtualHub,omitempty"`
}

type NetworkVirtualAppliancesClient 

type NetworkVirtualAppliancesClient struct {
	Client *resourcemanager.Client
}

func NewNetworkVirtualAppliancesClientWithBaseURI 

func NewNetworkVirtualAppliancesClientWithBaseURI(sdkApi sdkEnv.Api) (*NetworkVirtualAppliancesClient, error)

func (NetworkVirtualAppliancesClient) CreateOrUpdate 

func (c NetworkVirtualAppliancesClient) CreateOrUpdate(ctx context.Context, id NetworkVirtualApplianceId, input NetworkVirtualAppliance) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (NetworkVirtualAppliancesClient) CreateOrUpdateThenPoll 

func (c NetworkVirtualAppliancesClient) CreateOrUpdateThenPoll(ctx context.Context, id NetworkVirtualApplianceId, input NetworkVirtualAppliance) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (NetworkVirtualAppliancesClient) Delete 

func (c NetworkVirtualAppliancesClient) Delete(ctx context.Context, id NetworkVirtualApplianceId) (result DeleteOperationResponse, err error)

Delete ...

func (NetworkVirtualAppliancesClient) DeleteThenPoll 

func (c NetworkVirtualAppliancesClient) DeleteThenPoll(ctx context.Context, id NetworkVirtualApplianceId) error

DeleteThenPoll performs Delete then polls until it's completed

func (NetworkVirtualAppliancesClient) Get 

func (c NetworkVirtualAppliancesClient) Get(ctx context.Context, id NetworkVirtualApplianceId, options GetOperationOptions) (result GetOperationResponse, err error)

Get ...

func (NetworkVirtualAppliancesClient) InboundSecurityRuleCreateOrUpdate 

func (c NetworkVirtualAppliancesClient) InboundSecurityRuleCreateOrUpdate(ctx context.Context, id InboundSecurityRuleId, input InboundSecurityRule) (result InboundSecurityRuleCreateOrUpdateOperationResponse, err error)

InboundSecurityRuleCreateOrUpdate ...

func (NetworkVirtualAppliancesClient) InboundSecurityRuleCreateOrUpdateThenPoll 

func (c NetworkVirtualAppliancesClient) InboundSecurityRuleCreateOrUpdateThenPoll(ctx context.Context, id InboundSecurityRuleId, input InboundSecurityRule) error

InboundSecurityRuleCreateOrUpdateThenPoll performs InboundSecurityRuleCreateOrUpdate then polls until it's completed

func (NetworkVirtualAppliancesClient) List 

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

List ...

func (NetworkVirtualAppliancesClient) ListByResourceGroup 

func (c NetworkVirtualAppliancesClient) ListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId) (result ListByResourceGroupOperationResponse, err error)

ListByResourceGroup ...

func (NetworkVirtualAppliancesClient) ListByResourceGroupComplete 

func (c NetworkVirtualAppliancesClient) ListByResourceGroupComplete(ctx context.Context, id commonids.ResourceGroupId) (ListByResourceGroupCompleteResult, error)

ListByResourceGroupComplete retrieves all the results into a single object

func (NetworkVirtualAppliancesClient) ListByResourceGroupCompleteMatchingPredicate 

func (c NetworkVirtualAppliancesClient) ListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, predicate NetworkVirtualApplianceOperationPredicate) (result ListByResourceGroupCompleteResult, err error)

ListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (NetworkVirtualAppliancesClient) ListComplete 

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

ListComplete retrieves all the results into a single object

func (NetworkVirtualAppliancesClient) ListCompleteMatchingPredicate 

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

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (NetworkVirtualAppliancesClient) UpdateTags 

func (c NetworkVirtualAppliancesClient) UpdateTags(ctx context.Context, id NetworkVirtualApplianceId, input TagsObject) (result UpdateTagsOperationResponse, err error)

UpdateTags ...

type PartnerManagedResourceProperties 

type PartnerManagedResourceProperties struct {
	Id                     *string `json:"id,omitempty"`
	InternalLoadBalancerId *string `json:"internalLoadBalancerId,omitempty"`
	StandardLoadBalancerId *string `json:"standardLoadBalancerId,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 SubResource 

type SubResource struct {
	Id *string `json:"id,omitempty"`
}

type TagsObject 

type TagsObject struct {
	Tags *map[string]string `json:"tags,omitempty"`
}

type UpdateTagsOperationResponse 

type UpdateTagsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *NetworkVirtualAppliance
}

type VirtualApplianceAdditionalNicProperties 

type VirtualApplianceAdditionalNicProperties struct {
	HasPublicIP *bool   `json:"hasPublicIp,omitempty"`
	Name        *string `json:"name,omitempty"`
}

type VirtualApplianceNicProperties 

type VirtualApplianceNicProperties struct {
	InstanceName     *string `json:"instanceName,omitempty"`
	Name             *string `json:"name,omitempty"`
	PrivateIPAddress *string `json:"privateIpAddress,omitempty"`
	PublicIPAddress  *string `json:"publicIpAddress,omitempty"`
}

type VirtualApplianceSkuProperties 

type VirtualApplianceSkuProperties struct {
	BundledScaleUnit   *string `json:"bundledScaleUnit,omitempty"`
	MarketPlaceVersion *string `json:"marketPlaceVersion,omitempty"`
	Vendor             *string `json:"vendor,omitempty"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.