privateendpointconnections

package
v0.20241126.2320 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/eventgrid/2023-12-15-preview/privateendpointconnections Documentation

The privateendpointconnections SDK allows for interaction with Azure Resource Manager eventgrid (API Version 2023-12-15-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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/eventgrid/2023-12-15-preview/privateendpointconnections"

Client Initialization

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

Example Usage: PrivateEndpointConnectionsClient.Delete

ctx := context.TODO()
id := privateendpointconnections.NewScopedPrivateEndpointConnectionID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group", "privateEndpointConnectionName")

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

Example Usage: PrivateEndpointConnectionsClient.Get

ctx := context.TODO()
id := privateendpointconnections.NewScopedPrivateEndpointConnectionID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group", "privateEndpointConnectionName")

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.ListByResource

ctx := context.TODO()
id := commonids.NewScopeID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group")

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

Example Usage: PrivateEndpointConnectionsClient.Update

ctx := context.TODO()
id := privateendpointconnections.NewScopedPrivateEndpointConnectionID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group", "privateEndpointConnectionName")

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


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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForPersistedConnectionStatus 

func PossibleValuesForPersistedConnectionStatus() []string

func PossibleValuesForResourceProvisioningState 

func PossibleValuesForResourceProvisioningState() []string

func ValidateScopedPrivateEndpointConnectionID 

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

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

Types

type ConnectionState 

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

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        *PrivateEndpointConnection
}

type ListByResourceCompleteResult 

type ListByResourceCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []PrivateEndpointConnection
}

type ListByResourceCustomPager 

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

type ListByResourceOperationOptions 

type ListByResourceOperationOptions struct {
	Filter *string
	Top    *int64
}

func DefaultListByResourceOperationOptions 

func DefaultListByResourceOperationOptions() ListByResourceOperationOptions

func (ListByResourceOperationOptions) ToHeaders 

func (o ListByResourceOperationOptions) ToHeaders() *client.Headers

func (ListByResourceOperationOptions) ToOData 

func (o ListByResourceOperationOptions) ToOData() *odata.Query

func (ListByResourceOperationOptions) ToQuery 

func (o ListByResourceOperationOptions) ToQuery() *client.QueryParams

type ListByResourceOperationResponse 

type ListByResourceOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]PrivateEndpointConnection
}

type PersistedConnectionStatus 

type PersistedConnectionStatus string
const (
	PersistedConnectionStatusApproved     PersistedConnectionStatus = "Approved"
	PersistedConnectionStatusDisconnected PersistedConnectionStatus = "Disconnected"
	PersistedConnectionStatusPending      PersistedConnectionStatus = "Pending"
	PersistedConnectionStatusRejected     PersistedConnectionStatus = "Rejected"
)

func (*PersistedConnectionStatus) UnmarshalJSON 

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

type PrivateEndpoint 

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

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 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 {
	GroupIds                          *[]string                  `json:"groupIds,omitempty"`
	PrivateEndpoint                   *PrivateEndpoint           `json:"privateEndpoint,omitempty"`
	PrivateLinkServiceConnectionState *ConnectionState           `json:"privateLinkServiceConnectionState,omitempty"`
	ProvisioningState                 *ResourceProvisioningState `json:"provisioningState,omitempty"`
}

type PrivateEndpointConnectionsClient 

type PrivateEndpointConnectionsClient struct {
	Client *resourcemanager.Client
}

func NewPrivateEndpointConnectionsClientWithBaseURI 

func NewPrivateEndpointConnectionsClientWithBaseURI(sdkApi sdkEnv.Api) (*PrivateEndpointConnectionsClient, error)

func (PrivateEndpointConnectionsClient) Delete 

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

Delete ...

func (PrivateEndpointConnectionsClient) DeleteThenPoll 

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

DeleteThenPoll performs Delete then polls until it's completed

func (PrivateEndpointConnectionsClient) Get 

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

Get ...

func (PrivateEndpointConnectionsClient) ListByResource 

func (c PrivateEndpointConnectionsClient) ListByResource(ctx context.Context, id commonids.ScopeId, options ListByResourceOperationOptions) (result ListByResourceOperationResponse, err error)

ListByResource ...

func (PrivateEndpointConnectionsClient) ListByResourceComplete 

func (c PrivateEndpointConnectionsClient) ListByResourceComplete(ctx context.Context, id commonids.ScopeId, options ListByResourceOperationOptions) (ListByResourceCompleteResult, error)

ListByResourceComplete retrieves all the results into a single object

func (PrivateEndpointConnectionsClient) ListByResourceCompleteMatchingPredicate 

func (c PrivateEndpointConnectionsClient) ListByResourceCompleteMatchingPredicate(ctx context.Context, id commonids.ScopeId, options ListByResourceOperationOptions, predicate PrivateEndpointConnectionOperationPredicate) (result ListByResourceCompleteResult, err error)

ListByResourceCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (PrivateEndpointConnectionsClient) Update 

func (c PrivateEndpointConnectionsClient) Update(ctx context.Context, id ScopedPrivateEndpointConnectionId, input PrivateEndpointConnection) (result UpdateOperationResponse, err error)

Update ...

func (PrivateEndpointConnectionsClient) UpdateThenPoll 

func (c PrivateEndpointConnectionsClient) UpdateThenPoll(ctx context.Context, id ScopedPrivateEndpointConnectionId, input PrivateEndpointConnection) error

UpdateThenPoll performs Update then polls until it's completed

type ResourceProvisioningState 

type ResourceProvisioningState string
const (
	ResourceProvisioningStateCanceled  ResourceProvisioningState = "Canceled"
	ResourceProvisioningStateCreating  ResourceProvisioningState = "Creating"
	ResourceProvisioningStateDeleting  ResourceProvisioningState = "Deleting"
	ResourceProvisioningStateFailed    ResourceProvisioningState = "Failed"
	ResourceProvisioningStateSucceeded ResourceProvisioningState = "Succeeded"
	ResourceProvisioningStateUpdating  ResourceProvisioningState = "Updating"
)

func (*ResourceProvisioningState) UnmarshalJSON 

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

type ScopedPrivateEndpointConnectionId 

type ScopedPrivateEndpointConnectionId struct {
	Scope                         string
	PrivateEndpointConnectionName string
}

ScopedPrivateEndpointConnectionId is a struct representing the Resource ID for a Scoped Private Endpoint Connection

func NewScopedPrivateEndpointConnectionID 

func NewScopedPrivateEndpointConnectionID(scope string, privateEndpointConnectionName string) ScopedPrivateEndpointConnectionId

NewScopedPrivateEndpointConnectionID returns a new ScopedPrivateEndpointConnectionId struct

func ParseScopedPrivateEndpointConnectionID 

func ParseScopedPrivateEndpointConnectionID(input string) (*ScopedPrivateEndpointConnectionId, error)

ParseScopedPrivateEndpointConnectionID parses 'input' into a ScopedPrivateEndpointConnectionId

func ParseScopedPrivateEndpointConnectionIDInsensitively 

func ParseScopedPrivateEndpointConnectionIDInsensitively(input string) (*ScopedPrivateEndpointConnectionId, error)

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

func (*ScopedPrivateEndpointConnectionId) FromParseResult 

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

func (ScopedPrivateEndpointConnectionId) ID 

func (id ScopedPrivateEndpointConnectionId) ID() string

ID returns the formatted Scoped Private Endpoint Connection ID

func (ScopedPrivateEndpointConnectionId) Segments 

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

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

func (ScopedPrivateEndpointConnectionId) String 

func (id ScopedPrivateEndpointConnectionId) String() string

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

type UpdateOperationResponse 

type UpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *PrivateEndpointConnection
}

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.