digitaltwinsinstance

package
v0.20221021.1074650 Latest Latest
Warning

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

Go to latest
Published: Oct 21, 2022 License: MPL-2.0 Imports: 13 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/digitaltwins/2020-12-01/digitaltwinsinstance Documentation

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

Client Initialization

client := digitaltwinsinstance.NewDigitalTwinsInstanceClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: DigitalTwinsInstanceClient.DigitalTwinsCreateOrUpdate

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

payload := digitaltwinsinstance.DigitalTwinsDescription{
	// ...
}


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

Example Usage: DigitalTwinsInstanceClient.DigitalTwinsDelete

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

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

Example Usage: DigitalTwinsInstanceClient.DigitalTwinsGet

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

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

Example Usage: DigitalTwinsInstanceClient.DigitalTwinsList

ctx := context.TODO()
id := digitaltwinsinstance.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

// alternatively `client.DigitalTwinsList(ctx, id)` can be used to do batched pagination
items, err := client.DigitalTwinsListComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: DigitalTwinsInstanceClient.DigitalTwinsListByResourceGroup

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

// alternatively `client.DigitalTwinsListByResourceGroup(ctx, id)` can be used to do batched pagination
items, err := client.DigitalTwinsListByResourceGroupComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: DigitalTwinsInstanceClient.DigitalTwinsUpdate

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

payload := digitaltwinsinstance.DigitalTwinsPatchDescription{
	// ...
}


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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForConnectionPropertiesProvisioningState

func PossibleValuesForConnectionPropertiesProvisioningState() []string

func PossibleValuesForPrivateLinkServiceConnectionStatus

func PossibleValuesForPrivateLinkServiceConnectionStatus() []string

func PossibleValuesForProvisioningState

func PossibleValuesForProvisioningState() []string

func PossibleValuesForPublicNetworkAccess

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

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

type ConnectionState

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

type DigitalTwinsCreateOrUpdateOperationResponse

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

type DigitalTwinsDeleteOperationResponse

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

type DigitalTwinsDescription

type DigitalTwinsDescription struct {
	Id         *string                  `json:"id,omitempty"`
	Identity   *identity.SystemAssigned `json:"identity,omitempty"`
	Location   string                   `json:"location"`
	Name       *string                  `json:"name,omitempty"`
	Properties *DigitalTwinsProperties  `json:"properties,omitempty"`
	Tags       *map[string]string       `json:"tags,omitempty"`
	Type       *string                  `json:"type,omitempty"`
}

type DigitalTwinsDescriptionOperationPredicate

type DigitalTwinsDescriptionOperationPredicate struct {
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (DigitalTwinsDescriptionOperationPredicate) Matches

type DigitalTwinsGetOperationResponse

type DigitalTwinsGetOperationResponse struct {
	HttpResponse *http.Response
	Model        *DigitalTwinsDescription
}

type DigitalTwinsInstanceClient

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

func NewDigitalTwinsInstanceClientWithBaseURI

func NewDigitalTwinsInstanceClientWithBaseURI(endpoint string) DigitalTwinsInstanceClient

func (DigitalTwinsInstanceClient) DigitalTwinsCreateOrUpdate

DigitalTwinsCreateOrUpdate ...

func (DigitalTwinsInstanceClient) DigitalTwinsCreateOrUpdateThenPoll

func (c DigitalTwinsInstanceClient) DigitalTwinsCreateOrUpdateThenPoll(ctx context.Context, id DigitalTwinsInstanceId, input DigitalTwinsDescription) error

DigitalTwinsCreateOrUpdateThenPoll performs DigitalTwinsCreateOrUpdate then polls until it's completed

func (DigitalTwinsInstanceClient) DigitalTwinsDelete

DigitalTwinsDelete ...

func (DigitalTwinsInstanceClient) DigitalTwinsDeleteThenPoll

func (c DigitalTwinsInstanceClient) DigitalTwinsDeleteThenPoll(ctx context.Context, id DigitalTwinsInstanceId) error

DigitalTwinsDeleteThenPoll performs DigitalTwinsDelete then polls until it's completed

func (DigitalTwinsInstanceClient) DigitalTwinsGet

DigitalTwinsGet ...

func (DigitalTwinsInstanceClient) DigitalTwinsList

DigitalTwinsList ...

func (DigitalTwinsInstanceClient) DigitalTwinsListByResourceGroup

DigitalTwinsListByResourceGroup ...

func (DigitalTwinsInstanceClient) DigitalTwinsListByResourceGroupComplete

DigitalTwinsListByResourceGroupComplete retrieves all of the results into a single object

func (DigitalTwinsInstanceClient) DigitalTwinsListByResourceGroupCompleteMatchingPredicate

func (c DigitalTwinsInstanceClient) DigitalTwinsListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, predicate DigitalTwinsDescriptionOperationPredicate) (resp DigitalTwinsListByResourceGroupCompleteResult, err error)

DigitalTwinsListByResourceGroupCompleteMatchingPredicate retrieves all of the results and then applied the predicate

func (DigitalTwinsInstanceClient) DigitalTwinsListComplete

DigitalTwinsListComplete retrieves all of the results into a single object

func (DigitalTwinsInstanceClient) DigitalTwinsListCompleteMatchingPredicate

DigitalTwinsListCompleteMatchingPredicate retrieves all of the results and then applied the predicate

func (DigitalTwinsInstanceClient) DigitalTwinsUpdate

DigitalTwinsUpdate ...

func (DigitalTwinsInstanceClient) DigitalTwinsUpdateThenPoll

DigitalTwinsUpdateThenPoll performs DigitalTwinsUpdate then polls until it's completed

type DigitalTwinsInstanceId

type DigitalTwinsInstanceId struct {
	SubscriptionId    string
	ResourceGroupName string
	ResourceName      string
}

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

func NewDigitalTwinsInstanceID

func NewDigitalTwinsInstanceID(subscriptionId string, resourceGroupName string, resourceName 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 DigitalTwinsListByResourceGroupCompleteResult

type DigitalTwinsListByResourceGroupCompleteResult struct {
	Items []DigitalTwinsDescription
}

type DigitalTwinsListByResourceGroupOperationResponse

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

func (DigitalTwinsListByResourceGroupOperationResponse) HasMore

func (DigitalTwinsListByResourceGroupOperationResponse) LoadMore

type DigitalTwinsListCompleteResult

type DigitalTwinsListCompleteResult struct {
	Items []DigitalTwinsDescription
}

type DigitalTwinsListOperationResponse

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

func (DigitalTwinsListOperationResponse) HasMore

func (DigitalTwinsListOperationResponse) LoadMore

type DigitalTwinsPatchDescription

type DigitalTwinsPatchDescription struct {
	Identity   *identity.SystemAssigned     `json:"identity,omitempty"`
	Properties *DigitalTwinsPatchProperties `json:"properties,omitempty"`
	Tags       *map[string]string           `json:"tags,omitempty"`
}

type DigitalTwinsPatchProperties

type DigitalTwinsPatchProperties struct {
	PublicNetworkAccess *PublicNetworkAccess `json:"publicNetworkAccess,omitempty"`
}

type DigitalTwinsProperties

type DigitalTwinsProperties struct {
	CreatedTime                *string                      `json:"createdTime,omitempty"`
	HostName                   *string                      `json:"hostName,omitempty"`
	LastUpdatedTime            *string                      `json:"lastUpdatedTime,omitempty"`
	PrivateEndpointConnections *[]PrivateEndpointConnection `json:"privateEndpointConnections,omitempty"`
	ProvisioningState          *ProvisioningState           `json:"provisioningState,omitempty"`
	PublicNetworkAccess        *PublicNetworkAccess         `json:"publicNetworkAccess,omitempty"`
}

func (*DigitalTwinsProperties) GetCreatedTimeAsTime

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

func (*DigitalTwinsProperties) GetLastUpdatedTimeAsTime

func (o *DigitalTwinsProperties) GetLastUpdatedTimeAsTime() (*time.Time, error)

func (*DigitalTwinsProperties) SetCreatedTimeAsTime

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

func (*DigitalTwinsProperties) SetLastUpdatedTimeAsTime

func (o *DigitalTwinsProperties) SetLastUpdatedTimeAsTime(input time.Time)

type DigitalTwinsUpdateOperationResponse

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

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"`
	Type       *string              `json:"type,omitempty"`
}

type PrivateLinkServiceConnectionStatus

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

type ProvisioningState

type ProvisioningState string
const (
	ProvisioningStateCanceled     ProvisioningState = "Canceled"
	ProvisioningStateDeleted      ProvisioningState = "Deleted"
	ProvisioningStateDeleting     ProvisioningState = "Deleting"
	ProvisioningStateFailed       ProvisioningState = "Failed"
	ProvisioningStateMoving       ProvisioningState = "Moving"
	ProvisioningStateProvisioning ProvisioningState = "Provisioning"
	ProvisioningStateRestoring    ProvisioningState = "Restoring"
	ProvisioningStateSucceeded    ProvisioningState = "Succeeded"
	ProvisioningStateSuspending   ProvisioningState = "Suspending"
	ProvisioningStateUpdating     ProvisioningState = "Updating"
	ProvisioningStateWarning      ProvisioningState = "Warning"
)

type PublicNetworkAccess

type PublicNetworkAccess string
const (
	PublicNetworkAccessDisabled PublicNetworkAccess = "Disabled"
	PublicNetworkAccessEnabled  PublicNetworkAccess = "Enabled"
)

Jump to

Keyboard shortcuts

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