timeseriesdatabaseconnections

package
v0.20230208.1154850 Latest Latest
Warning

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

Go to latest
Published: Feb 8, 2023 License: MPL-2.0 Imports: 11 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/digitaltwins/2022-05-31/timeseriesdatabaseconnections Documentation

The timeseriesdatabaseconnections SDK allows for interaction with the Azure Resource Manager Service digitaltwins (API Version 2022-05-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-05-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); 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 PossibleValuesForConnectionType

func PossibleValuesForConnectionType() []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"`
	AdxResourceId               string  `json:"adxResourceId"`
	AdxTableName                *string `json:"adxTableName,omitempty"`
	EventHubConsumerGroup       *string `json:"eventHubConsumerGroup,omitempty"`
	EventHubEndpointUri         string  `json:"eventHubEndpointUri"`
	EventHubEntityPath          string  `json:"eventHubEntityPath"`
	EventHubNamespaceResourceId string  `json:"eventHubNamespaceResourceId"`

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

func (AzureDataExplorerConnectionProperties) MarshalJSON

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

type ConnectionType

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

type CreateOrUpdateOperationResponse

type CreateOrUpdateOperationResponse struct {
	Poller       polling.LongRunningPoller
	HttpResponse *http.Response
}

type DeleteOperationResponse

type DeleteOperationResponse struct {
	Poller       polling.LongRunningPoller
	HttpResponse *http.Response
}

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

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
	Model        *TimeSeriesDatabaseConnection
}

type ListCompleteResult

type ListCompleteResult struct {
	Items []TimeSeriesDatabaseConnection
}

type ListOperationResponse

type ListOperationResponse struct {
	HttpResponse *http.Response
	Model        *[]TimeSeriesDatabaseConnection
	// contains filtered or unexported fields
}

func (ListOperationResponse) HasMore

func (r ListOperationResponse) HasMore() bool

func (ListOperationResponse) LoadMore

func (r ListOperationResponse) LoadMore(ctx context.Context) (resp ListOperationResponse, err error)

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

ID returns the formatted Time Series Database Connection ID

func (TimeSeriesDatabaseConnectionId) Segments

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

func (TimeSeriesDatabaseConnectionId) 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

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

type TimeSeriesDatabaseConnectionsClient

type TimeSeriesDatabaseConnectionsClient struct {
	Client autorest.Client
	// contains filtered or unexported fields
}

func NewTimeSeriesDatabaseConnectionsClientWithBaseURI

func NewTimeSeriesDatabaseConnectionsClientWithBaseURI(endpoint string) TimeSeriesDatabaseConnectionsClient

func (TimeSeriesDatabaseConnectionsClient) CreateOrUpdate

CreateOrUpdate ...

func (TimeSeriesDatabaseConnectionsClient) CreateOrUpdateThenPoll

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (TimeSeriesDatabaseConnectionsClient) Delete

Delete ...

func (TimeSeriesDatabaseConnectionsClient) DeleteThenPoll

DeleteThenPoll performs Delete then polls until it's completed

func (TimeSeriesDatabaseConnectionsClient) Get

Get ...

func (TimeSeriesDatabaseConnectionsClient) List

List ...

func (TimeSeriesDatabaseConnectionsClient) ListComplete

ListComplete retrieves all of the results into a single object

func (TimeSeriesDatabaseConnectionsClient) ListCompleteMatchingPredicate

ListCompleteMatchingPredicate retrieves all of the results and then applied the predicate

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL