README ¶
github.com/hashicorp/go-azure-sdk/resource-manager/digitaltwins/2020-12-01/endpoints
Documentation
The endpoints
SDK allows for interaction with the Azure Resource Manager Service digitaltwins
(API Version 2020-12-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/digitaltwins/2020-12-01/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 ¶
- func PossibleValuesForAuthenticationType() []string
- func PossibleValuesForEndpointProvisioningState() []string
- func PossibleValuesForEndpointType() []string
- func ValidateDigitalTwinsInstanceID(input interface{}, key string) (warnings []string, errors []error)
- func ValidateEndpointID(input interface{}, key string) (warnings []string, errors []error)
- type AuthenticationType
- type DigitalTwinsEndpointCreateOrUpdateOperationResponse
- type DigitalTwinsEndpointDeleteOperationResponse
- type DigitalTwinsEndpointGetOperationResponse
- type DigitalTwinsEndpointListCompleteResult
- type DigitalTwinsEndpointListOperationResponse
- type DigitalTwinsEndpointResource
- type DigitalTwinsEndpointResourceOperationPredicate
- type DigitalTwinsEndpointResourceProperties
- type DigitalTwinsInstanceId
- type EndpointId
- type EndpointProvisioningState
- type EndpointType
- type EndpointsClient
- func (c EndpointsClient) DigitalTwinsEndpointCreateOrUpdate(ctx context.Context, id EndpointId, input DigitalTwinsEndpointResource) (result DigitalTwinsEndpointCreateOrUpdateOperationResponse, err error)
- func (c EndpointsClient) DigitalTwinsEndpointCreateOrUpdateThenPoll(ctx context.Context, id EndpointId, input DigitalTwinsEndpointResource) error
- func (c EndpointsClient) DigitalTwinsEndpointDelete(ctx context.Context, id EndpointId) (result DigitalTwinsEndpointDeleteOperationResponse, err error)
- func (c EndpointsClient) DigitalTwinsEndpointDeleteThenPoll(ctx context.Context, id EndpointId) error
- func (c EndpointsClient) DigitalTwinsEndpointGet(ctx context.Context, id EndpointId) (result DigitalTwinsEndpointGetOperationResponse, err error)
- func (c EndpointsClient) DigitalTwinsEndpointList(ctx context.Context, id DigitalTwinsInstanceId) (resp DigitalTwinsEndpointListOperationResponse, err error)
- func (c EndpointsClient) DigitalTwinsEndpointListComplete(ctx context.Context, id DigitalTwinsInstanceId) (DigitalTwinsEndpointListCompleteResult, error)
- func (c EndpointsClient) DigitalTwinsEndpointListCompleteMatchingPredicate(ctx context.Context, id DigitalTwinsInstanceId, ...) (resp DigitalTwinsEndpointListCompleteResult, err error)
- type EventGrid
- type EventHub
- type ServiceBus
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 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 ¶
ValidateEndpointID checks that 'input' can be parsed as a Endpoint ID
Types ¶
type AuthenticationType ¶
type AuthenticationType string
const ( AuthenticationTypeIdentityBased AuthenticationType = "IdentityBased" AuthenticationTypeKeyBased AuthenticationType = "KeyBased" )
type DigitalTwinsEndpointCreateOrUpdateOperationResponse ¶
type DigitalTwinsEndpointCreateOrUpdateOperationResponse struct { Poller polling.LongRunningPoller HttpResponse *http.Response }
type DigitalTwinsEndpointDeleteOperationResponse ¶
type DigitalTwinsEndpointDeleteOperationResponse struct { Poller polling.LongRunningPoller HttpResponse *http.Response }
type DigitalTwinsEndpointGetOperationResponse ¶
type DigitalTwinsEndpointGetOperationResponse struct { HttpResponse *http.Response Model *DigitalTwinsEndpointResource }
type DigitalTwinsEndpointListCompleteResult ¶
type DigitalTwinsEndpointListCompleteResult struct {
Items []DigitalTwinsEndpointResource
}
type DigitalTwinsEndpointListOperationResponse ¶
type DigitalTwinsEndpointListOperationResponse struct { HttpResponse *http.Response Model *[]DigitalTwinsEndpointResource // contains filtered or unexported fields }
func (DigitalTwinsEndpointListOperationResponse) HasMore ¶
func (r DigitalTwinsEndpointListOperationResponse) HasMore() bool
func (DigitalTwinsEndpointListOperationResponse) LoadMore ¶
func (r DigitalTwinsEndpointListOperationResponse) LoadMore(ctx context.Context) (resp DigitalTwinsEndpointListOperationResponse, err error)
type DigitalTwinsEndpointResource ¶
type DigitalTwinsEndpointResource struct { Id *string `json:"id,omitempty"` Name *string `json:"name,omitempty"` Properties DigitalTwinsEndpointResourceProperties `json:"properties"` Type *string `json:"type,omitempty"` }
func (*DigitalTwinsEndpointResource) UnmarshalJSON ¶
func (s *DigitalTwinsEndpointResource) UnmarshalJSON(bytes []byte) error
type DigitalTwinsEndpointResourceOperationPredicate ¶
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) 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" EndpointProvisioningStateWarning EndpointProvisioningState = "Warning" )
type EndpointType ¶
type EndpointType string
const ( EndpointTypeEventGrid EndpointType = "EventGrid" EndpointTypeEventHub EndpointType = "EventHub" EndpointTypeServiceBus EndpointType = "ServiceBus" )
type EndpointsClient ¶
func NewEndpointsClientWithBaseURI ¶
func NewEndpointsClientWithBaseURI(endpoint string) EndpointsClient
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) (resp DigitalTwinsEndpointListOperationResponse, err error)
DigitalTwinsEndpointList ...
func (EndpointsClient) DigitalTwinsEndpointListComplete ¶
func (c EndpointsClient) DigitalTwinsEndpointListComplete(ctx context.Context, id DigitalTwinsInstanceId) (DigitalTwinsEndpointListCompleteResult, error)
DigitalTwinsEndpointListComplete retrieves all of the results into a single object
func (EndpointsClient) DigitalTwinsEndpointListCompleteMatchingPredicate ¶
func (c EndpointsClient) DigitalTwinsEndpointListCompleteMatchingPredicate(ctx context.Context, id DigitalTwinsInstanceId, predicate DigitalTwinsEndpointResourceOperationPredicate) (resp DigitalTwinsEndpointListCompleteResult, err error)
DigitalTwinsEndpointListCompleteMatchingPredicate retrieves all of the results and then applied the predicate
type EventGrid ¶
type EventGrid struct { AccessKey1 *string `json:"accessKey1,omitempty"` AccessKey2 *string `json:"accessKey2,omitempty"` TopicEndpoint *string `json:"TopicEndpoint,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"` ProvisioningState *EndpointProvisioningState `json:"provisioningState,omitempty"` }
func (*EventGrid) GetCreatedTimeAsTime ¶
func (EventGrid) MarshalJSON ¶
func (*EventGrid) SetCreatedTimeAsTime ¶
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"` ProvisioningState *EndpointProvisioningState `json:"provisioningState,omitempty"` }
func (*EventHub) GetCreatedTimeAsTime ¶
func (EventHub) MarshalJSON ¶
func (*EventHub) SetCreatedTimeAsTime ¶
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"` 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 ¶
- client.go
- constants.go
- id_digitaltwinsinstance.go
- id_endpoint.go
- method_digitaltwinsendpointcreateorupdate_autorest.go
- method_digitaltwinsendpointdelete_autorest.go
- method_digitaltwinsendpointget_autorest.go
- method_digitaltwinsendpointlist_autorest.go
- model_digitaltwinsendpointresource.go
- model_digitaltwinsendpointresourceproperties.go
- model_eventgrid.go
- model_eventhub.go
- model_servicebus.go
- predicates.go
- version.go