privateendpoints

package
v0.20241104.1140654 Latest Latest
Warning

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

 Go to latest Published: Nov 4, 2024 License: MPL-2.0 Imports: 11 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/streamanalytics/2020-03-01/privateendpoints Documentation

The privateendpoints SDK allows for interaction with Azure Resource Manager streamanalytics (API Version 2020-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/streamanalytics/2020-03-01/privateendpoints"

Client Initialization

client := privateendpoints.NewPrivateEndpointsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: PrivateEndpointsClient.CreateOrUpdate

ctx := context.TODO()
id := privateendpoints.NewPrivateEndpointID("12345678-1234-9876-4563-123456789012", "example-resource-group", "clusterName", "privateEndpointName")

payload := privateendpoints.PrivateEndpoint{
	// ...
}


read, err := client.CreateOrUpdate(ctx, id, payload, privateendpoints.DefaultCreateOrUpdateOperationOptions())
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: PrivateEndpointsClient.Delete

ctx := context.TODO()
id := privateendpoints.NewPrivateEndpointID("12345678-1234-9876-4563-123456789012", "example-resource-group", "clusterName", "privateEndpointName")

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

Example Usage: PrivateEndpointsClient.Get

ctx := context.TODO()
id := privateendpoints.NewPrivateEndpointID("12345678-1234-9876-4563-123456789012", "example-resource-group", "clusterName", "privateEndpointName")

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: PrivateEndpointsClient.ListByCluster

ctx := context.TODO()
id := privateendpoints.NewClusterID("12345678-1234-9876-4563-123456789012", "example-resource-group", "clusterName")

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

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

ValidateClusterID checks that 'input' can be parsed as a Cluster ID

func ValidatePrivateEndpointID 

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

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

Types

type ClusterId 

type ClusterId struct {
	SubscriptionId    string
	ResourceGroupName string
	ClusterName       string
}

ClusterId is a struct representing the Resource ID for a Cluster

func NewClusterID 

func NewClusterID(subscriptionId string, resourceGroupName string, clusterName string) ClusterId

NewClusterID returns a new ClusterId struct

func ParseClusterID 

func ParseClusterID(input string) (*ClusterId, error)

ParseClusterID parses 'input' into a ClusterId

func ParseClusterIDInsensitively 

func ParseClusterIDInsensitively(input string) (*ClusterId, error)

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

func (*ClusterId) FromParseResult 

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

func (ClusterId) ID 

func (id ClusterId) ID() string

ID returns the formatted Cluster ID

func (ClusterId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Cluster ID

func (ClusterId) String 

func (id ClusterId) String() string

String returns a human-readable description of this Cluster ID

type CreateOrUpdateOperationOptions 

type CreateOrUpdateOperationOptions struct {
	IfMatch     *string
	IfNoneMatch *string
}

func DefaultCreateOrUpdateOperationOptions 

func DefaultCreateOrUpdateOperationOptions() CreateOrUpdateOperationOptions

func (CreateOrUpdateOperationOptions) ToHeaders added in v0.20240208.1095436 

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

func (CreateOrUpdateOperationOptions) ToOData added in v0.20240208.1095436 

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

func (CreateOrUpdateOperationOptions) ToQuery added in v0.20240208.1095436 

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

type CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *PrivateEndpoint
}

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

type ListByClusterCompleteResult 

type ListByClusterCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []PrivateEndpoint
}

type ListByClusterCustomPager added in v0.20240628.1153531 

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

type ListByClusterOperationResponse 

type ListByClusterOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]PrivateEndpoint
}

type PrivateEndpoint 

type PrivateEndpoint struct {
	Etag       *string                    `json:"etag,omitempty"`
	Id         *string                    `json:"id,omitempty"`
	Name       *string                    `json:"name,omitempty"`
	Properties *PrivateEndpointProperties `json:"properties,omitempty"`
	Type       *string                    `json:"type,omitempty"`
}

type PrivateEndpointId 

type PrivateEndpointId struct {
	SubscriptionId      string
	ResourceGroupName   string
	ClusterName         string
	PrivateEndpointName string
}

PrivateEndpointId is a struct representing the Resource ID for a Private Endpoint

func NewPrivateEndpointID 

func NewPrivateEndpointID(subscriptionId string, resourceGroupName string, clusterName string, privateEndpointName string) PrivateEndpointId

NewPrivateEndpointID returns a new PrivateEndpointId struct

func ParsePrivateEndpointID 

func ParsePrivateEndpointID(input string) (*PrivateEndpointId, error)

ParsePrivateEndpointID parses 'input' into a PrivateEndpointId

func ParsePrivateEndpointIDInsensitively 

func ParsePrivateEndpointIDInsensitively(input string) (*PrivateEndpointId, error)

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

func (*PrivateEndpointId) FromParseResult 

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

func (PrivateEndpointId) ID 

func (id PrivateEndpointId) ID() string

ID returns the formatted Private Endpoint ID

func (PrivateEndpointId) Segments 

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

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

func (PrivateEndpointId) String 

func (id PrivateEndpointId) String() string

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

type PrivateEndpointOperationPredicate 

type PrivateEndpointOperationPredicate struct {
	Etag *string
	Id   *string
	Name *string
	Type *string
}

func (PrivateEndpointOperationPredicate) Matches 

func (p PrivateEndpointOperationPredicate) Matches(input PrivateEndpoint) bool

type PrivateEndpointProperties 

type PrivateEndpointProperties struct {
	CreatedDate                         *string                         `json:"createdDate,omitempty"`
	ManualPrivateLinkServiceConnections *[]PrivateLinkServiceConnection `json:"manualPrivateLinkServiceConnections,omitempty"`
}

type PrivateEndpointsClient 

type PrivateEndpointsClient struct {
	Client *resourcemanager.Client
}

func NewPrivateEndpointsClientWithBaseURI 

func NewPrivateEndpointsClientWithBaseURI(sdkApi sdkEnv.Api) (*PrivateEndpointsClient, error)

func (PrivateEndpointsClient) CreateOrUpdate 

func (c PrivateEndpointsClient) CreateOrUpdate(ctx context.Context, id PrivateEndpointId, input PrivateEndpoint, options CreateOrUpdateOperationOptions) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (PrivateEndpointsClient) Delete 

func (c PrivateEndpointsClient) Delete(ctx context.Context, id PrivateEndpointId) (result DeleteOperationResponse, err error)

Delete ...

func (PrivateEndpointsClient) DeleteThenPoll 

func (c PrivateEndpointsClient) DeleteThenPoll(ctx context.Context, id PrivateEndpointId) error

DeleteThenPoll performs Delete then polls until it's completed

func (PrivateEndpointsClient) Get 

func (c PrivateEndpointsClient) Get(ctx context.Context, id PrivateEndpointId) (result GetOperationResponse, err error)

Get ...

func (PrivateEndpointsClient) ListByCluster 

func (c PrivateEndpointsClient) ListByCluster(ctx context.Context, id ClusterId) (result ListByClusterOperationResponse, err error)

ListByCluster ...

func (PrivateEndpointsClient) ListByClusterComplete 

func (c PrivateEndpointsClient) ListByClusterComplete(ctx context.Context, id ClusterId) (ListByClusterCompleteResult, error)

ListByClusterComplete retrieves all the results into a single object

func (PrivateEndpointsClient) ListByClusterCompleteMatchingPredicate 

func (c PrivateEndpointsClient) ListByClusterCompleteMatchingPredicate(ctx context.Context, id ClusterId, predicate PrivateEndpointOperationPredicate) (result ListByClusterCompleteResult, err error)

ListByClusterCompleteMatchingPredicate retrieves all the results and then applies the predicate

type PrivateLinkConnectionState 

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

type PrivateLinkServiceConnection 

type PrivateLinkServiceConnection struct {
	Properties *PrivateLinkServiceConnectionProperties `json:"properties,omitempty"`
}

type PrivateLinkServiceConnectionProperties 

type PrivateLinkServiceConnectionProperties struct {
	GroupIds                          *[]string                   `json:"groupIds,omitempty"`
	PrivateLinkServiceConnectionState *PrivateLinkConnectionState `json:"privateLinkServiceConnectionState,omitempty"`
	PrivateLinkServiceId              *string                     `json:"privateLinkServiceId,omitempty"`
	RequestMessage                    *string                     `json:"requestMessage,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.