README ¶
github.com/hashicorp/go-azure-sdk/resource-manager/network/2023-04-01/virtualappliancesites
Documentation
The virtualappliancesites
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/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 ¶
- func PossibleValuesForProvisioningState() []string
- func ValidateNetworkVirtualApplianceID(input interface{}, key string) (warnings []string, errors []error)
- func ValidateVirtualApplianceSiteID(input interface{}, key string) (warnings []string, errors []error)
- type BreakOutCategoryPolicies
- type CreateOrUpdateOperationResponse
- type DeleteOperationResponse
- type GetOperationResponse
- type ListCompleteResult
- type ListOperationResponse
- type NetworkVirtualApplianceId
- type Office365PolicyProperties
- type ProvisioningState
- type VirtualApplianceSite
- type VirtualApplianceSiteId
- type VirtualApplianceSiteOperationPredicate
- type VirtualApplianceSiteProperties
- type VirtualApplianceSitesClient
- func (c VirtualApplianceSitesClient) CreateOrUpdate(ctx context.Context, id VirtualApplianceSiteId, input VirtualApplianceSite) (result CreateOrUpdateOperationResponse, err error)
- func (c VirtualApplianceSitesClient) CreateOrUpdateThenPoll(ctx context.Context, id VirtualApplianceSiteId, input VirtualApplianceSite) error
- func (c VirtualApplianceSitesClient) Delete(ctx context.Context, id VirtualApplianceSiteId) (result DeleteOperationResponse, err error)
- func (c VirtualApplianceSitesClient) DeleteThenPoll(ctx context.Context, id VirtualApplianceSiteId) error
- func (c VirtualApplianceSitesClient) Get(ctx context.Context, id VirtualApplianceSiteId) (result GetOperationResponse, err error)
- func (c VirtualApplianceSitesClient) List(ctx context.Context, id NetworkVirtualApplianceId) (result ListOperationResponse, err error)
- func (c VirtualApplianceSitesClient) ListComplete(ctx context.Context, id NetworkVirtualApplianceId) (ListCompleteResult, error)
- func (c VirtualApplianceSitesClient) ListCompleteMatchingPredicate(ctx context.Context, id NetworkVirtualApplianceId, ...) (result ListCompleteResult, err error)
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 DeleteOperationResponse ¶
type GetOperationResponse ¶
type GetOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *VirtualApplianceSite }
type ListCompleteResult ¶
type ListCompleteResult struct {
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) 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 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) ID ¶
func (id VirtualApplianceSiteId) ID() string
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 ¶
func (p VirtualApplianceSiteOperationPredicate) Matches(input VirtualApplianceSite) bool
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 ¶
func (c VirtualApplianceSitesClient) CreateOrUpdate(ctx context.Context, id VirtualApplianceSiteId, input VirtualApplianceSite) (result CreateOrUpdateOperationResponse, err error)
CreateOrUpdate ...
func (VirtualApplianceSitesClient) CreateOrUpdateThenPoll ¶
func (c VirtualApplianceSitesClient) CreateOrUpdateThenPoll(ctx context.Context, id VirtualApplianceSiteId, input VirtualApplianceSite) error
CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed
func (VirtualApplianceSitesClient) Delete ¶
func (c VirtualApplianceSitesClient) Delete(ctx context.Context, id VirtualApplianceSiteId) (result DeleteOperationResponse, err error)
Delete ...
func (VirtualApplianceSitesClient) DeleteThenPoll ¶
func (c VirtualApplianceSitesClient) DeleteThenPoll(ctx context.Context, id VirtualApplianceSiteId) error
DeleteThenPoll performs Delete then polls until it's completed
func (VirtualApplianceSitesClient) Get ¶
func (c VirtualApplianceSitesClient) Get(ctx context.Context, id VirtualApplianceSiteId) (result GetOperationResponse, err error)
Get ...
func (VirtualApplianceSitesClient) List ¶
func (c VirtualApplianceSitesClient) List(ctx context.Context, id NetworkVirtualApplianceId) (result ListOperationResponse, err error)
List ...
func (VirtualApplianceSitesClient) ListComplete ¶
func (c VirtualApplianceSitesClient) ListComplete(ctx context.Context, id NetworkVirtualApplianceId) (ListCompleteResult, error)
ListComplete retrieves all the results into a single object
func (VirtualApplianceSitesClient) ListCompleteMatchingPredicate ¶
func (c VirtualApplianceSitesClient) ListCompleteMatchingPredicate(ctx context.Context, id NetworkVirtualApplianceId, predicate VirtualApplianceSiteOperationPredicate) (result ListCompleteResult, err error)
ListCompleteMatchingPredicate retrieves all the results and then applies the predicate
Source Files ¶
- client.go
- constants.go
- id_networkvirtualappliance.go
- id_virtualappliancesite.go
- method_createorupdate.go
- method_delete.go
- method_get.go
- method_list.go
- model_breakoutcategorypolicies.go
- model_office365policyproperties.go
- model_virtualappliancesite.go
- model_virtualappliancesiteproperties.go
- predicates.go
- version.go