timeseriesdatabaseconnections

package
v0.20240125.1170241 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/timeseriesdatabaseconnections Documentation

The timeseriesdatabaseconnections 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/timeseriesdatabaseconnections"

Client Initialization

client := timeseriesdatabaseconnections.NewTimeSeriesDatabaseConnectionsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: TimeSeriesDatabaseConnectionsClient.CreateOrUpdate

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

payload := timeseriesdatabaseconnections.TimeSeriesDatabaseConnection{
	// ...
}


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

Example Usage: TimeSeriesDatabaseConnectionsClient.Delete

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

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

Example Usage: TimeSeriesDatabaseConnectionsClient.Get

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

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: TimeSeriesDatabaseConnectionsClient.List

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

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

func PossibleValuesForCleanupConnectionArtifacts() []string

func PossibleValuesForConnectionType 

func PossibleValuesForConnectionType() []string

func PossibleValuesForIdentityType 

func PossibleValuesForIdentityType() []string

func PossibleValuesForTimeSeriesDatabaseConnectionState 

func PossibleValuesForTimeSeriesDatabaseConnectionState() []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 ValidateTimeSeriesDatabaseConnectionID 

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

ValidateTimeSeriesDatabaseConnectionID checks that 'input' can be parsed as a Time Series Database Connection ID

Types

type AzureDataExplorerConnectionProperties 

type AzureDataExplorerConnectionProperties struct {
	AdxDatabaseName                         string  `json:"adxDatabaseName"`
	AdxEndpointUri                          string  `json:"adxEndpointUri"`
	AdxRelationshipLifecycleEventsTableName *string `json:"adxRelationshipLifecycleEventsTableName,omitempty"`
	AdxResourceId                           string  `json:"adxResourceId"`
	AdxTableName                            *string `json:"adxTableName,omitempty"`
	AdxTwinLifecycleEventsTableName         *string `json:"adxTwinLifecycleEventsTableName,omitempty"`
	EventHubConsumerGroup                   *string `json:"eventHubConsumerGroup,omitempty"`
	EventHubEndpointUri                     string  `json:"eventHubEndpointUri"`
	EventHubEntityPath                      string  `json:"eventHubEntityPath"`
	EventHubNamespaceResourceId             string  `json:"eventHubNamespaceResourceId"`
	RecordPropertyAndItemRemovals           *bool   `json:"recordPropertyAndItemRemovals,omitempty"`

	// Fields inherited from TimeSeriesDatabaseConnectionProperties
	Identity          *ManagedIdentityReference          `json:"identity,omitempty"`
	ProvisioningState *TimeSeriesDatabaseConnectionState `json:"provisioningState,omitempty"`
}

func (AzureDataExplorerConnectionProperties) MarshalJSON 

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

type CleanupConnectionArtifacts 

type CleanupConnectionArtifacts string
const (
	CleanupConnectionArtifactsFalse CleanupConnectionArtifacts = "false"
	CleanupConnectionArtifactsTrue  CleanupConnectionArtifacts = "true"
)

func (*CleanupConnectionArtifacts) UnmarshalJSON 

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

type ConnectionType 

type ConnectionType string
const (
	ConnectionTypeAzureDataExplorer ConnectionType = "AzureDataExplorer"
)

func (*ConnectionType) UnmarshalJSON 

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

type CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *TimeSeriesDatabaseConnection
}

type DeleteOperationOptions 

type DeleteOperationOptions struct {
	CleanupConnectionArtifacts *CleanupConnectionArtifacts
}

func DefaultDeleteOperationOptions 

func DefaultDeleteOperationOptions() DeleteOperationOptions

func (DeleteOperationOptions) ToHeaders 

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

func (DeleteOperationOptions) ToOData 

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

func (DeleteOperationOptions) ToQuery 

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

type DeleteOperationResponse 

type DeleteOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *TimeSeriesDatabaseConnection
}

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 GetOperationResponse 

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *TimeSeriesDatabaseConnection
}

type IdentityType 

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

func (*IdentityType) UnmarshalJSON 

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

type ListCompleteResult 

type ListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []TimeSeriesDatabaseConnection
}

type ListOperationResponse 

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]TimeSeriesDatabaseConnection
}

type ManagedIdentityReference 

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

type RawTimeSeriesDatabaseConnectionPropertiesImpl 

type RawTimeSeriesDatabaseConnectionPropertiesImpl struct {
	Type   string
	Values map[string]interface{}
}

RawTimeSeriesDatabaseConnectionPropertiesImpl is returned when the Discriminated Value doesn't match any of the defined types NOTE: this should only be used when a type isn't defined for this type of Object (as a workaround) and is used only for Deserialization (e.g. this cannot be used as a Request Payload).

type TimeSeriesDatabaseConnection 

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

func (*TimeSeriesDatabaseConnection) UnmarshalJSON 

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

type TimeSeriesDatabaseConnectionId 

type TimeSeriesDatabaseConnectionId struct {
	SubscriptionId                   string
	ResourceGroupName                string
	DigitalTwinsInstanceName         string
	TimeSeriesDatabaseConnectionName string
}

TimeSeriesDatabaseConnectionId is a struct representing the Resource ID for a Time Series Database Connection

func NewTimeSeriesDatabaseConnectionID 

func NewTimeSeriesDatabaseConnectionID(subscriptionId string, resourceGroupName string, digitalTwinsInstanceName string, timeSeriesDatabaseConnectionName string) TimeSeriesDatabaseConnectionId

NewTimeSeriesDatabaseConnectionID returns a new TimeSeriesDatabaseConnectionId struct

func ParseTimeSeriesDatabaseConnectionID 

func ParseTimeSeriesDatabaseConnectionID(input string) (*TimeSeriesDatabaseConnectionId, error)

ParseTimeSeriesDatabaseConnectionID parses 'input' into a TimeSeriesDatabaseConnectionId

func ParseTimeSeriesDatabaseConnectionIDInsensitively 

func ParseTimeSeriesDatabaseConnectionIDInsensitively(input string) (*TimeSeriesDatabaseConnectionId, error)

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

func (*TimeSeriesDatabaseConnectionId) FromParseResult 

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

func (TimeSeriesDatabaseConnectionId) ID 

func (id TimeSeriesDatabaseConnectionId) ID() string

ID returns the formatted Time Series Database Connection ID

func (TimeSeriesDatabaseConnectionId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Time Series Database Connection ID

func (TimeSeriesDatabaseConnectionId) String 

func (id TimeSeriesDatabaseConnectionId) String() string

String returns a human-readable description of this Time Series Database Connection ID

type TimeSeriesDatabaseConnectionOperationPredicate 

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

func (TimeSeriesDatabaseConnectionOperationPredicate) Matches 

func (p TimeSeriesDatabaseConnectionOperationPredicate) Matches(input TimeSeriesDatabaseConnection) bool

type TimeSeriesDatabaseConnectionProperties 

type TimeSeriesDatabaseConnectionProperties interface {
}

type TimeSeriesDatabaseConnectionState 

type TimeSeriesDatabaseConnectionState string
const (
	TimeSeriesDatabaseConnectionStateCanceled     TimeSeriesDatabaseConnectionState = "Canceled"
	TimeSeriesDatabaseConnectionStateDeleted      TimeSeriesDatabaseConnectionState = "Deleted"
	TimeSeriesDatabaseConnectionStateDeleting     TimeSeriesDatabaseConnectionState = "Deleting"
	TimeSeriesDatabaseConnectionStateDisabled     TimeSeriesDatabaseConnectionState = "Disabled"
	TimeSeriesDatabaseConnectionStateFailed       TimeSeriesDatabaseConnectionState = "Failed"
	TimeSeriesDatabaseConnectionStateMoving       TimeSeriesDatabaseConnectionState = "Moving"
	TimeSeriesDatabaseConnectionStateProvisioning TimeSeriesDatabaseConnectionState = "Provisioning"
	TimeSeriesDatabaseConnectionStateRestoring    TimeSeriesDatabaseConnectionState = "Restoring"
	TimeSeriesDatabaseConnectionStateSucceeded    TimeSeriesDatabaseConnectionState = "Succeeded"
	TimeSeriesDatabaseConnectionStateSuspending   TimeSeriesDatabaseConnectionState = "Suspending"
	TimeSeriesDatabaseConnectionStateUpdating     TimeSeriesDatabaseConnectionState = "Updating"
	TimeSeriesDatabaseConnectionStateWarning      TimeSeriesDatabaseConnectionState = "Warning"
)

func (*TimeSeriesDatabaseConnectionState) UnmarshalJSON 

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

type TimeSeriesDatabaseConnectionsClient 

type TimeSeriesDatabaseConnectionsClient struct {
	Client *resourcemanager.Client
}

func NewTimeSeriesDatabaseConnectionsClientWithBaseURI 

func NewTimeSeriesDatabaseConnectionsClientWithBaseURI(sdkApi sdkEnv.Api) (*TimeSeriesDatabaseConnectionsClient, error)

func (TimeSeriesDatabaseConnectionsClient) CreateOrUpdate 

func (c TimeSeriesDatabaseConnectionsClient) CreateOrUpdate(ctx context.Context, id TimeSeriesDatabaseConnectionId, input TimeSeriesDatabaseConnection) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (TimeSeriesDatabaseConnectionsClient) CreateOrUpdateThenPoll 

func (c TimeSeriesDatabaseConnectionsClient) CreateOrUpdateThenPoll(ctx context.Context, id TimeSeriesDatabaseConnectionId, input TimeSeriesDatabaseConnection) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (TimeSeriesDatabaseConnectionsClient) Delete 

func (c TimeSeriesDatabaseConnectionsClient) Delete(ctx context.Context, id TimeSeriesDatabaseConnectionId, options DeleteOperationOptions) (result DeleteOperationResponse, err error)

Delete ...

func (TimeSeriesDatabaseConnectionsClient) DeleteThenPoll 

func (c TimeSeriesDatabaseConnectionsClient) DeleteThenPoll(ctx context.Context, id TimeSeriesDatabaseConnectionId, options DeleteOperationOptions) error

DeleteThenPoll performs Delete then polls until it's completed

func (TimeSeriesDatabaseConnectionsClient) Get 

func (c TimeSeriesDatabaseConnectionsClient) Get(ctx context.Context, id TimeSeriesDatabaseConnectionId) (result GetOperationResponse, err error)

Get ...

func (TimeSeriesDatabaseConnectionsClient) List 

func (c TimeSeriesDatabaseConnectionsClient) List(ctx context.Context, id DigitalTwinsInstanceId) (result ListOperationResponse, err error)

List ...

func (TimeSeriesDatabaseConnectionsClient) ListComplete 

func (c TimeSeriesDatabaseConnectionsClient) ListComplete(ctx context.Context, id DigitalTwinsInstanceId) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (TimeSeriesDatabaseConnectionsClient) ListCompleteMatchingPredicate 

func (c TimeSeriesDatabaseConnectionsClient) ListCompleteMatchingPredicate(ctx context.Context, id DigitalTwinsInstanceId, predicate TimeSeriesDatabaseConnectionOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

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.