networkvirtualappliances

package
v0.20240731.1212841 Latest Latest
Warning

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

Go to latest
Published: Jul 31, 2024 License: MPL-2.0 Imports: 14 Imported by: 0

README

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

The networkvirtualappliances SDK allows for interaction with the Azure Resource Manager Service network (API Version 2024-01-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/2024-01-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.InboundSecurityRuleGet

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

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

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.Restart

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

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


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

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 PossibleValuesForInboundSecurityRuleType

func PossibleValuesForInboundSecurityRuleType() []string

func PossibleValuesForInboundSecurityRulesProtocol

func PossibleValuesForInboundSecurityRulesProtocol() []string

func PossibleValuesForNicTypeInRequest

func PossibleValuesForNicTypeInRequest() []string

func PossibleValuesForNicTypeInResponse

func PossibleValuesForNicTypeInResponse() []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 InboundSecurityRuleGetOperationResponse

type InboundSecurityRuleGetOperationResponse struct {
	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"`
	RuleType          *InboundSecurityRuleType `json:"ruleType,omitempty"`
	Rules             *[]InboundSecurityRules  `json:"rules,omitempty"`
}

type InboundSecurityRuleType

type InboundSecurityRuleType string
const (
	InboundSecurityRuleTypeAutoExpire InboundSecurityRuleType = "AutoExpire"
	InboundSecurityRuleTypePermanent  InboundSecurityRuleType = "Permanent"
)

func (*InboundSecurityRuleType) UnmarshalJSON

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

type InboundSecurityRules

type InboundSecurityRules struct {
	AppliesOn             *[]string                     `json:"appliesOn,omitempty"`
	DestinationPortRange  *int64                        `json:"destinationPortRange,omitempty"`
	DestinationPortRanges *[]string                     `json:"destinationPortRanges,omitempty"`
	Name                  *string                       `json:"name,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 InternetIngressPublicIPsProperties

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

type ListByResourceGroupCompleteResult

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

type ListByResourceGroupCustomPager added in v0.20240628.1153531

type ListByResourceGroupCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListByResourceGroupCustomPager) NextPageLink() *odata.Link

type ListByResourceGroupOperationResponse

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

type ListCompleteResult

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

type ListCustomPager added in v0.20240628.1153531

type ListCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListCustomPager) NextPageLink() *odata.Link

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

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 NetworkVirtualApplianceInstanceIds

type NetworkVirtualApplianceInstanceIds struct {
	InstanceIds *[]string `json:"instanceIds,omitempty"`
}

type NetworkVirtualApplianceOperationPredicate

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

func (NetworkVirtualApplianceOperationPredicate) Matches

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"`
	InternetIngressPublicIPs    *[]InternetIngressPublicIPsProperties                  `json:"internetIngressPublicIps,omitempty"`
	NetworkProfile              *NetworkVirtualAppliancePropertiesFormatNetworkProfile `json:"networkProfile,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"`
	VirtualApplianceConnections *[]SubResource                                         `json:"virtualApplianceConnections,omitempty"`
	VirtualApplianceNics        *[]VirtualApplianceNicProperties                       `json:"virtualApplianceNics,omitempty"`
	VirtualApplianceSites       *[]SubResource                                         `json:"virtualApplianceSites,omitempty"`
	VirtualHub                  *SubResource                                           `json:"virtualHub,omitempty"`
}

type NetworkVirtualAppliancePropertiesFormatNetworkProfile

type NetworkVirtualAppliancePropertiesFormatNetworkProfile struct {
	NetworkInterfaceConfigurations *[]VirtualApplianceNetworkInterfaceConfiguration `json:"networkInterfaceConfigurations,omitempty"`
}

type NetworkVirtualAppliancesClient

type NetworkVirtualAppliancesClient struct {
	Client *resourcemanager.Client
}

func NewNetworkVirtualAppliancesClientWithBaseURI

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

func (NetworkVirtualAppliancesClient) CreateOrUpdate

CreateOrUpdate ...

func (NetworkVirtualAppliancesClient) CreateOrUpdateThenPoll

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (NetworkVirtualAppliancesClient) Delete

Delete ...

func (NetworkVirtualAppliancesClient) DeleteThenPoll

DeleteThenPoll performs Delete then polls until it's completed

func (NetworkVirtualAppliancesClient) Get

Get ...

func (NetworkVirtualAppliancesClient) InboundSecurityRuleCreateOrUpdate

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

InboundSecurityRuleGet ...

func (NetworkVirtualAppliancesClient) List

List ...

func (NetworkVirtualAppliancesClient) ListByResourceGroup

ListByResourceGroup ...

func (NetworkVirtualAppliancesClient) ListByResourceGroupComplete

ListByResourceGroupComplete retrieves all the results into a single object

func (NetworkVirtualAppliancesClient) ListByResourceGroupCompleteMatchingPredicate

ListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (NetworkVirtualAppliancesClient) ListComplete

ListComplete retrieves all the results into a single object

func (NetworkVirtualAppliancesClient) ListCompleteMatchingPredicate

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (NetworkVirtualAppliancesClient) Restart

Restart ...

func (NetworkVirtualAppliancesClient) RestartThenPoll

RestartThenPoll performs Restart then polls until it's completed

func (NetworkVirtualAppliancesClient) UpdateTags

UpdateTags ...

type NicTypeInRequest

type NicTypeInRequest string
const (
	NicTypeInRequestPrivateNic NicTypeInRequest = "PrivateNic"
	NicTypeInRequestPublicNic  NicTypeInRequest = "PublicNic"
)

func (*NicTypeInRequest) UnmarshalJSON

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

type NicTypeInResponse

type NicTypeInResponse string
const (
	NicTypeInResponseAdditionalNic NicTypeInResponse = "AdditionalNic"
	NicTypeInResponsePrivateNic    NicTypeInResponse = "PrivateNic"
	NicTypeInResponsePublicNic     NicTypeInResponse = "PublicNic"
)

func (*NicTypeInResponse) UnmarshalJSON

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

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 RestartOperationResponse

type RestartOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *NetworkVirtualApplianceInstanceIds
}

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 VirtualApplianceIPConfiguration

type VirtualApplianceIPConfiguration struct {
	Name       *string                                    `json:"name,omitempty"`
	Properties *VirtualApplianceIPConfigurationProperties `json:"properties,omitempty"`
}

type VirtualApplianceIPConfigurationProperties

type VirtualApplianceIPConfigurationProperties struct {
	Primary *bool `json:"primary,omitempty"`
}

type VirtualApplianceNetworkInterfaceConfiguration

type VirtualApplianceNetworkInterfaceConfiguration struct {
	Properties *VirtualApplianceNetworkInterfaceConfigurationProperties `json:"properties,omitempty"`
	Type       *NicTypeInRequest                                        `json:"type,omitempty"`
}

type VirtualApplianceNetworkInterfaceConfigurationProperties

type VirtualApplianceNetworkInterfaceConfigurationProperties struct {
	IPConfigurations *[]VirtualApplianceIPConfiguration `json:"ipConfigurations,omitempty"`
}

type VirtualApplianceNicProperties

type VirtualApplianceNicProperties struct {
	InstanceName     *string            `json:"instanceName,omitempty"`
	Name             *string            `json:"name,omitempty"`
	NicType          *NicTypeInResponse `json:"nicType,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"`
}

Jump to

Keyboard shortcuts

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