virtualnetworks

package
v0.20240612.1122027 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/systemcentervirtualmachinemanager/2023-10-07/virtualnetworks Documentation

The virtualnetworks SDK allows for interaction with the Azure Resource Manager Service systemcentervirtualmachinemanager (API Version 2023-10-07).

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/systemcentervirtualmachinemanager/2023-10-07/virtualnetworks"

Client Initialization

client := virtualnetworks.NewVirtualNetworksClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: VirtualNetworksClient.CreateOrUpdate

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

payload := virtualnetworks.VirtualNetwork{
	// ...
}


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

Example Usage: VirtualNetworksClient.Delete

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

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

Example Usage: VirtualNetworksClient.Get

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

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: VirtualNetworksClient.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: VirtualNetworksClient.ListBySubscription

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

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

Example Usage: VirtualNetworksClient.Update

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

payload := virtualnetworks.VirtualNetworkTagsUpdate{
	// ...
}


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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForForceDelete added in v0.20240604.1114748 

func PossibleValuesForForceDelete() []string

func PossibleValuesForResourceProvisioningState added in v0.20240604.1114748 

func PossibleValuesForResourceProvisioningState() []string

func ValidateVirtualNetworkID 

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

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

Types

type CreateOrUpdateOperationResponse 

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

type DeleteOperationOptions 

type DeleteOperationOptions struct {
	Force *ForceDelete
}

func DefaultDeleteOperationOptions 

func DefaultDeleteOperationOptions() DeleteOperationOptions

func (DeleteOperationOptions) ToHeaders 

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

func (DeleteOperationOptions) ToOData 

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

func (DeleteOperationOptions) ToQuery 

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

type DeleteOperationResponse 

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

type ExtendedLocation 

type ExtendedLocation struct {
	Name *string `json:"name,omitempty"`
	Type *string `json:"type,omitempty"`
}

type ForceDelete added in v0.20240604.1114748 

type ForceDelete string
const (
	ForceDeleteFalse ForceDelete = "false"
	ForceDeleteTrue  ForceDelete = "true"
)

func (*ForceDelete) UnmarshalJSON added in v0.20240604.1114748 

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

type GetOperationResponse 

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

type ListByResourceGroupCompleteResult 

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

type ListByResourceGroupOperationResponse 

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

type ListBySubscriptionCompleteResult 

type ListBySubscriptionCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []VirtualNetwork
}

type ListBySubscriptionOperationResponse 

type ListBySubscriptionOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]VirtualNetwork
}

type ResourceProvisioningState added in v0.20240604.1114748 

type ResourceProvisioningState string
const (
	ResourceProvisioningStateAccepted     ResourceProvisioningState = "Accepted"
	ResourceProvisioningStateCanceled     ResourceProvisioningState = "Canceled"
	ResourceProvisioningStateCreated      ResourceProvisioningState = "Created"
	ResourceProvisioningStateDeleting     ResourceProvisioningState = "Deleting"
	ResourceProvisioningStateFailed       ResourceProvisioningState = "Failed"
	ResourceProvisioningStateProvisioning ResourceProvisioningState = "Provisioning"
	ResourceProvisioningStateSucceeded    ResourceProvisioningState = "Succeeded"
	ResourceProvisioningStateUpdating     ResourceProvisioningState = "Updating"
)

func (*ResourceProvisioningState) UnmarshalJSON added in v0.20240604.1114748 

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

type UpdateOperationResponse 

type UpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *VirtualNetwork
}

type VirtualNetwork 

type VirtualNetwork struct {
	ExtendedLocation ExtendedLocation          `json:"extendedLocation"`
	Id               *string                   `json:"id,omitempty"`
	Location         string                    `json:"location"`
	Name             *string                   `json:"name,omitempty"`
	Properties       *VirtualNetworkProperties `json:"properties,omitempty"`
	SystemData       *systemdata.SystemData    `json:"systemData,omitempty"`
	Tags             *map[string]string        `json:"tags,omitempty"`
	Type             *string                   `json:"type,omitempty"`
}

type VirtualNetworkId 

type VirtualNetworkId struct {
	SubscriptionId     string
	ResourceGroupName  string
	VirtualNetworkName string
}

VirtualNetworkId is a struct representing the Resource ID for a Virtual Network

func NewVirtualNetworkID 

func NewVirtualNetworkID(subscriptionId string, resourceGroupName string, virtualNetworkName string) VirtualNetworkId

NewVirtualNetworkID returns a new VirtualNetworkId struct

func ParseVirtualNetworkID 

func ParseVirtualNetworkID(input string) (*VirtualNetworkId, error)

ParseVirtualNetworkID parses 'input' into a VirtualNetworkId

func ParseVirtualNetworkIDInsensitively 

func ParseVirtualNetworkIDInsensitively(input string) (*VirtualNetworkId, error)

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

func (*VirtualNetworkId) FromParseResult 

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

func (VirtualNetworkId) ID 

func (id VirtualNetworkId) ID() string

ID returns the formatted Virtual Network ID

func (VirtualNetworkId) Segments 

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

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

func (VirtualNetworkId) String 

func (id VirtualNetworkId) String() string

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

type VirtualNetworkOperationPredicate 

type VirtualNetworkOperationPredicate struct {
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (VirtualNetworkOperationPredicate) Matches 

func (p VirtualNetworkOperationPredicate) Matches(input VirtualNetwork) bool

type VirtualNetworkProperties 

type VirtualNetworkProperties struct {
	InventoryItemId   *string                    `json:"inventoryItemId,omitempty"`
	NetworkName       *string                    `json:"networkName,omitempty"`
	ProvisioningState *ResourceProvisioningState `json:"provisioningState,omitempty"`
	Uuid              *string                    `json:"uuid,omitempty"`
	VMmServerId       *string                    `json:"vmmServerId,omitempty"`
}

type VirtualNetworkTagsUpdate added in v0.20240604.1114748 

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

type VirtualNetworksClient 

type VirtualNetworksClient struct {
	Client *resourcemanager.Client
}

func NewVirtualNetworksClientWithBaseURI 

func NewVirtualNetworksClientWithBaseURI(sdkApi sdkEnv.Api) (*VirtualNetworksClient, error)

func (VirtualNetworksClient) CreateOrUpdate 

func (c VirtualNetworksClient) CreateOrUpdate(ctx context.Context, id VirtualNetworkId, input VirtualNetwork) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (VirtualNetworksClient) CreateOrUpdateThenPoll 

func (c VirtualNetworksClient) CreateOrUpdateThenPoll(ctx context.Context, id VirtualNetworkId, input VirtualNetwork) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (VirtualNetworksClient) Delete 

func (c VirtualNetworksClient) Delete(ctx context.Context, id VirtualNetworkId, options DeleteOperationOptions) (result DeleteOperationResponse, err error)

Delete ...

func (VirtualNetworksClient) DeleteThenPoll 

func (c VirtualNetworksClient) DeleteThenPoll(ctx context.Context, id VirtualNetworkId, options DeleteOperationOptions) error

DeleteThenPoll performs Delete then polls until it's completed

func (VirtualNetworksClient) Get 

func (c VirtualNetworksClient) Get(ctx context.Context, id VirtualNetworkId) (result GetOperationResponse, err error)

Get ...

func (VirtualNetworksClient) ListByResourceGroup 

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

ListByResourceGroup ...

func (VirtualNetworksClient) ListByResourceGroupComplete 

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

ListByResourceGroupComplete retrieves all the results into a single object

func (VirtualNetworksClient) ListByResourceGroupCompleteMatchingPredicate 

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

ListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (VirtualNetworksClient) ListBySubscription 

func (c VirtualNetworksClient) ListBySubscription(ctx context.Context, id commonids.SubscriptionId) (result ListBySubscriptionOperationResponse, err error)

ListBySubscription ...

func (VirtualNetworksClient) ListBySubscriptionComplete 

func (c VirtualNetworksClient) ListBySubscriptionComplete(ctx context.Context, id commonids.SubscriptionId) (ListBySubscriptionCompleteResult, error)

ListBySubscriptionComplete retrieves all the results into a single object

func (VirtualNetworksClient) ListBySubscriptionCompleteMatchingPredicate 

func (c VirtualNetworksClient) ListBySubscriptionCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate VirtualNetworkOperationPredicate) (result ListBySubscriptionCompleteResult, err error)

ListBySubscriptionCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (VirtualNetworksClient) Update 

func (c VirtualNetworksClient) Update(ctx context.Context, id VirtualNetworkId, input VirtualNetworkTagsUpdate) (result UpdateOperationResponse, err error)

Update ...

func (VirtualNetworksClient) UpdateThenPoll 

func (c VirtualNetworksClient) UpdateThenPoll(ctx context.Context, id VirtualNetworkId, input VirtualNetworkTagsUpdate) error

UpdateThenPoll performs Update then polls until it's completed

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.