staticmembers

package
v0.20231213.1191308 Latest Latest
Warning

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

 Go to latest Published: Dec 13, 2023 License: MPL-2.0 Imports: 11 Imported by: 0

README

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

The staticmembers 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/staticmembers"

Client Initialization

client := staticmembers.NewStaticMembersClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: StaticMembersClient.CreateOrUpdate

ctx := context.TODO()
id := staticmembers.NewStaticMemberID("12345678-1234-9876-4563-123456789012", "example-resource-group", "networkManagerValue", "networkGroupValue", "staticMemberValue")

payload := staticmembers.StaticMember{
	// ...
}


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: StaticMembersClient.Delete

ctx := context.TODO()
id := staticmembers.NewStaticMemberID("12345678-1234-9876-4563-123456789012", "example-resource-group", "networkManagerValue", "networkGroupValue", "staticMemberValue")

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

Example Usage: StaticMembersClient.Get

ctx := context.TODO()
id := staticmembers.NewStaticMemberID("12345678-1234-9876-4563-123456789012", "example-resource-group", "networkManagerValue", "networkGroupValue", "staticMemberValue")

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

ctx := context.TODO()
id := staticmembers.NewNetworkGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "networkManagerValue", "networkGroupValue")

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForProvisioningState 

func PossibleValuesForProvisioningState() []string

func ValidateNetworkGroupID 

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

ValidateNetworkGroupID checks that 'input' can be parsed as a Network Group ID

func ValidateStaticMemberID 

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

ValidateStaticMemberID checks that 'input' can be parsed as a Static Member ID

Types

type CreateOrUpdateOperationResponse 

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

type DeleteOperationResponse 

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

type GetOperationResponse 

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

type ListCompleteResult 

type ListCompleteResult struct {
	Items []StaticMember
}

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        *[]StaticMember
}

type NetworkGroupId 

type NetworkGroupId struct {
	SubscriptionId     string
	ResourceGroupName  string
	NetworkManagerName string
	NetworkGroupName   string
}

NetworkGroupId is a struct representing the Resource ID for a Network Group

func NewNetworkGroupID 

func NewNetworkGroupID(subscriptionId string, resourceGroupName string, networkManagerName string, networkGroupName string) NetworkGroupId

NewNetworkGroupID returns a new NetworkGroupId struct

func ParseNetworkGroupID 

func ParseNetworkGroupID(input string) (*NetworkGroupId, error)

ParseNetworkGroupID parses 'input' into a NetworkGroupId

func ParseNetworkGroupIDInsensitively 

func ParseNetworkGroupIDInsensitively(input string) (*NetworkGroupId, error)

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

func (*NetworkGroupId) FromParseResult added in v0.20231127.1171502 

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

func (NetworkGroupId) ID 

func (id NetworkGroupId) ID() string

ID returns the formatted Network Group ID

func (NetworkGroupId) Segments 

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

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

func (NetworkGroupId) String 

func (id NetworkGroupId) String() string

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

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 StaticMember 

type StaticMember struct {
	Etag       *string                 `json:"etag,omitempty"`
	Id         *string                 `json:"id,omitempty"`
	Name       *string                 `json:"name,omitempty"`
	Properties *StaticMemberProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData  `json:"systemData,omitempty"`
	Type       *string                 `json:"type,omitempty"`
}

type StaticMemberId 

type StaticMemberId struct {
	SubscriptionId     string
	ResourceGroupName  string
	NetworkManagerName string
	NetworkGroupName   string
	StaticMemberName   string
}

StaticMemberId is a struct representing the Resource ID for a Static Member

func NewStaticMemberID 

func NewStaticMemberID(subscriptionId string, resourceGroupName string, networkManagerName string, networkGroupName string, staticMemberName string) StaticMemberId

NewStaticMemberID returns a new StaticMemberId struct

func ParseStaticMemberID 

func ParseStaticMemberID(input string) (*StaticMemberId, error)

ParseStaticMemberID parses 'input' into a StaticMemberId

func ParseStaticMemberIDInsensitively 

func ParseStaticMemberIDInsensitively(input string) (*StaticMemberId, error)

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

func (*StaticMemberId) FromParseResult added in v0.20231127.1171502 

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

func (StaticMemberId) ID 

func (id StaticMemberId) ID() string

ID returns the formatted Static Member ID

func (StaticMemberId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Static Member ID

func (StaticMemberId) String 

func (id StaticMemberId) String() string

String returns a human-readable description of this Static Member ID

type StaticMemberOperationPredicate 

type StaticMemberOperationPredicate struct {
	Etag *string
	Id   *string
	Name *string
	Type *string
}

func (StaticMemberOperationPredicate) Matches 

func (p StaticMemberOperationPredicate) Matches(input StaticMember) bool

type StaticMemberProperties 

type StaticMemberProperties struct {
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty"`
	Region            *string            `json:"region,omitempty"`
	ResourceId        *string            `json:"resourceId,omitempty"`
}

type StaticMembersClient 

type StaticMembersClient struct {
	Client *resourcemanager.Client
}

func NewStaticMembersClientWithBaseURI 

func NewStaticMembersClientWithBaseURI(sdkApi sdkEnv.Api) (*StaticMembersClient, error)

func (StaticMembersClient) CreateOrUpdate 

func (c StaticMembersClient) CreateOrUpdate(ctx context.Context, id StaticMemberId, input StaticMember) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (StaticMembersClient) Delete 

func (c StaticMembersClient) Delete(ctx context.Context, id StaticMemberId) (result DeleteOperationResponse, err error)

Delete ...

func (StaticMembersClient) Get 

func (c StaticMembersClient) Get(ctx context.Context, id StaticMemberId) (result GetOperationResponse, err error)

Get ...

func (StaticMembersClient) List 

func (c StaticMembersClient) List(ctx context.Context, id NetworkGroupId, options ListOperationOptions) (result ListOperationResponse, err error)

List ...

func (StaticMembersClient) ListComplete 

func (c StaticMembersClient) ListComplete(ctx context.Context, id NetworkGroupId, options ListOperationOptions) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (StaticMembersClient) ListCompleteMatchingPredicate 

func (c StaticMembersClient) ListCompleteMatchingPredicate(ctx context.Context, id NetworkGroupId, options ListOperationOptions, predicate StaticMemberOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

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.