digitaltwinsinstance

package
v0.20240522.1080424 Latest Latest
Warning

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

 Go to latest Published: May 22, 2024 License: MPL-2.0 Imports: 17 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/digitaltwins/2023-01-31/digitaltwinsinstance Documentation

The digitaltwinsinstance 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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/digitaltwins/2023-01-31/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", "digitalTwinsInstanceValue")

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

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

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 := commonids.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 := commonids.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", "digitalTwinsInstanceValue")

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

func (*ConnectionPropertiesProvisioningState) UnmarshalJSON 

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

type ConnectionState 

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

type DigitalTwinsCreateOrUpdateOperationResponse 

type DigitalTwinsCreateOrUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *DigitalTwinsDescription
}

type DigitalTwinsDeleteOperationResponse 

type DigitalTwinsDeleteOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *DigitalTwinsDescription
}

type DigitalTwinsDescription 

type DigitalTwinsDescription struct {
	Id         *string                                  `json:"id,omitempty"`
	Identity   *identity.LegacySystemAndUserAssignedMap `json:"identity,omitempty"`
	Location   string                                   `json:"location"`
	Name       *string                                  `json:"name,omitempty"`
	Properties *DigitalTwinsProperties                  `json:"properties,omitempty"`
	SystemData *systemdata.SystemData                   `json:"systemData,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 

func (p DigitalTwinsDescriptionOperationPredicate) Matches(input DigitalTwinsDescription) bool

type DigitalTwinsGetOperationResponse 

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

type DigitalTwinsInstanceClient 

type DigitalTwinsInstanceClient struct {
	Client *resourcemanager.Client
}

func NewDigitalTwinsInstanceClientWithBaseURI 

func NewDigitalTwinsInstanceClientWithBaseURI(sdkApi sdkEnv.Api) (*DigitalTwinsInstanceClient, error)

func (DigitalTwinsInstanceClient) DigitalTwinsCreateOrUpdate 

func (c DigitalTwinsInstanceClient) DigitalTwinsCreateOrUpdate(ctx context.Context, id DigitalTwinsInstanceId, input DigitalTwinsDescription) (result DigitalTwinsCreateOrUpdateOperationResponse, err error)

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 

func (c DigitalTwinsInstanceClient) DigitalTwinsDelete(ctx context.Context, id DigitalTwinsInstanceId) (result DigitalTwinsDeleteOperationResponse, err error)

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 

func (c DigitalTwinsInstanceClient) DigitalTwinsGet(ctx context.Context, id DigitalTwinsInstanceId) (result DigitalTwinsGetOperationResponse, err error)

DigitalTwinsGet ...

func (DigitalTwinsInstanceClient) DigitalTwinsList 

func (c DigitalTwinsInstanceClient) DigitalTwinsList(ctx context.Context, id commonids.SubscriptionId) (result DigitalTwinsListOperationResponse, err error)

DigitalTwinsList ...

func (DigitalTwinsInstanceClient) DigitalTwinsListByResourceGroup 

func (c DigitalTwinsInstanceClient) DigitalTwinsListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId) (result DigitalTwinsListByResourceGroupOperationResponse, err error)

DigitalTwinsListByResourceGroup ...

func (DigitalTwinsInstanceClient) DigitalTwinsListByResourceGroupComplete 

func (c DigitalTwinsInstanceClient) DigitalTwinsListByResourceGroupComplete(ctx context.Context, id commonids.ResourceGroupId) (DigitalTwinsListByResourceGroupCompleteResult, error)

DigitalTwinsListByResourceGroupComplete retrieves all the results into a single object

func (DigitalTwinsInstanceClient) DigitalTwinsListByResourceGroupCompleteMatchingPredicate 

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

DigitalTwinsListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (DigitalTwinsInstanceClient) DigitalTwinsListComplete 

func (c DigitalTwinsInstanceClient) DigitalTwinsListComplete(ctx context.Context, id commonids.SubscriptionId) (DigitalTwinsListCompleteResult, error)

DigitalTwinsListComplete retrieves all the results into a single object

func (DigitalTwinsInstanceClient) DigitalTwinsListCompleteMatchingPredicate 

func (c DigitalTwinsInstanceClient) DigitalTwinsListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate DigitalTwinsDescriptionOperationPredicate) (result DigitalTwinsListCompleteResult, err error)

DigitalTwinsListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (DigitalTwinsInstanceClient) DigitalTwinsUpdate 

func (c DigitalTwinsInstanceClient) DigitalTwinsUpdate(ctx context.Context, id DigitalTwinsInstanceId, input DigitalTwinsPatchDescription) (result DigitalTwinsUpdateOperationResponse, err error)

DigitalTwinsUpdate ...

func (DigitalTwinsInstanceClient) DigitalTwinsUpdateThenPoll 

func (c DigitalTwinsInstanceClient) DigitalTwinsUpdateThenPoll(ctx context.Context, id DigitalTwinsInstanceId, input DigitalTwinsPatchDescription) error

DigitalTwinsUpdateThenPoll performs DigitalTwinsUpdate then polls until it's completed

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 DigitalTwinsListByResourceGroupCompleteResult 

type DigitalTwinsListByResourceGroupCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []DigitalTwinsDescription
}

type DigitalTwinsListByResourceGroupOperationResponse 

type DigitalTwinsListByResourceGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]DigitalTwinsDescription
}

type DigitalTwinsListCompleteResult 

type DigitalTwinsListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []DigitalTwinsDescription
}

type DigitalTwinsListOperationResponse 

type DigitalTwinsListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]DigitalTwinsDescription
}

type DigitalTwinsPatchDescription 

type DigitalTwinsPatchDescription struct {
	Identity   *identity.LegacySystemAndUserAssignedMap `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       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *DigitalTwinsDescription
}

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

type PrivateLinkServiceConnectionStatus 

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

func (*PrivateLinkServiceConnectionStatus) UnmarshalJSON 

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

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

func (*ProvisioningState) UnmarshalJSON 

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

type PublicNetworkAccess 

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

func (*PublicNetworkAccess) UnmarshalJSON 

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

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.