networkmanagers

package
v0.20241212.1154051 Latest Latest
Warning

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

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

README

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

The networkmanagers SDK allows for interaction with Azure Resource Manager network (API Version 2024-05-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-05-01/networkmanagers"

Client Initialization

client := networkmanagers.NewNetworkManagersClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: NetworkManagersClient.CreateOrUpdate

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

payload := networkmanagers.NetworkManager{
	// ...
}


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

Example Usage: NetworkManagersClient.Delete

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

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

Example Usage: NetworkManagersClient.Get

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

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

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

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

Example Usage: NetworkManagersClient.ListBySubscription

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

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

Example Usage: NetworkManagersClient.NetworkManagerCommitsPost

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

payload := networkmanagers.NetworkManagerCommit{
	// ...
}


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

Example Usage: NetworkManagersClient.NetworkManagerDeploymentStatusList

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

payload := networkmanagers.NetworkManagerDeploymentStatusParameter{
	// ...
}


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

Example Usage: NetworkManagersClient.Patch

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

payload := networkmanagers.PatchObject{
	// ...
}


read, err := client.Patch(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 PossibleValuesForConfigurationType 

func PossibleValuesForConfigurationType() []string

func PossibleValuesForDeploymentStatus 

func PossibleValuesForDeploymentStatus() []string

func PossibleValuesForProvisioningState 

func PossibleValuesForProvisioningState() []string

func ValidateNetworkManagerID 

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

ValidateNetworkManagerID checks that 'input' can be parsed as a Network Manager ID

Types

type ConfigurationType 

type ConfigurationType string
const (
	ConfigurationTypeConnectivity  ConfigurationType = "Connectivity"
	ConfigurationTypeRouting       ConfigurationType = "Routing"
	ConfigurationTypeSecurityAdmin ConfigurationType = "SecurityAdmin"
	ConfigurationTypeSecurityUser  ConfigurationType = "SecurityUser"
)

func (*ConfigurationType) UnmarshalJSON 

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

type CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *NetworkManager
}

type CrossTenantScopes 

type CrossTenantScopes struct {
	ManagementGroups *[]string `json:"managementGroups,omitempty"`
	Subscriptions    *[]string `json:"subscriptions,omitempty"`
	TenantId         *string   `json:"tenantId,omitempty"`
}

type DeleteOperationOptions 

type DeleteOperationOptions struct {
	Force *bool
}

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 DeploymentStatus 

type DeploymentStatus string
const (
	DeploymentStatusDeployed   DeploymentStatus = "Deployed"
	DeploymentStatusDeploying  DeploymentStatus = "Deploying"
	DeploymentStatusFailed     DeploymentStatus = "Failed"
	DeploymentStatusNotStarted DeploymentStatus = "NotStarted"
)

func (*DeploymentStatus) UnmarshalJSON 

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

type GetOperationResponse 

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

type ListBySubscriptionCompleteResult 

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

type ListBySubscriptionCustomPager 

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

type ListBySubscriptionOperationOptions 

type ListBySubscriptionOperationOptions struct {
	Top *int64
}

func DefaultListBySubscriptionOperationOptions 

func DefaultListBySubscriptionOperationOptions() ListBySubscriptionOperationOptions

func (ListBySubscriptionOperationOptions) ToHeaders 

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

func (ListBySubscriptionOperationOptions) ToOData 

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

func (ListBySubscriptionOperationOptions) ToQuery 

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

type ListBySubscriptionOperationResponse 

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

type ListCompleteResult 

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

type ListCustomPager 

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

type ListOperationOptions 

type ListOperationOptions struct {
	Top *int64
}

func DefaultListOperationOptions 

func DefaultListOperationOptions() ListOperationOptions

func (ListOperationOptions) ToHeaders 

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

func (ListOperationOptions) ToOData 

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

func (ListOperationOptions) ToQuery 

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

type ListOperationResponse 

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

type NetworkManager 

type NetworkManager struct {
	Etag       *string                   `json:"etag,omitempty"`
	Id         *string                   `json:"id,omitempty"`
	Location   *string                   `json:"location,omitempty"`
	Name       *string                   `json:"name,omitempty"`
	Properties *NetworkManagerProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData    `json:"systemData,omitempty"`
	Tags       *map[string]string        `json:"tags,omitempty"`
	Type       *string                   `json:"type,omitempty"`
}

type NetworkManagerCommit 

type NetworkManagerCommit struct {
	CommitId         *string           `json:"commitId,omitempty"`
	CommitType       ConfigurationType `json:"commitType"`
	ConfigurationIds *[]string         `json:"configurationIds,omitempty"`
	TargetLocations  []string          `json:"targetLocations"`
}

type NetworkManagerCommitsPostOperationResponse 

type NetworkManagerCommitsPostOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *NetworkManagerCommit
}

type NetworkManagerDeploymentStatus 

type NetworkManagerDeploymentStatus struct {
	CommitTime       *string            `json:"commitTime,omitempty"`
	ConfigurationIds *[]string          `json:"configurationIds,omitempty"`
	DeploymentStatus *DeploymentStatus  `json:"deploymentStatus,omitempty"`
	DeploymentType   *ConfigurationType `json:"deploymentType,omitempty"`
	ErrorMessage     *string            `json:"errorMessage,omitempty"`
	Region           *string            `json:"region,omitempty"`
}

func (*NetworkManagerDeploymentStatus) GetCommitTimeAsTime 

func (o *NetworkManagerDeploymentStatus) GetCommitTimeAsTime() (*time.Time, error)

func (*NetworkManagerDeploymentStatus) SetCommitTimeAsTime 

func (o *NetworkManagerDeploymentStatus) SetCommitTimeAsTime(input time.Time)

type NetworkManagerDeploymentStatusListOperationResponse 

type NetworkManagerDeploymentStatusListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *NetworkManagerDeploymentStatusListResult
}

type NetworkManagerDeploymentStatusListResult 

type NetworkManagerDeploymentStatusListResult struct {
	SkipToken *string                           `json:"skipToken,omitempty"`
	Value     *[]NetworkManagerDeploymentStatus `json:"value,omitempty"`
}

type NetworkManagerDeploymentStatusParameter 

type NetworkManagerDeploymentStatusParameter struct {
	DeploymentTypes *[]ConfigurationType `json:"deploymentTypes,omitempty"`
	Regions         *[]string            `json:"regions,omitempty"`
	SkipToken       *string              `json:"skipToken,omitempty"`
}

type NetworkManagerId 

type NetworkManagerId struct {
	SubscriptionId     string
	ResourceGroupName  string
	NetworkManagerName string
}

NetworkManagerId is a struct representing the Resource ID for a Network Manager

func NewNetworkManagerID 

func NewNetworkManagerID(subscriptionId string, resourceGroupName string, networkManagerName string) NetworkManagerId

NewNetworkManagerID returns a new NetworkManagerId struct

func ParseNetworkManagerID 

func ParseNetworkManagerID(input string) (*NetworkManagerId, error)

ParseNetworkManagerID parses 'input' into a NetworkManagerId

func ParseNetworkManagerIDInsensitively 

func ParseNetworkManagerIDInsensitively(input string) (*NetworkManagerId, error)

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

func (*NetworkManagerId) FromParseResult 

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

func (NetworkManagerId) ID 

func (id NetworkManagerId) ID() string

ID returns the formatted Network Manager ID

func (NetworkManagerId) Segments 

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

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

func (NetworkManagerId) String 

func (id NetworkManagerId) String() string

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

type NetworkManagerOperationPredicate 

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

func (NetworkManagerOperationPredicate) Matches 

func (p NetworkManagerOperationPredicate) Matches(input NetworkManager) bool

type NetworkManagerProperties 

type NetworkManagerProperties struct {
	Description                 *string                                      `json:"description,omitempty"`
	NetworkManagerScopeAccesses *[]ConfigurationType                         `json:"networkManagerScopeAccesses,omitempty"`
	NetworkManagerScopes        NetworkManagerPropertiesNetworkManagerScopes `json:"networkManagerScopes"`
	ProvisioningState           *ProvisioningState                           `json:"provisioningState,omitempty"`
	ResourceGuid                *string                                      `json:"resourceGuid,omitempty"`
}

type NetworkManagerPropertiesNetworkManagerScopes 

type NetworkManagerPropertiesNetworkManagerScopes struct {
	CrossTenantScopes *[]CrossTenantScopes `json:"crossTenantScopes,omitempty"`
	ManagementGroups  *[]string            `json:"managementGroups,omitempty"`
	Subscriptions     *[]string            `json:"subscriptions,omitempty"`
}

type NetworkManagersClient 

type NetworkManagersClient struct {
	Client *resourcemanager.Client
}

func NewNetworkManagersClientWithBaseURI 

func NewNetworkManagersClientWithBaseURI(sdkApi sdkEnv.Api) (*NetworkManagersClient, error)

func (NetworkManagersClient) CreateOrUpdate 

func (c NetworkManagersClient) CreateOrUpdate(ctx context.Context, id NetworkManagerId, input NetworkManager) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (NetworkManagersClient) Delete 

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

Delete ...

func (NetworkManagersClient) DeleteThenPoll 

func (c NetworkManagersClient) DeleteThenPoll(ctx context.Context, id NetworkManagerId, options DeleteOperationOptions) error

DeleteThenPoll performs Delete then polls until it's completed

func (NetworkManagersClient) Get 

func (c NetworkManagersClient) Get(ctx context.Context, id NetworkManagerId) (result GetOperationResponse, err error)

Get ...

func (NetworkManagersClient) List 

func (c NetworkManagersClient) List(ctx context.Context, id commonids.ResourceGroupId, options ListOperationOptions) (result ListOperationResponse, err error)

List ...

func (NetworkManagersClient) ListBySubscription 

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

ListBySubscription ...

func (NetworkManagersClient) ListBySubscriptionComplete 

func (c NetworkManagersClient) ListBySubscriptionComplete(ctx context.Context, id commonids.SubscriptionId, options ListBySubscriptionOperationOptions) (ListBySubscriptionCompleteResult, error)

ListBySubscriptionComplete retrieves all the results into a single object

func (NetworkManagersClient) ListBySubscriptionCompleteMatchingPredicate 

func (c NetworkManagersClient) ListBySubscriptionCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, options ListBySubscriptionOperationOptions, predicate NetworkManagerOperationPredicate) (result ListBySubscriptionCompleteResult, err error)

ListBySubscriptionCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (NetworkManagersClient) ListComplete 

func (c NetworkManagersClient) ListComplete(ctx context.Context, id commonids.ResourceGroupId, options ListOperationOptions) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (NetworkManagersClient) ListCompleteMatchingPredicate 

func (c NetworkManagersClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, options ListOperationOptions, predicate NetworkManagerOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (NetworkManagersClient) NetworkManagerCommitsPost 

func (c NetworkManagersClient) NetworkManagerCommitsPost(ctx context.Context, id NetworkManagerId, input NetworkManagerCommit) (result NetworkManagerCommitsPostOperationResponse, err error)

NetworkManagerCommitsPost ...

func (NetworkManagersClient) NetworkManagerCommitsPostThenPoll 

func (c NetworkManagersClient) NetworkManagerCommitsPostThenPoll(ctx context.Context, id NetworkManagerId, input NetworkManagerCommit) error

NetworkManagerCommitsPostThenPoll performs NetworkManagerCommitsPost then polls until it's completed

func (NetworkManagersClient) NetworkManagerDeploymentStatusList 

func (c NetworkManagersClient) NetworkManagerDeploymentStatusList(ctx context.Context, id NetworkManagerId, input NetworkManagerDeploymentStatusParameter) (result NetworkManagerDeploymentStatusListOperationResponse, err error)

NetworkManagerDeploymentStatusList ...

func (NetworkManagersClient) Patch 

func (c NetworkManagersClient) Patch(ctx context.Context, id NetworkManagerId, input PatchObject) (result PatchOperationResponse, err error)

Patch ...

type PatchObject 

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

type PatchOperationResponse 

type PatchOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *NetworkManager
}

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

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.