endpoints

package
v0.20230712.1163130 Latest Latest
Warning

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

 Go to latest Published: Jul 12, 2023 License: MPL-2.0 Imports: 14 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/digitaltwins/2022-10-31/endpoints Documentation

The endpoints SDK allows for interaction with the Azure Resource Manager Service digitaltwins (API Version 2022-10-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/2022-10-31/endpoints"

Client Initialization

client := endpoints.NewEndpointsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: EndpointsClient.DigitalTwinsEndpointCreateOrUpdate

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

payload := endpoints.DigitalTwinsEndpointResource{
	// ...
}


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

Example Usage: EndpointsClient.DigitalTwinsEndpointDelete

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

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

Example Usage: EndpointsClient.DigitalTwinsEndpointGet

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

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

Example Usage: EndpointsClient.DigitalTwinsEndpointList

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

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

func PossibleValuesForAuthenticationType() []string

func PossibleValuesForEndpointProvisioningState 

func PossibleValuesForEndpointProvisioningState() []string

func PossibleValuesForEndpointType 

func PossibleValuesForEndpointType() []string

func PossibleValuesForIdentityType 

func PossibleValuesForIdentityType() []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 ValidateEndpointID 

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

ValidateEndpointID checks that 'input' can be parsed as a Endpoint ID

Types

type AuthenticationType 

type AuthenticationType string
const (
	AuthenticationTypeIdentityBased AuthenticationType = "IdentityBased"
	AuthenticationTypeKeyBased      AuthenticationType = "KeyBased"
)

func (*AuthenticationType) UnmarshalJSON added in v0.20230420.1093529 

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

type DigitalTwinsEndpointCreateOrUpdateOperationResponse 

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

type DigitalTwinsEndpointDeleteOperationResponse 

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

type DigitalTwinsEndpointGetOperationResponse 

type DigitalTwinsEndpointGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *DigitalTwinsEndpointResource
}

type DigitalTwinsEndpointListCompleteResult 

type DigitalTwinsEndpointListCompleteResult struct {
	Items []DigitalTwinsEndpointResource
}

type DigitalTwinsEndpointListOperationResponse 

type DigitalTwinsEndpointListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]DigitalTwinsEndpointResource
}

type DigitalTwinsEndpointResource 

type DigitalTwinsEndpointResource struct {
	Id         *string                                `json:"id,omitempty"`
	Name       *string                                `json:"name,omitempty"`
	Properties DigitalTwinsEndpointResourceProperties `json:"properties"`
	SystemData *systemdata.SystemData                 `json:"systemData,omitempty"`
	Type       *string                                `json:"type,omitempty"`
}

func (*DigitalTwinsEndpointResource) UnmarshalJSON 

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

type DigitalTwinsEndpointResourceOperationPredicate 

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

func (DigitalTwinsEndpointResourceOperationPredicate) Matches 

func (p DigitalTwinsEndpointResourceOperationPredicate) Matches(input DigitalTwinsEndpointResource) bool

type DigitalTwinsEndpointResourceProperties 

type DigitalTwinsEndpointResourceProperties interface {
}

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) 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 EndpointId 

type EndpointId struct {
	SubscriptionId           string
	ResourceGroupName        string
	DigitalTwinsInstanceName string
	EndpointName             string
}

EndpointId is a struct representing the Resource ID for a Endpoint

func NewEndpointID 

func NewEndpointID(subscriptionId string, resourceGroupName string, digitalTwinsInstanceName string, endpointName string) EndpointId

NewEndpointID returns a new EndpointId struct

func ParseEndpointID 

func ParseEndpointID(input string) (*EndpointId, error)

ParseEndpointID parses 'input' into a EndpointId

func ParseEndpointIDInsensitively 

func ParseEndpointIDInsensitively(input string) (*EndpointId, error)

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

func (EndpointId) ID 

func (id EndpointId) ID() string

ID returns the formatted Endpoint ID

func (EndpointId) Segments 

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

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

func (EndpointId) String 

func (id EndpointId) String() string

String returns a human-readable description of this Endpoint ID

type EndpointProvisioningState 

type EndpointProvisioningState string
const (
	EndpointProvisioningStateCanceled     EndpointProvisioningState = "Canceled"
	EndpointProvisioningStateDeleted      EndpointProvisioningState = "Deleted"
	EndpointProvisioningStateDeleting     EndpointProvisioningState = "Deleting"
	EndpointProvisioningStateDisabled     EndpointProvisioningState = "Disabled"
	EndpointProvisioningStateFailed       EndpointProvisioningState = "Failed"
	EndpointProvisioningStateMoving       EndpointProvisioningState = "Moving"
	EndpointProvisioningStateProvisioning EndpointProvisioningState = "Provisioning"
	EndpointProvisioningStateRestoring    EndpointProvisioningState = "Restoring"
	EndpointProvisioningStateSucceeded    EndpointProvisioningState = "Succeeded"
	EndpointProvisioningStateSuspending   EndpointProvisioningState = "Suspending"
	EndpointProvisioningStateUpdating     EndpointProvisioningState = "Updating"
	EndpointProvisioningStateWarning      EndpointProvisioningState = "Warning"
)

func (*EndpointProvisioningState) UnmarshalJSON added in v0.20230420.1093529 

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

type EndpointType 

type EndpointType string
const (
	EndpointTypeEventGrid  EndpointType = "EventGrid"
	EndpointTypeEventHub   EndpointType = "EventHub"
	EndpointTypeServiceBus EndpointType = "ServiceBus"
)

func (*EndpointType) UnmarshalJSON added in v0.20230420.1093529 

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

type EndpointsClient 

type EndpointsClient struct {
	Client *resourcemanager.Client
}

func NewEndpointsClientWithBaseURI 

func NewEndpointsClientWithBaseURI(api environments.Api) (*EndpointsClient, error)

func (EndpointsClient) DigitalTwinsEndpointCreateOrUpdate 

func (c EndpointsClient) DigitalTwinsEndpointCreateOrUpdate(ctx context.Context, id EndpointId, input DigitalTwinsEndpointResource) (result DigitalTwinsEndpointCreateOrUpdateOperationResponse, err error)

DigitalTwinsEndpointCreateOrUpdate ...

func (EndpointsClient) DigitalTwinsEndpointCreateOrUpdateThenPoll 

func (c EndpointsClient) DigitalTwinsEndpointCreateOrUpdateThenPoll(ctx context.Context, id EndpointId, input DigitalTwinsEndpointResource) error

DigitalTwinsEndpointCreateOrUpdateThenPoll performs DigitalTwinsEndpointCreateOrUpdate then polls until it's completed

func (EndpointsClient) DigitalTwinsEndpointDelete 

func (c EndpointsClient) DigitalTwinsEndpointDelete(ctx context.Context, id EndpointId) (result DigitalTwinsEndpointDeleteOperationResponse, err error)

DigitalTwinsEndpointDelete ...

func (EndpointsClient) DigitalTwinsEndpointDeleteThenPoll 

func (c EndpointsClient) DigitalTwinsEndpointDeleteThenPoll(ctx context.Context, id EndpointId) error

DigitalTwinsEndpointDeleteThenPoll performs DigitalTwinsEndpointDelete then polls until it's completed

func (EndpointsClient) DigitalTwinsEndpointGet 

func (c EndpointsClient) DigitalTwinsEndpointGet(ctx context.Context, id EndpointId) (result DigitalTwinsEndpointGetOperationResponse, err error)

DigitalTwinsEndpointGet ...

func (EndpointsClient) DigitalTwinsEndpointList 

func (c EndpointsClient) DigitalTwinsEndpointList(ctx context.Context, id DigitalTwinsInstanceId) (result DigitalTwinsEndpointListOperationResponse, err error)

DigitalTwinsEndpointList ...

func (EndpointsClient) DigitalTwinsEndpointListComplete 

func (c EndpointsClient) DigitalTwinsEndpointListComplete(ctx context.Context, id DigitalTwinsInstanceId) (DigitalTwinsEndpointListCompleteResult, error)

DigitalTwinsEndpointListComplete retrieves all the results into a single object

func (EndpointsClient) DigitalTwinsEndpointListCompleteMatchingPredicate 

func (c EndpointsClient) DigitalTwinsEndpointListCompleteMatchingPredicate(ctx context.Context, id DigitalTwinsInstanceId, predicate DigitalTwinsEndpointResourceOperationPredicate) (result DigitalTwinsEndpointListCompleteResult, err error)

DigitalTwinsEndpointListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type EventGrid 

type EventGrid struct {
	AccessKey1    string  `json:"accessKey1"`
	AccessKey2    *string `json:"accessKey2,omitempty"`
	TopicEndpoint string  `json:"TopicEndpoint"`

	// Fields inherited from DigitalTwinsEndpointResourceProperties
	AuthenticationType *AuthenticationType        `json:"authenticationType,omitempty"`
	CreatedTime        *string                    `json:"createdTime,omitempty"`
	DeadLetterSecret   *string                    `json:"deadLetterSecret,omitempty"`
	DeadLetterUri      *string                    `json:"deadLetterUri,omitempty"`
	Identity           *ManagedIdentityReference  `json:"identity,omitempty"`
	ProvisioningState  *EndpointProvisioningState `json:"provisioningState,omitempty"`
}

func (*EventGrid) GetCreatedTimeAsTime 

func (o *EventGrid) GetCreatedTimeAsTime() (*time.Time, error)

func (EventGrid) MarshalJSON 

func (s EventGrid) MarshalJSON() ([]byte, error)

func (*EventGrid) SetCreatedTimeAsTime 

func (o *EventGrid) SetCreatedTimeAsTime(input time.Time)

type EventHub 

type EventHub struct {
	ConnectionStringPrimaryKey   *string `json:"connectionStringPrimaryKey,omitempty"`
	ConnectionStringSecondaryKey *string `json:"connectionStringSecondaryKey,omitempty"`
	EndpointUri                  *string `json:"endpointUri,omitempty"`
	EntityPath                   *string `json:"entityPath,omitempty"`

	// Fields inherited from DigitalTwinsEndpointResourceProperties
	AuthenticationType *AuthenticationType        `json:"authenticationType,omitempty"`
	CreatedTime        *string                    `json:"createdTime,omitempty"`
	DeadLetterSecret   *string                    `json:"deadLetterSecret,omitempty"`
	DeadLetterUri      *string                    `json:"deadLetterUri,omitempty"`
	Identity           *ManagedIdentityReference  `json:"identity,omitempty"`
	ProvisioningState  *EndpointProvisioningState `json:"provisioningState,omitempty"`
}

func (*EventHub) GetCreatedTimeAsTime 

func (o *EventHub) GetCreatedTimeAsTime() (*time.Time, error)

func (EventHub) MarshalJSON 

func (s EventHub) MarshalJSON() ([]byte, error)

func (*EventHub) SetCreatedTimeAsTime 

func (o *EventHub) SetCreatedTimeAsTime(input time.Time)

type IdentityType 

type IdentityType string
const (
	IdentityTypeSystemAssigned IdentityType = "SystemAssigned"
	IdentityTypeUserAssigned   IdentityType = "UserAssigned"
)

func (*IdentityType) UnmarshalJSON added in v0.20230420.1093529 

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

type ManagedIdentityReference 

type ManagedIdentityReference struct {
	Type                 *IdentityType `json:"type,omitempty"`
	UserAssignedIdentity *string       `json:"userAssignedIdentity,omitempty"`
}

type ServiceBus 

type ServiceBus struct {
	EndpointUri               *string `json:"endpointUri,omitempty"`
	EntityPath                *string `json:"entityPath,omitempty"`
	PrimaryConnectionString   *string `json:"primaryConnectionString,omitempty"`
	SecondaryConnectionString *string `json:"secondaryConnectionString,omitempty"`

	// Fields inherited from DigitalTwinsEndpointResourceProperties
	AuthenticationType *AuthenticationType        `json:"authenticationType,omitempty"`
	CreatedTime        *string                    `json:"createdTime,omitempty"`
	DeadLetterSecret   *string                    `json:"deadLetterSecret,omitempty"`
	DeadLetterUri      *string                    `json:"deadLetterUri,omitempty"`
	Identity           *ManagedIdentityReference  `json:"identity,omitempty"`
	ProvisioningState  *EndpointProvisioningState `json:"provisioningState,omitempty"`
}

func (*ServiceBus) GetCreatedTimeAsTime 

func (o *ServiceBus) GetCreatedTimeAsTime() (*time.Time, error)

func (ServiceBus) MarshalJSON 

func (s ServiceBus) MarshalJSON() ([]byte, error)

func (*ServiceBus) SetCreatedTimeAsTime 

func (o *ServiceBus) SetCreatedTimeAsTime(input time.Time)

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.