bastionshareablelink

package
v0.20231127.1195240 Latest Latest
Warning

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

Go to latest
Published: Nov 27, 2023 License: MPL-2.0 Imports: 10 Imported by: 0

README

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

Client Initialization

client := bastionshareablelink.NewBastionShareableLinkClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
ctx := context.TODO()
id := bastionshareablelink.NewBastionHostID("12345678-1234-9876-4563-123456789012", "example-resource-group", "bastionHostValue")

payload := bastionshareablelink.BastionShareableLinkListRequest{
	// ...
}


if err := client.DeleteBastionShareableLinkThenPoll(ctx, id, payload); err != nil {
	// handle the error
}
ctx := context.TODO()
id := bastionshareablelink.NewBastionHostID("12345678-1234-9876-4563-123456789012", "example-resource-group", "bastionHostValue")

payload := bastionshareablelink.BastionShareableLinkListRequest{
	// ...
}


// alternatively `client.GetBastionShareableLink(ctx, id, payload)` can be used to do batched pagination
items, err := client.GetBastionShareableLinkComplete(ctx, id, payload)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}
ctx := context.TODO()
id := bastionshareablelink.NewBastionHostID("12345678-1234-9876-4563-123456789012", "example-resource-group", "bastionHostValue")

payload := bastionshareablelink.BastionShareableLinkListRequest{
	// ...
}


// alternatively `client.PutBastionShareableLink(ctx, id, payload)` can be used to do batched pagination
items, err := client.PutBastionShareableLinkComplete(ctx, id, payload)
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 ValidateBastionHostID

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

ValidateBastionHostID checks that 'input' can be parsed as a Bastion Host ID

Types

type BastionHostId

type BastionHostId struct {
	SubscriptionId    string
	ResourceGroupName string
	BastionHostName   string
}

BastionHostId is a struct representing the Resource ID for a Bastion Host

func NewBastionHostID

func NewBastionHostID(subscriptionId string, resourceGroupName string, bastionHostName string) BastionHostId

NewBastionHostID returns a new BastionHostId struct

func ParseBastionHostID

func ParseBastionHostID(input string) (*BastionHostId, error)

ParseBastionHostID parses 'input' into a BastionHostId

func ParseBastionHostIDInsensitively

func ParseBastionHostIDInsensitively(input string) (*BastionHostId, error)

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

func (*BastionHostId) FromParseResult added in v0.20231127.1171502

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

func (BastionHostId) ID

func (id BastionHostId) ID() string

ID returns the formatted Bastion Host ID

func (BastionHostId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Bastion Host ID

func (BastionHostId) String

func (id BastionHostId) String() string

String returns a human-readable description of this Bastion Host ID

type BastionShareableLink struct {
	Bsl       *string  `json:"bsl,omitempty"`
	CreatedAt *string  `json:"createdAt,omitempty"`
	Message   *string  `json:"message,omitempty"`
	VM        Resource `json:"vm"`
}

type BastionShareableLinkClient

type BastionShareableLinkClient struct {
	Client *resourcemanager.Client
}

func NewBastionShareableLinkClientWithBaseURI

func NewBastionShareableLinkClientWithBaseURI(sdkApi sdkEnv.Api) (*BastionShareableLinkClient, error)

DeleteBastionShareableLink ...

func (BastionShareableLinkClient) DeleteBastionShareableLinkThenPoll

func (c BastionShareableLinkClient) DeleteBastionShareableLinkThenPoll(ctx context.Context, id BastionHostId, input BastionShareableLinkListRequest) error

DeleteBastionShareableLinkThenPoll performs DeleteBastionShareableLink then polls until it's completed

GetBastionShareableLink ...

func (BastionShareableLinkClient) GetBastionShareableLinkComplete

GetBastionShareableLinkComplete retrieves all the results into a single object

func (BastionShareableLinkClient) GetBastionShareableLinkCompleteMatchingPredicate

GetBastionShareableLinkCompleteMatchingPredicate retrieves all the results and then applies the predicate

PutBastionShareableLink ...

func (BastionShareableLinkClient) PutBastionShareableLinkThenPoll

func (c BastionShareableLinkClient) PutBastionShareableLinkThenPoll(ctx context.Context, id BastionHostId, input BastionShareableLinkListRequest) error

PutBastionShareableLinkThenPoll performs PutBastionShareableLink then polls until it's completed

type BastionShareableLinkListRequest

type BastionShareableLinkListRequest struct {
	VMs *[]BastionShareableLink `json:"vms,omitempty"`
}

type BastionShareableLinkOperationPredicate

type BastionShareableLinkOperationPredicate struct {
	Bsl       *string
	CreatedAt *string
	Message   *string
}

func (BastionShareableLinkOperationPredicate) Matches

type DeleteBastionShareableLinkOperationResponse

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

type GetBastionShareableLinkCompleteResult

type GetBastionShareableLinkCompleteResult struct {
	Items []BastionShareableLink
}

type GetBastionShareableLinkOperationResponse

type GetBastionShareableLinkOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]BastionShareableLink
}

type PutBastionShareableLinkCompleteResult

type PutBastionShareableLinkCompleteResult struct {
	Items []BastionShareableLink
}

type PutBastionShareableLinkOperationResponse

type PutBastionShareableLinkOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]BastionShareableLink
}

type Resource

type Resource struct {
	Id       *string            `json:"id,omitempty"`
	Location *string            `json:"location,omitempty"`
	Name     *string            `json:"name,omitempty"`
	Tags     *map[string]string `json:"tags,omitempty"`
	Type     *string            `json:"type,omitempty"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL