privateendpoints

package
v0.20240125.1172517 Latest Latest
Warning

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

 Go to latest Published: Jan 25, 2024 License: MPL-2.0 Imports: 12 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/digitaltwins/2023-01-31/privateendpoints Documentation

The privateendpoints SDK allows for interaction with the Azure Resource Manager Service digitaltwins (API Version 2023-01-31).

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/digitaltwins/2023-01-31/privateendpoints"

Client Initialization

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

Example Usage: PrivateEndpointsClient.PrivateEndpointConnectionsCreateOrUpdate

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

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


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

Example Usage: PrivateEndpointsClient.PrivateEndpointConnectionsDelete

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

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

Example Usage: PrivateEndpointsClient.PrivateEndpointConnectionsGet

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

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

Example Usage: PrivateEndpointsClient.PrivateEndpointConnectionsList

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

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

Example Usage: PrivateEndpointsClient.PrivateLinkResourcesGet

ctx := context.TODO()
id := privateendpoints.NewResourceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "digitalTwinsInstanceValue", "/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group")

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

Example Usage: PrivateEndpointsClient.PrivateLinkResourcesList

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

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForConnectionPropertiesProvisioningState 

func PossibleValuesForConnectionPropertiesProvisioningState() []string

func PossibleValuesForPrivateLinkServiceConnectionStatus 

func PossibleValuesForPrivateLinkServiceConnectionStatus() []string

func ValidateDigitalTwinsInstanceID 

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

ValidateDigitalTwinsInstanceID checks that 'input' can be parsed as a Digital Twins Instance ID

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 ValidateResourceID 

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

ValidateResourceID checks that 'input' can be parsed as a Resource ID

Types

type ConnectionProperties 

type ConnectionProperties struct {
	GroupIds                          *[]string                              `json:"groupIds,omitempty"`
	PrivateEndpoint                   *PrivateEndpoint                       `json:"privateEndpoint,omitempty"`
	PrivateLinkServiceConnectionState *ConnectionState                       `json:"privateLinkServiceConnectionState,omitempty"`
	ProvisioningState                 *ConnectionPropertiesProvisioningState `json:"provisioningState,omitempty"`
}

type ConnectionPropertiesProvisioningState 

type ConnectionPropertiesProvisioningState string
const (
	ConnectionPropertiesProvisioningStateApproved     ConnectionPropertiesProvisioningState = "Approved"
	ConnectionPropertiesProvisioningStateDisconnected ConnectionPropertiesProvisioningState = "Disconnected"
	ConnectionPropertiesProvisioningStatePending      ConnectionPropertiesProvisioningState = "Pending"
	ConnectionPropertiesProvisioningStateRejected     ConnectionPropertiesProvisioningState = "Rejected"
)

func (*ConnectionPropertiesProvisioningState) UnmarshalJSON 

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

type ConnectionState 

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

type DigitalTwinsInstanceId 

type DigitalTwinsInstanceId struct {
	SubscriptionId           string
	ResourceGroupName        string
	DigitalTwinsInstanceName string
}

DigitalTwinsInstanceId is a struct representing the Resource ID for a Digital Twins Instance

func NewDigitalTwinsInstanceID 

func NewDigitalTwinsInstanceID(subscriptionId string, resourceGroupName string, digitalTwinsInstanceName string) DigitalTwinsInstanceId

NewDigitalTwinsInstanceID returns a new DigitalTwinsInstanceId struct

func ParseDigitalTwinsInstanceID 

func ParseDigitalTwinsInstanceID(input string) (*DigitalTwinsInstanceId, error)

ParseDigitalTwinsInstanceID parses 'input' into a DigitalTwinsInstanceId

func ParseDigitalTwinsInstanceIDInsensitively 

func ParseDigitalTwinsInstanceIDInsensitively(input string) (*DigitalTwinsInstanceId, error)

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

func (*DigitalTwinsInstanceId) FromParseResult 

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

func (DigitalTwinsInstanceId) ID 

func (id DigitalTwinsInstanceId) ID() string

ID returns the formatted Digital Twins Instance ID

func (DigitalTwinsInstanceId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Digital Twins Instance ID

func (DigitalTwinsInstanceId) String 

func (id DigitalTwinsInstanceId) String() string

String returns a human-readable description of this Digital Twins Instance ID

type GroupIdInformation 

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

type GroupIdInformationProperties 

type GroupIdInformationProperties struct {
	GroupId           *string   `json:"groupId,omitempty"`
	RequiredMembers   *[]string `json:"requiredMembers,omitempty"`
	RequiredZoneNames *[]string `json:"requiredZoneNames,omitempty"`
}

type GroupIdInformationResponse 

type GroupIdInformationResponse struct {
	Value *[]GroupIdInformation `json:"value,omitempty"`
}

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 ConnectionProperties   `json:"properties"`
	SystemData *systemdata.SystemData `json:"systemData,omitempty"`
	Type       *string                `json:"type,omitempty"`
}

type PrivateEndpointConnectionId 

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

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

func NewPrivateEndpointConnectionID 

func NewPrivateEndpointConnectionID(subscriptionId string, resourceGroupName string, digitalTwinsInstanceName 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 

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 PrivateEndpointConnectionsCreateOrUpdateOperationResponse 

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

type PrivateEndpointConnectionsDeleteOperationResponse 

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

type PrivateEndpointConnectionsGetOperationResponse 

type PrivateEndpointConnectionsGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *PrivateEndpointConnection
}

type PrivateEndpointConnectionsListOperationResponse 

type PrivateEndpointConnectionsListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *PrivateEndpointConnectionsResponse
}

type PrivateEndpointConnectionsResponse 

type PrivateEndpointConnectionsResponse struct {
	Value *[]PrivateEndpointConnection `json:"value,omitempty"`
}

type PrivateEndpointsClient 

type PrivateEndpointsClient struct {
	Client *resourcemanager.Client
}

func NewPrivateEndpointsClientWithBaseURI 

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

func (PrivateEndpointsClient) PrivateEndpointConnectionsCreateOrUpdate 

func (c PrivateEndpointsClient) PrivateEndpointConnectionsCreateOrUpdate(ctx context.Context, id PrivateEndpointConnectionId, input PrivateEndpointConnection) (result PrivateEndpointConnectionsCreateOrUpdateOperationResponse, err error)

PrivateEndpointConnectionsCreateOrUpdate ...

func (PrivateEndpointsClient) PrivateEndpointConnectionsCreateOrUpdateThenPoll 

func (c PrivateEndpointsClient) PrivateEndpointConnectionsCreateOrUpdateThenPoll(ctx context.Context, id PrivateEndpointConnectionId, input PrivateEndpointConnection) error

PrivateEndpointConnectionsCreateOrUpdateThenPoll performs PrivateEndpointConnectionsCreateOrUpdate then polls until it's completed

func (PrivateEndpointsClient) PrivateEndpointConnectionsDelete 

func (c PrivateEndpointsClient) PrivateEndpointConnectionsDelete(ctx context.Context, id PrivateEndpointConnectionId) (result PrivateEndpointConnectionsDeleteOperationResponse, err error)

PrivateEndpointConnectionsDelete ...

func (PrivateEndpointsClient) PrivateEndpointConnectionsDeleteThenPoll 

func (c PrivateEndpointsClient) PrivateEndpointConnectionsDeleteThenPoll(ctx context.Context, id PrivateEndpointConnectionId) error

PrivateEndpointConnectionsDeleteThenPoll performs PrivateEndpointConnectionsDelete then polls until it's completed

func (PrivateEndpointsClient) PrivateEndpointConnectionsGet 

func (c PrivateEndpointsClient) PrivateEndpointConnectionsGet(ctx context.Context, id PrivateEndpointConnectionId) (result PrivateEndpointConnectionsGetOperationResponse, err error)

PrivateEndpointConnectionsGet ...

func (PrivateEndpointsClient) PrivateEndpointConnectionsList 

func (c PrivateEndpointsClient) PrivateEndpointConnectionsList(ctx context.Context, id DigitalTwinsInstanceId) (result PrivateEndpointConnectionsListOperationResponse, err error)

PrivateEndpointConnectionsList ...

func (PrivateEndpointsClient) PrivateLinkResourcesGet 

func (c PrivateEndpointsClient) PrivateLinkResourcesGet(ctx context.Context, id ResourceId) (result PrivateLinkResourcesGetOperationResponse, err error)

PrivateLinkResourcesGet ...

func (PrivateEndpointsClient) PrivateLinkResourcesList 

func (c PrivateEndpointsClient) PrivateLinkResourcesList(ctx context.Context, id DigitalTwinsInstanceId) (result PrivateLinkResourcesListOperationResponse, err error)

PrivateLinkResourcesList ...

type PrivateLinkResourcesGetOperationResponse 

type PrivateLinkResourcesGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *GroupIdInformation
}

type PrivateLinkResourcesListOperationResponse 

type PrivateLinkResourcesListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *GroupIdInformationResponse
}

type PrivateLinkServiceConnectionStatus 

type PrivateLinkServiceConnectionStatus string
const (
	PrivateLinkServiceConnectionStatusApproved     PrivateLinkServiceConnectionStatus = "Approved"
	PrivateLinkServiceConnectionStatusDisconnected PrivateLinkServiceConnectionStatus = "Disconnected"
	PrivateLinkServiceConnectionStatusPending      PrivateLinkServiceConnectionStatus = "Pending"
	PrivateLinkServiceConnectionStatusRejected     PrivateLinkServiceConnectionStatus = "Rejected"
)

func (*PrivateLinkServiceConnectionStatus) UnmarshalJSON 

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

type ResourceId 

type ResourceId struct {
	SubscriptionId           string
	ResourceGroupName        string
	DigitalTwinsInstanceName string
	ResourceId               string
}

ResourceId is a struct representing the Resource ID for a Resource

func NewResourceID 

func NewResourceID(subscriptionId string, resourceGroupName string, digitalTwinsInstanceName string, resourceId string) ResourceId

NewResourceID returns a new ResourceId struct

func ParseResourceID 

func ParseResourceID(input string) (*ResourceId, error)

ParseResourceID parses 'input' into a ResourceId

func ParseResourceIDInsensitively 

func ParseResourceIDInsensitively(input string) (*ResourceId, error)

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

func (*ResourceId) FromParseResult 

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

func (ResourceId) ID 

func (id ResourceId) ID() string

ID returns the formatted Resource ID

func (ResourceId) Segments 

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

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

func (ResourceId) String 

func (id ResourceId) String() string

String returns a human-readable description of this Resource ID

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.