verifierworkspaces

package
v0.20241128.1084944 Latest Latest
Warning

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

 Go to latest Published: Nov 28, 2024 License: MPL-2.0 Imports: 13 Imported by: 0

README

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

The verifierworkspaces 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-sdk/resource-manager/network/2024-05-01/verifierworkspaces"

Client Initialization

client := verifierworkspaces.NewVerifierWorkspacesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: VerifierWorkspacesClient.Create

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

payload := verifierworkspaces.VerifierWorkspace{
	// ...
}


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

Example Usage: VerifierWorkspacesClient.Delete

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

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

Example Usage: VerifierWorkspacesClient.Get

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

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

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

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

Example Usage: VerifierWorkspacesClient.Update

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

payload := verifierworkspaces.VerifierWorkspaceUpdate{
	// ...
}


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

func ValidateVerifierWorkspaceID 

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

ValidateVerifierWorkspaceID checks that 'input' can be parsed as a Verifier Workspace ID

Types

type CreateOperationResponse 

type CreateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *VerifierWorkspace
}

type DeleteOperationResponse 

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

type GetOperationResponse 

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

type ListCompleteResult 

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

type ListCustomPager 

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

type ListOperationOptions 

type ListOperationOptions struct {
	Skip      *int64
	SkipToken *string
	SortKey   *string
	SortValue *string
	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        *[]VerifierWorkspace
}

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 ProvisioningState 

type ProvisioningState string
const (
	ProvisioningStateCanceled  ProvisioningState = "Canceled"
	ProvisioningStateCreating  ProvisioningState = "Creating"
	ProvisioningStateDeleting  ProvisioningState = "Deleting"
	ProvisioningStateFailed    ProvisioningState = "Failed"
	ProvisioningStateSucceeded ProvisioningState = "Succeeded"
	ProvisioningStateUpdating  ProvisioningState = "Updating"
)

func (*ProvisioningState) UnmarshalJSON 

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

type UpdateOperationResponse 

type UpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *VerifierWorkspace
}

type VerifierWorkspace 

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

type VerifierWorkspaceId 

type VerifierWorkspaceId struct {
	SubscriptionId        string
	ResourceGroupName     string
	NetworkManagerName    string
	VerifierWorkspaceName string
}

VerifierWorkspaceId is a struct representing the Resource ID for a Verifier Workspace

func NewVerifierWorkspaceID 

func NewVerifierWorkspaceID(subscriptionId string, resourceGroupName string, networkManagerName string, verifierWorkspaceName string) VerifierWorkspaceId

NewVerifierWorkspaceID returns a new VerifierWorkspaceId struct

func ParseVerifierWorkspaceID 

func ParseVerifierWorkspaceID(input string) (*VerifierWorkspaceId, error)

ParseVerifierWorkspaceID parses 'input' into a VerifierWorkspaceId

func ParseVerifierWorkspaceIDInsensitively 

func ParseVerifierWorkspaceIDInsensitively(input string) (*VerifierWorkspaceId, error)

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

func (*VerifierWorkspaceId) FromParseResult 

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

func (VerifierWorkspaceId) ID 

func (id VerifierWorkspaceId) ID() string

ID returns the formatted Verifier Workspace ID

func (VerifierWorkspaceId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Verifier Workspace ID

func (VerifierWorkspaceId) String 

func (id VerifierWorkspaceId) String() string

String returns a human-readable description of this Verifier Workspace ID

type VerifierWorkspaceOperationPredicate 

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

func (VerifierWorkspaceOperationPredicate) Matches 

func (p VerifierWorkspaceOperationPredicate) Matches(input VerifierWorkspace) bool

type VerifierWorkspaceProperties 

type VerifierWorkspaceProperties struct {
	Description       *string            `json:"description,omitempty"`
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty"`
}

type VerifierWorkspaceUpdate 

type VerifierWorkspaceUpdate struct {
	Properties *VerifierWorkspaceUpdateProperties `json:"properties,omitempty"`
	Tags       *map[string]string                 `json:"tags,omitempty"`
}

type VerifierWorkspaceUpdateProperties 

type VerifierWorkspaceUpdateProperties struct {
	Description *string `json:"description,omitempty"`
}

type VerifierWorkspacesClient 

type VerifierWorkspacesClient struct {
	Client *resourcemanager.Client
}

func NewVerifierWorkspacesClientWithBaseURI 

func NewVerifierWorkspacesClientWithBaseURI(sdkApi sdkEnv.Api) (*VerifierWorkspacesClient, error)

func (VerifierWorkspacesClient) Create 

func (c VerifierWorkspacesClient) Create(ctx context.Context, id VerifierWorkspaceId, input VerifierWorkspace) (result CreateOperationResponse, err error)

Create ...

func (VerifierWorkspacesClient) Delete 

func (c VerifierWorkspacesClient) Delete(ctx context.Context, id VerifierWorkspaceId) (result DeleteOperationResponse, err error)

Delete ...

func (VerifierWorkspacesClient) DeleteThenPoll 

func (c VerifierWorkspacesClient) DeleteThenPoll(ctx context.Context, id VerifierWorkspaceId) error

DeleteThenPoll performs Delete then polls until it's completed

func (VerifierWorkspacesClient) Get 

func (c VerifierWorkspacesClient) Get(ctx context.Context, id VerifierWorkspaceId) (result GetOperationResponse, err error)

Get ...

func (VerifierWorkspacesClient) List 

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

List ...

func (VerifierWorkspacesClient) ListComplete 

func (c VerifierWorkspacesClient) ListComplete(ctx context.Context, id NetworkManagerId, options ListOperationOptions) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (VerifierWorkspacesClient) ListCompleteMatchingPredicate 

func (c VerifierWorkspacesClient) ListCompleteMatchingPredicate(ctx context.Context, id NetworkManagerId, options ListOperationOptions, predicate VerifierWorkspaceOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (VerifierWorkspacesClient) Update 

func (c VerifierWorkspacesClient) Update(ctx context.Context, id VerifierWorkspaceId, input VerifierWorkspaceUpdate) (result UpdateOperationResponse, err error)

Update ...

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.