digitaltwins

package
v61.3.0+incompatible Latest Latest
Warning

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

Go to latest
Published: Jan 20, 2022 License: MIT Imports: 10 Imported by: 0

Documentation

Overview

Package digitaltwins implements the Azure ARM Digitaltwins service API version 2020-10-31.

Azure Digital Twins Client for managing DigitalTwinsInstance

Index

Constants

View Source
const (
	// DefaultBaseURI is the default URI used for the service Digitaltwins
	DefaultBaseURI = "https://management.azure.com"
)

Variables

This section is empty.

Functions

func UserAgent

func UserAgent() string

UserAgent returns the UserAgent string to use when sending http.Requests.

func Version

func Version() string

Version returns the semantic version (see http://semver.org) of the client.

Types

type BaseClient

type BaseClient struct {
	autorest.Client
	BaseURI        string
	SubscriptionID string
}

BaseClient is the base client for Digitaltwins.

func New

func New(subscriptionID string) BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI

func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient

NewWithBaseURI creates an instance of the BaseClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

type BasicEndpointResourceProperties

type BasicEndpointResourceProperties interface {
	AsServiceBus() (*ServiceBus, bool)
	AsEventHub() (*EventHub, bool)
	AsEventGrid() (*EventGrid, bool)
	AsEndpointResourceProperties() (*EndpointResourceProperties, bool)
}

BasicEndpointResourceProperties properties related to Digital Twins Endpoint

type CheckNameRequest

type CheckNameRequest struct {
	// Name - Resource name.
	Name *string `json:"name,omitempty"`
	// Type - The type of resource, for instance Microsoft.DigitalTwins/digitalTwinsInstances.
	Type *string `json:"type,omitempty"`
}

CheckNameRequest the result returned from a database check name availability request.

type CheckNameResult

type CheckNameResult struct {
	autorest.Response `json:"-"`
	// NameAvailable - Specifies a Boolean value that indicates if the name is available.
	NameAvailable *bool `json:"nameAvailable,omitempty"`
	// Message - Message indicating an unavailable name due to a conflict, or a description of the naming rules that are violated.
	Message *string `json:"message,omitempty"`
	// Reason - Message providing the reason why the given name is invalid. Possible values include: 'Invalid', 'AlreadyExists'
	Reason Reason `json:"reason,omitempty"`
}

CheckNameResult the result returned from a check name availability request.

type Client

type Client struct {
	BaseClient
}

Client is the azure Digital Twins Client for managing DigitalTwinsInstance

func NewClient

func NewClient(subscriptionID string) Client

NewClient creates an instance of the Client client.

func NewClientWithBaseURI

func NewClientWithBaseURI(baseURI string, subscriptionID string) Client

NewClientWithBaseURI creates an instance of the Client client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (Client) CheckNameAvailability

func (client Client) CheckNameAvailability(ctx context.Context, location string, digitalTwinsInstanceCheckName CheckNameRequest) (result CheckNameResult, err error)

CheckNameAvailability check if a DigitalTwinsInstance name is available. Parameters: location - location of DigitalTwinsInstance. digitalTwinsInstanceCheckName - set the name parameter in the DigitalTwinsInstanceCheckName structure to the name of the DigitalTwinsInstance to check.

func (Client) CheckNameAvailabilityPreparer

func (client Client) CheckNameAvailabilityPreparer(ctx context.Context, location string, digitalTwinsInstanceCheckName CheckNameRequest) (*http.Request, error)

CheckNameAvailabilityPreparer prepares the CheckNameAvailability request.

func (Client) CheckNameAvailabilityResponder

func (client Client) CheckNameAvailabilityResponder(resp *http.Response) (result CheckNameResult, err error)

CheckNameAvailabilityResponder handles the response to the CheckNameAvailability request. The method always closes the http.Response Body.

func (Client) CheckNameAvailabilitySender

func (client Client) CheckNameAvailabilitySender(req *http.Request) (*http.Response, error)

CheckNameAvailabilitySender sends the CheckNameAvailability request. The method will close the http.Response Body if it receives an error.

func (Client) CreateOrUpdate

func (client Client) CreateOrUpdate(ctx context.Context, resourceGroupName string, resourceName string, digitalTwinsCreate Description) (result CreateOrUpdateFuture, err error)

CreateOrUpdate create or update the metadata of a DigitalTwinsInstance. The usual pattern to modify a property is to retrieve the DigitalTwinsInstance and security metadata, and then combine them with the modified values in a new body to update the DigitalTwinsInstance. Parameters: resourceGroupName - the name of the resource group that contains the DigitalTwinsInstance. resourceName - the name of the DigitalTwinsInstance. digitalTwinsCreate - the DigitalTwinsInstance and security metadata.

func (Client) CreateOrUpdatePreparer

func (client Client) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, resourceName string, digitalTwinsCreate Description) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (Client) CreateOrUpdateResponder

func (client Client) CreateOrUpdateResponder(resp *http.Response) (result Description, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (Client) CreateOrUpdateSender

func (client Client) CreateOrUpdateSender(req *http.Request) (future CreateOrUpdateFuture, err error)

CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.

func (Client) Delete

func (client Client) Delete(ctx context.Context, resourceGroupName string, resourceName string) (result DeleteFuture, err error)

Delete delete a DigitalTwinsInstance. Parameters: resourceGroupName - the name of the resource group that contains the DigitalTwinsInstance. resourceName - the name of the DigitalTwinsInstance.

func (Client) DeletePreparer

func (client Client) DeletePreparer(ctx context.Context, resourceGroupName string, resourceName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (Client) DeleteResponder

func (client Client) DeleteResponder(resp *http.Response) (result Description, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (Client) DeleteSender

func (client Client) DeleteSender(req *http.Request) (future DeleteFuture, err error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (Client) Get

func (client Client) Get(ctx context.Context, resourceGroupName string, resourceName string) (result Description, err error)

Get get DigitalTwinsInstances resource. Parameters: resourceGroupName - the name of the resource group that contains the DigitalTwinsInstance. resourceName - the name of the DigitalTwinsInstance.

func (Client) GetPreparer

func (client Client) GetPreparer(ctx context.Context, resourceGroupName string, resourceName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (Client) GetResponder

func (client Client) GetResponder(resp *http.Response) (result Description, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (Client) GetSender

func (client Client) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (Client) List

func (client Client) List(ctx context.Context) (result DescriptionListResultPage, err error)

List get all the DigitalTwinsInstances in a subscription.

func (Client) ListByResourceGroup

func (client Client) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result DescriptionListResultPage, err error)

ListByResourceGroup get all the DigitalTwinsInstances in a resource group. Parameters: resourceGroupName - the name of the resource group that contains the DigitalTwinsInstance.

func (Client) ListByResourceGroupComplete

func (client Client) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result DescriptionListResultIterator, err error)

ListByResourceGroupComplete enumerates all values, automatically crossing page boundaries as required.

func (Client) ListByResourceGroupPreparer

func (client Client) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)

ListByResourceGroupPreparer prepares the ListByResourceGroup request.

func (Client) ListByResourceGroupResponder

func (client Client) ListByResourceGroupResponder(resp *http.Response) (result DescriptionListResult, err error)

ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.

func (Client) ListByResourceGroupSender

func (client Client) ListByResourceGroupSender(req *http.Request) (*http.Response, error)

ListByResourceGroupSender sends the ListByResourceGroup request. The method will close the http.Response Body if it receives an error.

func (Client) ListComplete

func (client Client) ListComplete(ctx context.Context) (result DescriptionListResultIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (Client) ListPreparer

func (client Client) ListPreparer(ctx context.Context) (*http.Request, error)

ListPreparer prepares the List request.

func (Client) ListResponder

func (client Client) ListResponder(resp *http.Response) (result DescriptionListResult, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (Client) ListSender

func (client Client) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

func (Client) Update

func (client Client) Update(ctx context.Context, resourceGroupName string, resourceName string, digitalTwinsPatchDescription PatchDescription) (result Description, err error)

Update update metadata of DigitalTwinsInstance. Parameters: resourceGroupName - the name of the resource group that contains the DigitalTwinsInstance. resourceName - the name of the DigitalTwinsInstance. digitalTwinsPatchDescription - the DigitalTwinsInstance and security metadata.

func (Client) UpdatePreparer

func (client Client) UpdatePreparer(ctx context.Context, resourceGroupName string, resourceName string, digitalTwinsPatchDescription PatchDescription) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (Client) UpdateResponder

func (client Client) UpdateResponder(resp *http.Response) (result Description, err error)

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (Client) UpdateSender

func (client Client) UpdateSender(req *http.Request) (*http.Response, error)

UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.

type CreateOrUpdateFuture

type CreateOrUpdateFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(Client) (Description, error)
}

CreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*CreateOrUpdateFuture) UnmarshalJSON

func (future *CreateOrUpdateFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type DeleteFuture

type DeleteFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(Client) (Description, error)
}

DeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*DeleteFuture) UnmarshalJSON

func (future *DeleteFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type Description

type Description struct {
	autorest.Response `json:"-"`
	// Properties - DigitalTwins instance properties.
	*Properties `json:"properties,omitempty"`
	// ID - READ-ONLY; The resource identifier.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The resource name.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The resource type.
	Type *string `json:"type,omitempty"`
	// Location - The resource location.
	Location *string `json:"location,omitempty"`
	// Tags - The resource tags.
	Tags map[string]*string `json:"tags"`
}

Description the description of the DigitalTwins service.

func (Description) MarshalJSON

func (d Description) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Description.

func (*Description) UnmarshalJSON

func (d *Description) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for Description struct.

type DescriptionListResult

type DescriptionListResult struct {
	autorest.Response `json:"-"`
	// NextLink - The link used to get the next page of DigitalTwins description objects.
	NextLink *string `json:"nextLink,omitempty"`
	// Value - A list of DigitalTwins description objects.
	Value *[]Description `json:"value,omitempty"`
}

DescriptionListResult a list of DigitalTwins description objects with a next link.

func (DescriptionListResult) IsEmpty

func (dlr DescriptionListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type DescriptionListResultIterator

type DescriptionListResultIterator struct {
	// contains filtered or unexported fields
}

DescriptionListResultIterator provides access to a complete listing of Description values.

func NewDescriptionListResultIterator

func NewDescriptionListResultIterator(page DescriptionListResultPage) DescriptionListResultIterator

Creates a new instance of the DescriptionListResultIterator type.

func (*DescriptionListResultIterator) Next

func (iter *DescriptionListResultIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*DescriptionListResultIterator) NextWithContext

func (iter *DescriptionListResultIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (DescriptionListResultIterator) NotDone

func (iter DescriptionListResultIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (DescriptionListResultIterator) Response

Response returns the raw server response from the last page request.

func (DescriptionListResultIterator) Value

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type DescriptionListResultPage

type DescriptionListResultPage struct {
	// contains filtered or unexported fields
}

DescriptionListResultPage contains a page of Description values.

func NewDescriptionListResultPage

Creates a new instance of the DescriptionListResultPage type.

func (*DescriptionListResultPage) Next

func (page *DescriptionListResultPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*DescriptionListResultPage) NextWithContext

func (page *DescriptionListResultPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (DescriptionListResultPage) NotDone

func (page DescriptionListResultPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (DescriptionListResultPage) Response

Response returns the raw server response from the last page request.

func (DescriptionListResultPage) Values

func (page DescriptionListResultPage) Values() []Description

Values returns the slice of values for the current page or nil if there are no values.

type EndpointClient

type EndpointClient struct {
	BaseClient
}

EndpointClient is the azure Digital Twins Client for managing DigitalTwinsInstance

func NewEndpointClient

func NewEndpointClient(subscriptionID string) EndpointClient

NewEndpointClient creates an instance of the EndpointClient client.

func NewEndpointClientWithBaseURI

func NewEndpointClientWithBaseURI(baseURI string, subscriptionID string) EndpointClient

NewEndpointClientWithBaseURI creates an instance of the EndpointClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (EndpointClient) CreateOrUpdate

func (client EndpointClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, resourceName string, endpointName string, endpointDescription EndpointResource) (result EndpointCreateOrUpdateFuture, err error)

CreateOrUpdate create or update DigitalTwinsInstance endpoint. Parameters: resourceGroupName - the name of the resource group that contains the DigitalTwinsInstance. resourceName - the name of the DigitalTwinsInstance. endpointName - name of Endpoint Resource. endpointDescription - the DigitalTwinsInstance endpoint metadata and security metadata.

func (EndpointClient) CreateOrUpdatePreparer

func (client EndpointClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, resourceName string, endpointName string, endpointDescription EndpointResource) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (EndpointClient) CreateOrUpdateResponder

func (client EndpointClient) CreateOrUpdateResponder(resp *http.Response) (result EndpointResource, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (EndpointClient) CreateOrUpdateSender

func (client EndpointClient) CreateOrUpdateSender(req *http.Request) (future EndpointCreateOrUpdateFuture, err error)

CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.

func (EndpointClient) Delete

func (client EndpointClient) Delete(ctx context.Context, resourceGroupName string, resourceName string, endpointName string) (result EndpointDeleteFuture, err error)

Delete delete a DigitalTwinsInstance endpoint. Parameters: resourceGroupName - the name of the resource group that contains the DigitalTwinsInstance. resourceName - the name of the DigitalTwinsInstance. endpointName - name of Endpoint Resource.

func (EndpointClient) DeletePreparer

func (client EndpointClient) DeletePreparer(ctx context.Context, resourceGroupName string, resourceName string, endpointName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (EndpointClient) DeleteResponder

func (client EndpointClient) DeleteResponder(resp *http.Response) (result EndpointResource, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (EndpointClient) DeleteSender

func (client EndpointClient) DeleteSender(req *http.Request) (future EndpointDeleteFuture, err error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (EndpointClient) Get

func (client EndpointClient) Get(ctx context.Context, resourceGroupName string, resourceName string, endpointName string) (result EndpointResource, err error)

Get get DigitalTwinsInstances Endpoint. Parameters: resourceGroupName - the name of the resource group that contains the DigitalTwinsInstance. resourceName - the name of the DigitalTwinsInstance. endpointName - name of Endpoint Resource.

func (EndpointClient) GetPreparer

func (client EndpointClient) GetPreparer(ctx context.Context, resourceGroupName string, resourceName string, endpointName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (EndpointClient) GetResponder

func (client EndpointClient) GetResponder(resp *http.Response) (result EndpointResource, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (EndpointClient) GetSender

func (client EndpointClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (EndpointClient) List

func (client EndpointClient) List(ctx context.Context, resourceGroupName string, resourceName string) (result EndpointResourceListResultPage, err error)

List get DigitalTwinsInstance Endpoints. Parameters: resourceGroupName - the name of the resource group that contains the DigitalTwinsInstance. resourceName - the name of the DigitalTwinsInstance.

func (EndpointClient) ListComplete

func (client EndpointClient) ListComplete(ctx context.Context, resourceGroupName string, resourceName string) (result EndpointResourceListResultIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (EndpointClient) ListPreparer

func (client EndpointClient) ListPreparer(ctx context.Context, resourceGroupName string, resourceName string) (*http.Request, error)

ListPreparer prepares the List request.

func (EndpointClient) ListResponder

func (client EndpointClient) ListResponder(resp *http.Response) (result EndpointResourceListResult, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (EndpointClient) ListSender

func (client EndpointClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

type EndpointCreateOrUpdateFuture

type EndpointCreateOrUpdateFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(EndpointClient) (EndpointResource, error)
}

EndpointCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*EndpointCreateOrUpdateFuture) UnmarshalJSON

func (future *EndpointCreateOrUpdateFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type EndpointDeleteFuture

type EndpointDeleteFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(EndpointClient) (EndpointResource, error)
}

EndpointDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*EndpointDeleteFuture) UnmarshalJSON

func (future *EndpointDeleteFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type EndpointProvisioningState

type EndpointProvisioningState string

EndpointProvisioningState enumerates the values for endpoint provisioning state.

const (
	// Canceled ...
	Canceled EndpointProvisioningState = "Canceled"
	// Deleted ...
	Deleted EndpointProvisioningState = "Deleted"
	// Deleting ...
	Deleting EndpointProvisioningState = "Deleting"
	// Disabled ...
	Disabled EndpointProvisioningState = "Disabled"
	// Failed ...
	Failed EndpointProvisioningState = "Failed"
	// Moving ...
	Moving EndpointProvisioningState = "Moving"
	// Provisioning ...
	Provisioning EndpointProvisioningState = "Provisioning"
	// Restoring ...
	Restoring EndpointProvisioningState = "Restoring"
	// Succeeded ...
	Succeeded EndpointProvisioningState = "Succeeded"
	// Suspending ...
	Suspending EndpointProvisioningState = "Suspending"
	// Warning ...
	Warning EndpointProvisioningState = "Warning"
)

func PossibleEndpointProvisioningStateValues

func PossibleEndpointProvisioningStateValues() []EndpointProvisioningState

PossibleEndpointProvisioningStateValues returns an array of possible values for the EndpointProvisioningState const type.

type EndpointResource

type EndpointResource struct {
	autorest.Response `json:"-"`
	// Properties - DigitalTwinsInstance endpoint resource properties.
	Properties BasicEndpointResourceProperties `json:"properties,omitempty"`
	// ID - READ-ONLY; The resource identifier.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; Extension resource name.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The resource type.
	Type *string `json:"type,omitempty"`
}

EndpointResource digitalTwinsInstance endpoint resource.

func (EndpointResource) MarshalJSON

func (er EndpointResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for EndpointResource.

func (*EndpointResource) UnmarshalJSON

func (er *EndpointResource) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for EndpointResource struct.

type EndpointResourceListResult

type EndpointResourceListResult struct {
	autorest.Response `json:"-"`
	// NextLink - The link used to get the next page of DigitalTwinsInstance Endpoints.
	NextLink *string `json:"nextLink,omitempty"`
	// Value - A list of DigitalTwinsInstance Endpoints.
	Value *[]EndpointResource `json:"value,omitempty"`
}

EndpointResourceListResult a list of DigitalTwinsInstance Endpoints with a next link.

func (EndpointResourceListResult) IsEmpty

func (erlr EndpointResourceListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type EndpointResourceListResultIterator

type EndpointResourceListResultIterator struct {
	// contains filtered or unexported fields
}

EndpointResourceListResultIterator provides access to a complete listing of EndpointResource values.

func NewEndpointResourceListResultIterator

func NewEndpointResourceListResultIterator(page EndpointResourceListResultPage) EndpointResourceListResultIterator

Creates a new instance of the EndpointResourceListResultIterator type.

func (*EndpointResourceListResultIterator) Next

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*EndpointResourceListResultIterator) NextWithContext

func (iter *EndpointResourceListResultIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (EndpointResourceListResultIterator) NotDone

NotDone returns true if the enumeration should be started or is not yet complete.

func (EndpointResourceListResultIterator) Response

Response returns the raw server response from the last page request.

func (EndpointResourceListResultIterator) Value

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type EndpointResourceListResultPage

type EndpointResourceListResultPage struct {
	// contains filtered or unexported fields
}

EndpointResourceListResultPage contains a page of EndpointResource values.

func NewEndpointResourceListResultPage

Creates a new instance of the EndpointResourceListResultPage type.

func (*EndpointResourceListResultPage) Next

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*EndpointResourceListResultPage) NextWithContext

func (page *EndpointResourceListResultPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (EndpointResourceListResultPage) NotDone

func (page EndpointResourceListResultPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (EndpointResourceListResultPage) Response

Response returns the raw server response from the last page request.

func (EndpointResourceListResultPage) Values

Values returns the slice of values for the current page or nil if there are no values.

type EndpointResourceProperties

type EndpointResourceProperties struct {
	// ProvisioningState - READ-ONLY; The provisioning state. Possible values include: 'Provisioning', 'Deleting', 'Succeeded', 'Failed', 'Canceled', 'Deleted', 'Warning', 'Suspending', 'Restoring', 'Moving', 'Disabled'
	ProvisioningState EndpointProvisioningState `json:"provisioningState,omitempty"`
	// CreatedTime - READ-ONLY; Time when the Endpoint was added to DigitalTwinsInstance.
	CreatedTime *date.Time `json:"createdTime,omitempty"`
	// DeadLetterSecret - Dead letter storage secret. Will be obfuscated during read.
	DeadLetterSecret *string `json:"deadLetterSecret,omitempty"`
	// EndpointType - Possible values include: 'EndpointTypeDigitalTwinsEndpointResourceProperties', 'EndpointTypeServiceBus', 'EndpointTypeEventHub', 'EndpointTypeEventGrid'
	EndpointType EndpointType `json:"endpointType,omitempty"`
}

EndpointResourceProperties properties related to Digital Twins Endpoint

func (EndpointResourceProperties) AsBasicEndpointResourceProperties

func (erp EndpointResourceProperties) AsBasicEndpointResourceProperties() (BasicEndpointResourceProperties, bool)

AsBasicEndpointResourceProperties is the BasicEndpointResourceProperties implementation for EndpointResourceProperties.

func (EndpointResourceProperties) AsEndpointResourceProperties

func (erp EndpointResourceProperties) AsEndpointResourceProperties() (*EndpointResourceProperties, bool)

AsEndpointResourceProperties is the BasicEndpointResourceProperties implementation for EndpointResourceProperties.

func (EndpointResourceProperties) AsEventGrid

func (erp EndpointResourceProperties) AsEventGrid() (*EventGrid, bool)

AsEventGrid is the BasicEndpointResourceProperties implementation for EndpointResourceProperties.

func (EndpointResourceProperties) AsEventHub

func (erp EndpointResourceProperties) AsEventHub() (*EventHub, bool)

AsEventHub is the BasicEndpointResourceProperties implementation for EndpointResourceProperties.

func (EndpointResourceProperties) AsServiceBus

func (erp EndpointResourceProperties) AsServiceBus() (*ServiceBus, bool)

AsServiceBus is the BasicEndpointResourceProperties implementation for EndpointResourceProperties.

func (EndpointResourceProperties) MarshalJSON

func (erp EndpointResourceProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for EndpointResourceProperties.

type EndpointType

type EndpointType string

EndpointType enumerates the values for endpoint type.

const (
	// EndpointTypeDigitalTwinsEndpointResourceProperties ...
	EndpointTypeDigitalTwinsEndpointResourceProperties EndpointType = "DigitalTwinsEndpointResourceProperties"
	// EndpointTypeEventGrid ...
	EndpointTypeEventGrid EndpointType = "EventGrid"
	// EndpointTypeEventHub ...
	EndpointTypeEventHub EndpointType = "EventHub"
	// EndpointTypeServiceBus ...
	EndpointTypeServiceBus EndpointType = "ServiceBus"
)

func PossibleEndpointTypeValues

func PossibleEndpointTypeValues() []EndpointType

PossibleEndpointTypeValues returns an array of possible values for the EndpointType const type.

type ErrorDefinition

type ErrorDefinition struct {
	// Code - READ-ONLY; Service specific error code which serves as the substatus for the HTTP error code.
	Code *string `json:"code,omitempty"`
	// Message - READ-ONLY; Description of the error.
	Message *string `json:"message,omitempty"`
	// Details - READ-ONLY; Internal error details.
	Details *[]ErrorDefinition `json:"details,omitempty"`
}

ErrorDefinition error definition.

func (ErrorDefinition) MarshalJSON

func (ed ErrorDefinition) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ErrorDefinition.

type ErrorResponse

type ErrorResponse struct {
	// Error - Error description
	Error *ErrorDefinition `json:"error,omitempty"`
}

ErrorResponse error response.

type EventGrid

type EventGrid struct {
	// TopicEndpoint - EventGrid Topic Endpoint
	TopicEndpoint *string `json:"TopicEndpoint,omitempty"`
	// AccessKey1 - EventGrid secondary accesskey. Will be obfuscated during read.
	AccessKey1 *string `json:"accessKey1,omitempty"`
	// AccessKey2 - EventGrid secondary accesskey. Will be obfuscated during read.
	AccessKey2 *string `json:"accessKey2,omitempty"`
	// ProvisioningState - READ-ONLY; The provisioning state. Possible values include: 'Provisioning', 'Deleting', 'Succeeded', 'Failed', 'Canceled', 'Deleted', 'Warning', 'Suspending', 'Restoring', 'Moving', 'Disabled'
	ProvisioningState EndpointProvisioningState `json:"provisioningState,omitempty"`
	// CreatedTime - READ-ONLY; Time when the Endpoint was added to DigitalTwinsInstance.
	CreatedTime *date.Time `json:"createdTime,omitempty"`
	// DeadLetterSecret - Dead letter storage secret. Will be obfuscated during read.
	DeadLetterSecret *string `json:"deadLetterSecret,omitempty"`
	// EndpointType - Possible values include: 'EndpointTypeDigitalTwinsEndpointResourceProperties', 'EndpointTypeServiceBus', 'EndpointTypeEventHub', 'EndpointTypeEventGrid'
	EndpointType EndpointType `json:"endpointType,omitempty"`
}

EventGrid properties related to EventGrid.

func (EventGrid) AsBasicEndpointResourceProperties

func (eg EventGrid) AsBasicEndpointResourceProperties() (BasicEndpointResourceProperties, bool)

AsBasicEndpointResourceProperties is the BasicEndpointResourceProperties implementation for EventGrid.

func (EventGrid) AsEndpointResourceProperties

func (eg EventGrid) AsEndpointResourceProperties() (*EndpointResourceProperties, bool)

AsEndpointResourceProperties is the BasicEndpointResourceProperties implementation for EventGrid.

func (EventGrid) AsEventGrid

func (eg EventGrid) AsEventGrid() (*EventGrid, bool)

AsEventGrid is the BasicEndpointResourceProperties implementation for EventGrid.

func (EventGrid) AsEventHub

func (eg EventGrid) AsEventHub() (*EventHub, bool)

AsEventHub is the BasicEndpointResourceProperties implementation for EventGrid.

func (EventGrid) AsServiceBus

func (eg EventGrid) AsServiceBus() (*ServiceBus, bool)

AsServiceBus is the BasicEndpointResourceProperties implementation for EventGrid.

func (EventGrid) MarshalJSON

func (eg EventGrid) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for EventGrid.

type EventHub

type EventHub struct {
	// ConnectionStringPrimaryKey - PrimaryConnectionString of the endpoint. Will be obfuscated during read.
	ConnectionStringPrimaryKey *string `json:"connectionStringPrimaryKey,omitempty"`
	// ConnectionStringSecondaryKey - SecondaryConnectionString of the endpoint. Will be obfuscated during read.
	ConnectionStringSecondaryKey *string `json:"connectionStringSecondaryKey,omitempty"`
	// ProvisioningState - READ-ONLY; The provisioning state. Possible values include: 'Provisioning', 'Deleting', 'Succeeded', 'Failed', 'Canceled', 'Deleted', 'Warning', 'Suspending', 'Restoring', 'Moving', 'Disabled'
	ProvisioningState EndpointProvisioningState `json:"provisioningState,omitempty"`
	// CreatedTime - READ-ONLY; Time when the Endpoint was added to DigitalTwinsInstance.
	CreatedTime *date.Time `json:"createdTime,omitempty"`
	// DeadLetterSecret - Dead letter storage secret. Will be obfuscated during read.
	DeadLetterSecret *string `json:"deadLetterSecret,omitempty"`
	// EndpointType - Possible values include: 'EndpointTypeDigitalTwinsEndpointResourceProperties', 'EndpointTypeServiceBus', 'EndpointTypeEventHub', 'EndpointTypeEventGrid'
	EndpointType EndpointType `json:"endpointType,omitempty"`
}

EventHub properties related to EventHub.

func (EventHub) AsBasicEndpointResourceProperties

func (eh EventHub) AsBasicEndpointResourceProperties() (BasicEndpointResourceProperties, bool)

AsBasicEndpointResourceProperties is the BasicEndpointResourceProperties implementation for EventHub.

func (EventHub) AsEndpointResourceProperties

func (eh EventHub) AsEndpointResourceProperties() (*EndpointResourceProperties, bool)

AsEndpointResourceProperties is the BasicEndpointResourceProperties implementation for EventHub.

func (EventHub) AsEventGrid

func (eh EventHub) AsEventGrid() (*EventGrid, bool)

AsEventGrid is the BasicEndpointResourceProperties implementation for EventHub.

func (EventHub) AsEventHub

func (eh EventHub) AsEventHub() (*EventHub, bool)

AsEventHub is the BasicEndpointResourceProperties implementation for EventHub.

func (EventHub) AsServiceBus

func (eh EventHub) AsServiceBus() (*ServiceBus, bool)

AsServiceBus is the BasicEndpointResourceProperties implementation for EventHub.

func (EventHub) MarshalJSON

func (eh EventHub) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for EventHub.

type ExternalResource

type ExternalResource struct {
	// ID - READ-ONLY; The resource identifier.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; Extension resource name.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The resource type.
	Type *string `json:"type,omitempty"`
}

ExternalResource definition of a resource.

func (ExternalResource) MarshalJSON

func (er ExternalResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ExternalResource.

type Operation

type Operation struct {
	// Name - READ-ONLY; Operation name: {provider}/{resource}/{read | write | action | delete}
	Name *string `json:"name,omitempty"`
	// Display - Operation properties display
	Display *OperationDisplay `json:"display,omitempty"`
	// Origin - READ-ONLY; The intended executor of the operation.
	Origin *string `json:"origin,omitempty"`
	// IsDataAction - READ-ONLY; If the operation is a data action (for data plane rbac).
	IsDataAction *bool `json:"isDataAction,omitempty"`
}

Operation digitalTwins service REST API operation

func (Operation) MarshalJSON

func (o Operation) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Operation.

type OperationDisplay

type OperationDisplay struct {
	// Provider - READ-ONLY; Service provider: Microsoft DigitalTwins
	Provider *string `json:"provider,omitempty"`
	// Resource - READ-ONLY; Resource Type: DigitalTwinsInstances
	Resource *string `json:"resource,omitempty"`
	// Operation - READ-ONLY; Name of the operation
	Operation *string `json:"operation,omitempty"`
	// Description - READ-ONLY; Friendly description for the operation,
	Description *string `json:"description,omitempty"`
}

OperationDisplay the object that represents the operation.

func (OperationDisplay) MarshalJSON

func (od OperationDisplay) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for OperationDisplay.

type OperationListResult

type OperationListResult struct {
	autorest.Response `json:"-"`
	// NextLink - The link used to get the next page of DigitalTwins description objects.
	NextLink *string `json:"nextLink,omitempty"`
	// Value - READ-ONLY; A list of DigitalTwins operations supported by the Microsoft.DigitalTwins resource provider.
	Value *[]Operation `json:"value,omitempty"`
}

OperationListResult a list of DigitalTwins service operations. It contains a list of operations and a URL link to get the next set of results.

func (OperationListResult) IsEmpty

func (olr OperationListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

func (OperationListResult) MarshalJSON

func (olr OperationListResult) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for OperationListResult.

type OperationListResultIterator

type OperationListResultIterator struct {
	// contains filtered or unexported fields
}

OperationListResultIterator provides access to a complete listing of Operation values.

func NewOperationListResultIterator

func NewOperationListResultIterator(page OperationListResultPage) OperationListResultIterator

Creates a new instance of the OperationListResultIterator type.

func (*OperationListResultIterator) Next

func (iter *OperationListResultIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*OperationListResultIterator) NextWithContext

func (iter *OperationListResultIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (OperationListResultIterator) NotDone

func (iter OperationListResultIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (OperationListResultIterator) Response

Response returns the raw server response from the last page request.

func (OperationListResultIterator) Value

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type OperationListResultPage

type OperationListResultPage struct {
	// contains filtered or unexported fields
}

OperationListResultPage contains a page of Operation values.

func NewOperationListResultPage

func NewOperationListResultPage(cur OperationListResult, getNextPage func(context.Context, OperationListResult) (OperationListResult, error)) OperationListResultPage

Creates a new instance of the OperationListResultPage type.

func (*OperationListResultPage) Next

func (page *OperationListResultPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*OperationListResultPage) NextWithContext

func (page *OperationListResultPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (OperationListResultPage) NotDone

func (page OperationListResultPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (OperationListResultPage) Response

Response returns the raw server response from the last page request.

func (OperationListResultPage) Values

func (page OperationListResultPage) Values() []Operation

Values returns the slice of values for the current page or nil if there are no values.

type OperationsClient

type OperationsClient struct {
	BaseClient
}

OperationsClient is the azure Digital Twins Client for managing DigitalTwinsInstance

func NewOperationsClient

func NewOperationsClient(subscriptionID string) OperationsClient

NewOperationsClient creates an instance of the OperationsClient client.

func NewOperationsClientWithBaseURI

func NewOperationsClientWithBaseURI(baseURI string, subscriptionID string) OperationsClient

NewOperationsClientWithBaseURI creates an instance of the OperationsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (OperationsClient) List

func (client OperationsClient) List(ctx context.Context) (result OperationListResultPage, err error)

List lists all of the available DigitalTwins service REST API operations.

func (OperationsClient) ListComplete

func (client OperationsClient) ListComplete(ctx context.Context) (result OperationListResultIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (OperationsClient) ListPreparer

func (client OperationsClient) ListPreparer(ctx context.Context) (*http.Request, error)

ListPreparer prepares the List request.

func (OperationsClient) ListResponder

func (client OperationsClient) ListResponder(resp *http.Response) (result OperationListResult, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (OperationsClient) ListSender

func (client OperationsClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

type PatchDescription

type PatchDescription struct {
	// Tags - Instance tags
	Tags map[string]*string `json:"tags"`
}

PatchDescription the description of the DigitalTwins service.

func (PatchDescription) MarshalJSON

func (pd PatchDescription) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for PatchDescription.

type Properties

type Properties struct {
	// CreatedTime - READ-ONLY; Time when DigitalTwinsInstance was created.
	CreatedTime *date.Time `json:"createdTime,omitempty"`
	// LastUpdatedTime - READ-ONLY; Time when DigitalTwinsInstance was updated.
	LastUpdatedTime *date.Time `json:"lastUpdatedTime,omitempty"`
	// ProvisioningState - READ-ONLY; The provisioning state. Possible values include: 'ProvisioningStateProvisioning', 'ProvisioningStateDeleting', 'ProvisioningStateSucceeded', 'ProvisioningStateFailed', 'ProvisioningStateCanceled', 'ProvisioningStateDeleted', 'ProvisioningStateWarning', 'ProvisioningStateSuspending', 'ProvisioningStateRestoring', 'ProvisioningStateMoving'
	ProvisioningState ProvisioningState `json:"provisioningState,omitempty"`
	// HostName - READ-ONLY; Api endpoint to work with DigitalTwinsInstance.
	HostName *string `json:"hostName,omitempty"`
}

Properties the properties of a DigitalTwinsInstance.

func (Properties) MarshalJSON

func (p Properties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Properties.

type ProvisioningState

type ProvisioningState string

ProvisioningState enumerates the values for provisioning state.

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

func PossibleProvisioningStateValues

func PossibleProvisioningStateValues() []ProvisioningState

PossibleProvisioningStateValues returns an array of possible values for the ProvisioningState const type.

type Reason

type Reason string

Reason enumerates the values for reason.

const (
	// AlreadyExists ...
	AlreadyExists Reason = "AlreadyExists"
	// Invalid ...
	Invalid Reason = "Invalid"
)

func PossibleReasonValues

func PossibleReasonValues() []Reason

PossibleReasonValues returns an array of possible values for the Reason const type.

type Resource

type Resource struct {
	// ID - READ-ONLY; The resource identifier.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The resource name.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The resource type.
	Type *string `json:"type,omitempty"`
	// Location - The resource location.
	Location *string `json:"location,omitempty"`
	// Tags - The resource tags.
	Tags map[string]*string `json:"tags"`
}

Resource the common properties of a DigitalTwinsInstance.

func (Resource) MarshalJSON

func (r Resource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Resource.

type ServiceBus

type ServiceBus struct {
	// PrimaryConnectionString - PrimaryConnectionString of the endpoint. Will be obfuscated during read.
	PrimaryConnectionString *string `json:"primaryConnectionString,omitempty"`
	// SecondaryConnectionString - SecondaryConnectionString of the endpoint. Will be obfuscated during read.
	SecondaryConnectionString *string `json:"secondaryConnectionString,omitempty"`
	// ProvisioningState - READ-ONLY; The provisioning state. Possible values include: 'Provisioning', 'Deleting', 'Succeeded', 'Failed', 'Canceled', 'Deleted', 'Warning', 'Suspending', 'Restoring', 'Moving', 'Disabled'
	ProvisioningState EndpointProvisioningState `json:"provisioningState,omitempty"`
	// CreatedTime - READ-ONLY; Time when the Endpoint was added to DigitalTwinsInstance.
	CreatedTime *date.Time `json:"createdTime,omitempty"`
	// DeadLetterSecret - Dead letter storage secret. Will be obfuscated during read.
	DeadLetterSecret *string `json:"deadLetterSecret,omitempty"`
	// EndpointType - Possible values include: 'EndpointTypeDigitalTwinsEndpointResourceProperties', 'EndpointTypeServiceBus', 'EndpointTypeEventHub', 'EndpointTypeEventGrid'
	EndpointType EndpointType `json:"endpointType,omitempty"`
}

ServiceBus properties related to ServiceBus.

func (ServiceBus) AsBasicEndpointResourceProperties

func (sb ServiceBus) AsBasicEndpointResourceProperties() (BasicEndpointResourceProperties, bool)

AsBasicEndpointResourceProperties is the BasicEndpointResourceProperties implementation for ServiceBus.

func (ServiceBus) AsEndpointResourceProperties

func (sb ServiceBus) AsEndpointResourceProperties() (*EndpointResourceProperties, bool)

AsEndpointResourceProperties is the BasicEndpointResourceProperties implementation for ServiceBus.

func (ServiceBus) AsEventGrid

func (sb ServiceBus) AsEventGrid() (*EventGrid, bool)

AsEventGrid is the BasicEndpointResourceProperties implementation for ServiceBus.

func (ServiceBus) AsEventHub

func (sb ServiceBus) AsEventHub() (*EventHub, bool)

AsEventHub is the BasicEndpointResourceProperties implementation for ServiceBus.

func (ServiceBus) AsServiceBus

func (sb ServiceBus) AsServiceBus() (*ServiceBus, bool)

AsServiceBus is the BasicEndpointResourceProperties implementation for ServiceBus.

func (ServiceBus) MarshalJSON

func (sb ServiceBus) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ServiceBus.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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