privateendpointconnections

package
v0.20231214.1160726 Latest Latest
Warning

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

 Go to latest Published: Dec 14, 2023 License: MPL-2.0 Imports: 9 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/insights/2019-10-17-preview/privateendpointconnections Documentation

The privateendpointconnections SDK allows for interaction with the Azure Resource Manager Service insights (API Version 2019-10-17-preview).

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/insights/2019-10-17-preview/privateendpointconnections"

Client Initialization

client := privateendpointconnections.NewPrivateEndpointConnectionsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: PrivateEndpointConnectionsClient.CreateOrUpdate

ctx := context.TODO()
id := privateendpointconnections.NewPrivateEndpointConnectionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "privateLinkScopeValue", "privateEndpointConnectionValue")

payload := privateendpointconnections.PrivateEndpointConnection{
	// ...
}


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

Example Usage: PrivateEndpointConnectionsClient.Delete

ctx := context.TODO()
id := privateendpointconnections.NewPrivateEndpointConnectionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "privateLinkScopeValue", "privateEndpointConnectionValue")

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

Example Usage: PrivateEndpointConnectionsClient.Get

ctx := context.TODO()
id := privateendpointconnections.NewPrivateEndpointConnectionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "privateLinkScopeValue", "privateEndpointConnectionValue")

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: PrivateEndpointConnectionsClient.ListByPrivateLinkScope

ctx := context.TODO()
id := privateendpointconnections.NewPrivateLinkScopeID("12345678-1234-9876-4563-123456789012", "example-resource-group", "privateLinkScopeValue")

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

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

ValidatePrivateEndpointConnectionID checks that 'input' can be parsed as a Private Endpoint Connection ID

func ValidatePrivateLinkScopeID 

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

ValidatePrivateLinkScopeID checks that 'input' can be parsed as a Private Link Scope ID

Types

type CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	Poller       polling.LongRunningPoller
	HttpResponse *http.Response
}

type DeleteOperationResponse 

type DeleteOperationResponse struct {
	Poller       polling.LongRunningPoller
	HttpResponse *http.Response
}

type GetOperationResponse 

type GetOperationResponse struct {
	HttpResponse *http.Response
	Model        *PrivateEndpointConnection
}

type ListByPrivateLinkScopeCompleteResult 

type ListByPrivateLinkScopeCompleteResult struct {
	Items []PrivateEndpointConnection
}

type ListByPrivateLinkScopeOperationResponse 

type ListByPrivateLinkScopeOperationResponse struct {
	HttpResponse *http.Response
	Model        *[]PrivateEndpointConnection
	// contains filtered or unexported fields
}

func (ListByPrivateLinkScopeOperationResponse) HasMore 

func (r ListByPrivateLinkScopeOperationResponse) HasMore() bool

func (ListByPrivateLinkScopeOperationResponse) LoadMore 

func (r ListByPrivateLinkScopeOperationResponse) LoadMore(ctx context.Context) (resp ListByPrivateLinkScopeOperationResponse, err error)

type PrivateEndpointConnection 

type PrivateEndpointConnection struct {
	Id         *string                              `json:"id,omitempty"`
	Name       *string                              `json:"name,omitempty"`
	Properties *PrivateEndpointConnectionProperties `json:"properties,omitempty"`
	Type       *string                              `json:"type,omitempty"`
}

type PrivateEndpointConnectionId 

type PrivateEndpointConnectionId struct {
	SubscriptionId                string
	ResourceGroupName             string
	PrivateLinkScopeName          string
	PrivateEndpointConnectionName string
}

PrivateEndpointConnectionId is a struct representing the Resource ID for a Private Endpoint Connection

func NewPrivateEndpointConnectionID 

func NewPrivateEndpointConnectionID(subscriptionId string, resourceGroupName string, privateLinkScopeName string, privateEndpointConnectionName string) PrivateEndpointConnectionId

NewPrivateEndpointConnectionID returns a new PrivateEndpointConnectionId struct

func ParsePrivateEndpointConnectionID 

func ParsePrivateEndpointConnectionID(input string) (*PrivateEndpointConnectionId, error)

ParsePrivateEndpointConnectionID parses 'input' into a PrivateEndpointConnectionId

func ParsePrivateEndpointConnectionIDInsensitively 

func ParsePrivateEndpointConnectionIDInsensitively(input string) (*PrivateEndpointConnectionId, error)

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

func (*PrivateEndpointConnectionId) FromParseResult added in v0.20231127.1171502 

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

func (PrivateEndpointConnectionId) ID 

func (id PrivateEndpointConnectionId) ID() string

ID returns the formatted Private Endpoint Connection ID

func (PrivateEndpointConnectionId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Private Endpoint Connection ID

func (PrivateEndpointConnectionId) String 

func (id PrivateEndpointConnectionId) String() string

String returns a human-readable description of this Private Endpoint Connection ID

type PrivateEndpointConnectionOperationPredicate 

type PrivateEndpointConnectionOperationPredicate struct {
	Id   *string
	Name *string
	Type *string
}

func (PrivateEndpointConnectionOperationPredicate) Matches 

func (p PrivateEndpointConnectionOperationPredicate) Matches(input PrivateEndpointConnection) bool

type PrivateEndpointConnectionProperties 

type PrivateEndpointConnectionProperties struct {
	PrivateEndpoint                   *PrivateEndpointProperty                   `json:"privateEndpoint,omitempty"`
	PrivateLinkServiceConnectionState *PrivateLinkServiceConnectionStateProperty `json:"privateLinkServiceConnectionState,omitempty"`
	ProvisioningState                 *string                                    `json:"provisioningState,omitempty"`
}

type PrivateEndpointConnectionsClient 

type PrivateEndpointConnectionsClient struct {
	Client autorest.Client
	// contains filtered or unexported fields
}

func NewPrivateEndpointConnectionsClientWithBaseURI 

func NewPrivateEndpointConnectionsClientWithBaseURI(endpoint string) PrivateEndpointConnectionsClient

func (PrivateEndpointConnectionsClient) CreateOrUpdate 

func (c PrivateEndpointConnectionsClient) CreateOrUpdate(ctx context.Context, id PrivateEndpointConnectionId, input PrivateEndpointConnection) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (PrivateEndpointConnectionsClient) CreateOrUpdateThenPoll 

func (c PrivateEndpointConnectionsClient) CreateOrUpdateThenPoll(ctx context.Context, id PrivateEndpointConnectionId, input PrivateEndpointConnection) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (PrivateEndpointConnectionsClient) Delete 

func (c PrivateEndpointConnectionsClient) Delete(ctx context.Context, id PrivateEndpointConnectionId) (result DeleteOperationResponse, err error)

Delete ...

func (PrivateEndpointConnectionsClient) DeleteThenPoll 

func (c PrivateEndpointConnectionsClient) DeleteThenPoll(ctx context.Context, id PrivateEndpointConnectionId) error

DeleteThenPoll performs Delete then polls until it's completed

func (PrivateEndpointConnectionsClient) Get 

func (c PrivateEndpointConnectionsClient) Get(ctx context.Context, id PrivateEndpointConnectionId) (result GetOperationResponse, err error)

Get ...

func (PrivateEndpointConnectionsClient) ListByPrivateLinkScope 

func (c PrivateEndpointConnectionsClient) ListByPrivateLinkScope(ctx context.Context, id PrivateLinkScopeId) (resp ListByPrivateLinkScopeOperationResponse, err error)

ListByPrivateLinkScope ...

func (PrivateEndpointConnectionsClient) ListByPrivateLinkScopeComplete 

func (c PrivateEndpointConnectionsClient) ListByPrivateLinkScopeComplete(ctx context.Context, id PrivateLinkScopeId) (ListByPrivateLinkScopeCompleteResult, error)

ListByPrivateLinkScopeComplete retrieves all of the results into a single object

func (PrivateEndpointConnectionsClient) ListByPrivateLinkScopeCompleteMatchingPredicate 

func (c PrivateEndpointConnectionsClient) ListByPrivateLinkScopeCompleteMatchingPredicate(ctx context.Context, id PrivateLinkScopeId, predicate PrivateEndpointConnectionOperationPredicate) (resp ListByPrivateLinkScopeCompleteResult, err error)

ListByPrivateLinkScopeCompleteMatchingPredicate retrieves all of the results and then applied the predicate

type PrivateEndpointProperty 

type PrivateEndpointProperty struct {
	Id *string `json:"id,omitempty"`
}

type PrivateLinkScopeId 

type PrivateLinkScopeId struct {
	SubscriptionId       string
	ResourceGroupName    string
	PrivateLinkScopeName string
}

PrivateLinkScopeId is a struct representing the Resource ID for a Private Link Scope

func NewPrivateLinkScopeID 

func NewPrivateLinkScopeID(subscriptionId string, resourceGroupName string, privateLinkScopeName string) PrivateLinkScopeId

NewPrivateLinkScopeID returns a new PrivateLinkScopeId struct

func ParsePrivateLinkScopeID 

func ParsePrivateLinkScopeID(input string) (*PrivateLinkScopeId, error)

ParsePrivateLinkScopeID parses 'input' into a PrivateLinkScopeId

func ParsePrivateLinkScopeIDInsensitively 

func ParsePrivateLinkScopeIDInsensitively(input string) (*PrivateLinkScopeId, error)

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

func (*PrivateLinkScopeId) FromParseResult added in v0.20231127.1171502 

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

func (PrivateLinkScopeId) ID 

func (id PrivateLinkScopeId) ID() string

ID returns the formatted Private Link Scope ID

func (PrivateLinkScopeId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Private Link Scope ID

func (PrivateLinkScopeId) String 

func (id PrivateLinkScopeId) String() string

String returns a human-readable description of this Private Link Scope ID

type PrivateLinkServiceConnectionStateProperty 

type PrivateLinkServiceConnectionStateProperty struct {
	ActionsRequired *string `json:"actionsRequired,omitempty"`
	Description     string  `json:"description"`
	Status          string  `json:"status"`
}

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.