README ¶
github.com/hashicorp/go-azure-sdk/resource-manager/network/2023-04-01/bastionshareablelink
Documentation
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
Example Usage: BastionShareableLinkClient.DeleteBastionShareableLink
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
}
Example Usage: BastionShareableLinkClient.GetBastionShareableLink
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
}
Example Usage: BastionShareableLinkClient.PutBastionShareableLink
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 ¶
- func ValidateBastionHostID(input interface{}, key string) (warnings []string, errors []error)
- type BastionHostId
- type BastionShareableLink
- type BastionShareableLinkClient
- func (c BastionShareableLinkClient) DeleteBastionShareableLink(ctx context.Context, id BastionHostId, input BastionShareableLinkListRequest) (result DeleteBastionShareableLinkOperationResponse, err error)
- func (c BastionShareableLinkClient) DeleteBastionShareableLinkThenPoll(ctx context.Context, id BastionHostId, input BastionShareableLinkListRequest) error
- func (c BastionShareableLinkClient) GetBastionShareableLink(ctx context.Context, id BastionHostId, input BastionShareableLinkListRequest) (result GetBastionShareableLinkOperationResponse, err error)
- func (c BastionShareableLinkClient) GetBastionShareableLinkComplete(ctx context.Context, id BastionHostId, input BastionShareableLinkListRequest) (GetBastionShareableLinkCompleteResult, error)
- func (c BastionShareableLinkClient) GetBastionShareableLinkCompleteMatchingPredicate(ctx context.Context, id BastionHostId, input BastionShareableLinkListRequest, ...) (result GetBastionShareableLinkCompleteResult, err error)
- func (c BastionShareableLinkClient) PutBastionShareableLink(ctx context.Context, id BastionHostId, input BastionShareableLinkListRequest) (result PutBastionShareableLinkOperationResponse, err error)
- func (c BastionShareableLinkClient) PutBastionShareableLinkThenPoll(ctx context.Context, id BastionHostId, input BastionShareableLinkListRequest) error
- type BastionShareableLinkListRequest
- type BastionShareableLinkOperationPredicate
- type DeleteBastionShareableLinkOperationResponse
- type GetBastionShareableLinkCompleteResult
- type GetBastionShareableLinkOperationResponse
- type PutBastionShareableLinkCompleteResult
- type PutBastionShareableLinkOperationResponse
- type Resource
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ValidateBastionHostID ¶
ValidateBastionHostID checks that 'input' can be parsed as a Bastion Host ID
Types ¶
type BastionHostId ¶
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) 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 ¶
type BastionShareableLink struct {}
type BastionShareableLinkClient ¶
type BastionShareableLinkClient struct {
}func NewBastionShareableLinkClientWithBaseURI ¶
func NewBastionShareableLinkClientWithBaseURI(sdkApi sdkEnv.Api) (*BastionShareableLinkClient, error)
func (BastionShareableLinkClient) DeleteBastionShareableLink ¶
func (c BastionShareableLinkClient) DeleteBastionShareableLink(ctx context.Context, id BastionHostId, input BastionShareableLinkListRequest) (result DeleteBastionShareableLinkOperationResponse, err 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
func (BastionShareableLinkClient) GetBastionShareableLink ¶
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 (BastionShareableLinkClient) PutBastionShareableLink ¶
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 {
}type BastionShareableLinkOperationPredicate ¶
type BastionShareableLinkOperationPredicate struct {}
func (BastionShareableLinkOperationPredicate) Matches ¶
func (p BastionShareableLinkOperationPredicate) Matches(input BastionShareableLink) bool
type DeleteBastionShareableLinkOperationResponse ¶
type DeleteBastionShareableLinkOperationResponse struct {}
type GetBastionShareableLinkCompleteResult ¶
type GetBastionShareableLinkCompleteResult struct {
}type GetBastionShareableLinkOperationResponse ¶
type GetBastionShareableLinkOperationResponse struct {}
type PutBastionShareableLinkCompleteResult ¶
type PutBastionShareableLinkCompleteResult struct {
}type PutBastionShareableLinkOperationResponse ¶
type PutBastionShareableLinkOperationResponse struct {}