bastionshareablelink

package
v0.20241023.1122425 Latest Latest
Warning

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

 Go to latest Published: Oct 23, 2024 License: MPL-2.0 Imports: 11 Imported by: 0

README

The bastionshareablelink SDK allows for interaction with Azure Resource Manager network (API Version 2024-03-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-03-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", "bastionHostName")

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


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

Example Usage: BastionShareableLinkClient.DeleteBastionShareableLinkByToken

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

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


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

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

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", "bastionHostName")

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 

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)
func (c BastionShareableLinkClient) DeleteBastionShareableLink(ctx context.Context, id BastionHostId, input BastionShareableLinkListRequest) (result DeleteBastionShareableLinkOperationResponse, err error)

DeleteBastionShareableLink ...

func (BastionShareableLinkClient) DeleteBastionShareableLinkByToken 

func (c BastionShareableLinkClient) DeleteBastionShareableLinkByToken(ctx context.Context, id BastionHostId, input BastionShareableLinkTokenListRequest) (result DeleteBastionShareableLinkByTokenOperationResponse, err error)

DeleteBastionShareableLinkByToken ...

func (BastionShareableLinkClient) DeleteBastionShareableLinkByTokenThenPoll 

func (c BastionShareableLinkClient) DeleteBastionShareableLinkByTokenThenPoll(ctx context.Context, id BastionHostId, input BastionShareableLinkTokenListRequest) error

DeleteBastionShareableLinkByTokenThenPoll performs DeleteBastionShareableLinkByToken then polls until it's completed

func (BastionShareableLinkClient) DeleteBastionShareableLinkThenPoll 

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

DeleteBastionShareableLinkThenPoll performs DeleteBastionShareableLink then polls until it's completed 

func (c BastionShareableLinkClient) GetBastionShareableLink(ctx context.Context, id BastionHostId, input BastionShareableLinkListRequest) (result GetBastionShareableLinkOperationResponse, err error)

GetBastionShareableLink ...

func (BastionShareableLinkClient) GetBastionShareableLinkComplete 

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

GetBastionShareableLinkComplete retrieves all the results into a single object

func (BastionShareableLinkClient) GetBastionShareableLinkCompleteMatchingPredicate 

func (c BastionShareableLinkClient) GetBastionShareableLinkCompleteMatchingPredicate(ctx context.Context, id BastionHostId, input BastionShareableLinkListRequest, predicate BastionShareableLinkOperationPredicate) (result GetBastionShareableLinkCompleteResult, err error)

GetBastionShareableLinkCompleteMatchingPredicate retrieves all the results and then applies the predicate 

func (c BastionShareableLinkClient) PutBastionShareableLink(ctx context.Context, id BastionHostId, input BastionShareableLinkListRequest) (result PutBastionShareableLinkOperationResponse, err error)

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 

func (p BastionShareableLinkOperationPredicate) Matches(input BastionShareableLink) bool

type BastionShareableLinkTokenListRequest 

type BastionShareableLinkTokenListRequest struct {
	Tokens *[]string `json:"tokens,omitempty"`
}

type DeleteBastionShareableLinkByTokenOperationResponse 

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

type DeleteBastionShareableLinkOperationResponse 

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

type GetBastionShareableLinkCompleteResult 

type GetBastionShareableLinkCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []BastionShareableLink
}

type GetBastionShareableLinkCustomPager 

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

type GetBastionShareableLinkOperationResponse 

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

type PutBastionShareableLinkCompleteResult 

type PutBastionShareableLinkCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []BastionShareableLink
}

type PutBastionShareableLinkCustomPager 

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

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"`
}

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.