azure-sdk-for-go: github.com/Azure/azure-sdk-for-go/services/preview/digitaltwins/mgmt/2020-03-01-preview/digitaltwins Index | Files | Directories

package digitaltwins

import "github.com/Azure/azure-sdk-for-go/services/preview/digitaltwins/mgmt/2020-03-01-preview/digitaltwins"

Package digitaltwins implements the Azure ARM Digitaltwins service API version 2020-03-01-preview.

Azure Digital Twins Client for managing DigitalTwinsInstance

Index

Package Files

client.go digitaltwins.go endpoint.go enums.go models.go operations.go version.go

Constants

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

func UserAgent Uses

func UserAgent() string

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

func Version Uses

func Version() string

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

type BaseClient Uses

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

BaseClient is the base client for Digitaltwins.

func New Uses

func New(subscriptionID string) BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI Uses

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 Uses

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

BasicEndpointResourceProperties properties related to Digital Twins Endpoint

type CheckNameRequest Uses

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 Uses

type CheckNameResult struct {
    autorest.Response `json:"-"`
    // NameAvailable - Specifies a Boolean value that indicates if the name is available.
    NameAvailable *bool `json:"nameAvailable,omitempty"`
    // Name - The name that was checked.
    Name *string `json:"name,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 Uses

type Client struct {
    BaseClient
}

Client is the azure Digital Twins Client for managing DigitalTwinsInstance

func NewClient Uses

func NewClient(subscriptionID string) Client

NewClient creates an instance of the Client client.

func NewClientWithBaseURI Uses

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 Uses

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 Uses

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

CheckNameAvailabilityPreparer prepares the CheckNameAvailability request.

func (Client) CheckNameAvailabilityResponder Uses

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 Uses

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 Uses

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 Uses

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (Client) CreateOrUpdateResponder Uses

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 Uses

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 Uses

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 Uses

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

DeletePreparer prepares the Delete request.

func (Client) DeleteResponder Uses

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 Uses

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 Uses

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 Uses

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

GetPreparer prepares the Get request.

func (Client) GetResponder Uses

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 Uses

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 Uses

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

List get all the DigitalTwinsInstances in a subscription.

func (Client) ListByResourceGroup Uses

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 Uses

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 Uses

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

ListByResourceGroupPreparer prepares the ListByResourceGroup request.

func (Client) ListByResourceGroupResponder Uses

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 Uses

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 Uses

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

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

func (Client) ListPreparer Uses

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

ListPreparer prepares the List request.

func (Client) ListResponder Uses

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 Uses

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 Uses

func (client Client) Update(ctx context.Context, resourceGroupName string, resourceName string, digitalTwinsPatchDescription PatchDescription) (result UpdateFuture, 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 Uses

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

UpdatePreparer prepares the Update request.

func (Client) UpdateResponder Uses

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 Uses

func (client Client) UpdateSender(req *http.Request) (future UpdateFuture, err error)

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

type CreateOrUpdateFuture Uses

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.

type DeleteFuture Uses

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.

type Description Uses

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"`
    // Sku - This property is reserved for future use, and will be ignored/omitted
    Sku *SkuInfo `json:"sku,omitempty"`
}

Description the description of the DigitalTwins service.

func (Description) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for Description.

func (*Description) UnmarshalJSON Uses

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

UnmarshalJSON is the custom unmarshaler for Description struct.

type DescriptionListResult Uses

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 Uses

func (dlr DescriptionListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type DescriptionListResultIterator Uses

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

DescriptionListResultIterator provides access to a complete listing of Description values.

func NewDescriptionListResultIterator Uses

func NewDescriptionListResultIterator(page DescriptionListResultPage) DescriptionListResultIterator

Creates a new instance of the DescriptionListResultIterator type.

func (*DescriptionListResultIterator) Next Uses

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 Uses

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 Uses

func (iter DescriptionListResultIterator) NotDone() bool

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

func (DescriptionListResultIterator) Response Uses

func (iter DescriptionListResultIterator) Response() DescriptionListResult

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

func (DescriptionListResultIterator) Value Uses

func (iter DescriptionListResultIterator) Value() Description

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

type DescriptionListResultPage Uses

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

DescriptionListResultPage contains a page of Description values.

func NewDescriptionListResultPage Uses

func NewDescriptionListResultPage(cur DescriptionListResult, getNextPage func(context.Context, DescriptionListResult) (DescriptionListResult, error)) DescriptionListResultPage

Creates a new instance of the DescriptionListResultPage type.

func (*DescriptionListResultPage) Next Uses

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 Uses

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 Uses

func (page DescriptionListResultPage) NotDone() bool

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

func (DescriptionListResultPage) Response Uses

func (page DescriptionListResultPage) Response() DescriptionListResult

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

func (DescriptionListResultPage) Values Uses

func (page DescriptionListResultPage) Values() []Description

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

type EndpointClient Uses

type EndpointClient struct {
    BaseClient
}

EndpointClient is the azure Digital Twins Client for managing DigitalTwinsInstance

func NewEndpointClient Uses

func NewEndpointClient(subscriptionID string) EndpointClient

NewEndpointClient creates an instance of the EndpointClient client.

func NewEndpointClientWithBaseURI Uses

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 Uses

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 Uses

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 Uses

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 Uses

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 Uses

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 Uses

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

DeletePreparer prepares the Delete request.

func (EndpointClient) DeleteResponder Uses

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 Uses

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 Uses

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 Uses

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

GetPreparer prepares the Get request.

func (EndpointClient) GetResponder Uses

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 Uses

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 Uses

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 Uses

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 Uses

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

ListPreparer prepares the List request.

func (EndpointClient) ListResponder Uses

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 Uses

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 Uses

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.

type EndpointDeleteFuture Uses

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.

type EndpointProvisioningState Uses

type EndpointProvisioningState string

EndpointProvisioningState enumerates the values for endpoint provisioning state.

const (
    // Canceled ...
    Canceled EndpointProvisioningState = "Canceled"
    // Deleting ...
    Deleting EndpointProvisioningState = "Deleting"
    // Failed ...
    Failed EndpointProvisioningState = "Failed"
    // Provisioning ...
    Provisioning EndpointProvisioningState = "Provisioning"
    // Succeeded ...
    Succeeded EndpointProvisioningState = "Succeeded"
)

func PossibleEndpointProvisioningStateValues Uses

func PossibleEndpointProvisioningStateValues() []EndpointProvisioningState

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

type EndpointResource Uses

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 Uses

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

MarshalJSON is the custom marshaler for EndpointResource.

func (*EndpointResource) UnmarshalJSON Uses

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

UnmarshalJSON is the custom unmarshaler for EndpointResource struct.

type EndpointResourceListResult Uses

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 Uses

func (erlr EndpointResourceListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type EndpointResourceListResultIterator Uses

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

EndpointResourceListResultIterator provides access to a complete listing of EndpointResource values.

func NewEndpointResourceListResultIterator Uses

func NewEndpointResourceListResultIterator(page EndpointResourceListResultPage) EndpointResourceListResultIterator

Creates a new instance of the EndpointResourceListResultIterator type.

func (*EndpointResourceListResultIterator) Next Uses

func (iter *EndpointResourceListResultIterator) 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 (*EndpointResourceListResultIterator) NextWithContext Uses

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 Uses

func (iter EndpointResourceListResultIterator) NotDone() bool

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

func (EndpointResourceListResultIterator) Response Uses

func (iter EndpointResourceListResultIterator) Response() EndpointResourceListResult

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

func (EndpointResourceListResultIterator) Value Uses

func (iter EndpointResourceListResultIterator) Value() EndpointResource

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

type EndpointResourceListResultPage Uses

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

EndpointResourceListResultPage contains a page of EndpointResource values.

func NewEndpointResourceListResultPage Uses

func NewEndpointResourceListResultPage(cur EndpointResourceListResult, getNextPage func(context.Context, EndpointResourceListResult) (EndpointResourceListResult, error)) EndpointResourceListResultPage

Creates a new instance of the EndpointResourceListResultPage type.

func (*EndpointResourceListResultPage) Next Uses

func (page *EndpointResourceListResultPage) 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 (*EndpointResourceListResultPage) NextWithContext Uses

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 Uses

func (page EndpointResourceListResultPage) NotDone() bool

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

func (EndpointResourceListResultPage) Response Uses

func (page EndpointResourceListResultPage) Response() EndpointResourceListResult

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

func (EndpointResourceListResultPage) Values Uses

func (page EndpointResourceListResultPage) Values() []EndpointResource

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

type EndpointResourceProperties Uses

type EndpointResourceProperties struct {
    // ProvisioningState - READ-ONLY; The provisioning state. Possible values include: 'Provisioning', 'Deleting', 'Succeeded', 'Failed', 'Canceled'
    ProvisioningState EndpointProvisioningState `json:"provisioningState,omitempty"`
    // CreatedTime - READ-ONLY; Time when the Endpoint was added to DigitalTwinsInstance.
    CreatedTime *date.Time `json:"createdTime,omitempty"`
    // Tags - The resource tags.
    Tags map[string]*string `json:"tags"`
    // EndpointType - Possible values include: 'EndpointTypeDigitalTwinsEndpointResourceProperties', 'EndpointTypeServiceBus', 'EndpointTypeEventHub', 'EndpointTypeEventGrid'
    EndpointType EndpointType `json:"endpointType,omitempty"`
}

EndpointResourceProperties properties related to Digital Twins Endpoint

func (EndpointResourceProperties) AsBasicEndpointResourceProperties Uses

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

AsBasicEndpointResourceProperties is the BasicEndpointResourceProperties implementation for EndpointResourceProperties.

func (EndpointResourceProperties) AsEndpointResourceProperties Uses

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

AsEndpointResourceProperties is the BasicEndpointResourceProperties implementation for EndpointResourceProperties.

func (EndpointResourceProperties) AsEventGrid Uses

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

AsEventGrid is the BasicEndpointResourceProperties implementation for EndpointResourceProperties.

func (EndpointResourceProperties) AsEventHub Uses

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

AsEventHub is the BasicEndpointResourceProperties implementation for EndpointResourceProperties.

func (EndpointResourceProperties) AsServiceBus Uses

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

AsServiceBus is the BasicEndpointResourceProperties implementation for EndpointResourceProperties.

func (EndpointResourceProperties) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for EndpointResourceProperties.

type EndpointType Uses

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 Uses

func PossibleEndpointTypeValues() []EndpointType

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

type ErrorDefinition Uses

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.

type ErrorResponse Uses

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

ErrorResponse error response.

type EventGrid Uses

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'
    ProvisioningState EndpointProvisioningState `json:"provisioningState,omitempty"`
    // CreatedTime - READ-ONLY; Time when the Endpoint was added to DigitalTwinsInstance.
    CreatedTime *date.Time `json:"createdTime,omitempty"`
    // Tags - The resource tags.
    Tags map[string]*string `json:"tags"`
    // EndpointType - Possible values include: 'EndpointTypeDigitalTwinsEndpointResourceProperties', 'EndpointTypeServiceBus', 'EndpointTypeEventHub', 'EndpointTypeEventGrid'
    EndpointType EndpointType `json:"endpointType,omitempty"`
}

EventGrid properties related to eventgrid.

func (EventGrid) AsBasicEndpointResourceProperties Uses

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

AsBasicEndpointResourceProperties is the BasicEndpointResourceProperties implementation for EventGrid.

func (EventGrid) AsEndpointResourceProperties Uses

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

AsEndpointResourceProperties is the BasicEndpointResourceProperties implementation for EventGrid.

func (EventGrid) AsEventGrid Uses

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

AsEventGrid is the BasicEndpointResourceProperties implementation for EventGrid.

func (EventGrid) AsEventHub Uses

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

AsEventHub is the BasicEndpointResourceProperties implementation for EventGrid.

func (EventGrid) AsServiceBus Uses

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

AsServiceBus is the BasicEndpointResourceProperties implementation for EventGrid.

func (EventGrid) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for EventGrid.

type EventHub Uses

type EventHub struct {
    // ConnectionStringPrimaryKey - PrimaryConnectionString of the endpoint. Will be obfuscated during read
    ConnectionStringPrimaryKey *string `json:"connectionString-PrimaryKey,omitempty"`
    // ConnectionStringSecondaryKey - SecondaryConnectionString of the endpoint. Will be obfuscated during read
    ConnectionStringSecondaryKey *string `json:"connectionString-SecondaryKey,omitempty"`
    // ProvisioningState - READ-ONLY; The provisioning state. Possible values include: 'Provisioning', 'Deleting', 'Succeeded', 'Failed', 'Canceled'
    ProvisioningState EndpointProvisioningState `json:"provisioningState,omitempty"`
    // CreatedTime - READ-ONLY; Time when the Endpoint was added to DigitalTwinsInstance.
    CreatedTime *date.Time `json:"createdTime,omitempty"`
    // Tags - The resource tags.
    Tags map[string]*string `json:"tags"`
    // EndpointType - Possible values include: 'EndpointTypeDigitalTwinsEndpointResourceProperties', 'EndpointTypeServiceBus', 'EndpointTypeEventHub', 'EndpointTypeEventGrid'
    EndpointType EndpointType `json:"endpointType,omitempty"`
}

EventHub properties related to eventhub.

func (EventHub) AsBasicEndpointResourceProperties Uses

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

AsBasicEndpointResourceProperties is the BasicEndpointResourceProperties implementation for EventHub.

func (EventHub) AsEndpointResourceProperties Uses

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

AsEndpointResourceProperties is the BasicEndpointResourceProperties implementation for EventHub.

func (EventHub) AsEventGrid Uses

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

AsEventGrid is the BasicEndpointResourceProperties implementation for EventHub.

func (EventHub) AsEventHub Uses

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

AsEventHub is the BasicEndpointResourceProperties implementation for EventHub.

func (EventHub) AsServiceBus Uses

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

AsServiceBus is the BasicEndpointResourceProperties implementation for EventHub.

func (EventHub) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for EventHub.

type ExternalResource Uses

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.

type Operation Uses

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"`
}

Operation digitalTwins service REST API operation

func (Operation) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for Operation.

type OperationDisplay Uses

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.

type OperationListResult Uses

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 Uses

func (olr OperationListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

func (OperationListResult) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for OperationListResult.

type OperationListResultIterator Uses

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

OperationListResultIterator provides access to a complete listing of Operation values.

func NewOperationListResultIterator Uses

func NewOperationListResultIterator(page OperationListResultPage) OperationListResultIterator

Creates a new instance of the OperationListResultIterator type.

func (*OperationListResultIterator) Next Uses

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 Uses

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 Uses

func (iter OperationListResultIterator) NotDone() bool

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

func (OperationListResultIterator) Response Uses

func (iter OperationListResultIterator) Response() OperationListResult

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

func (OperationListResultIterator) Value Uses

func (iter OperationListResultIterator) Value() Operation

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

type OperationListResultPage Uses

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

OperationListResultPage contains a page of Operation values.

func NewOperationListResultPage Uses

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

Creates a new instance of the OperationListResultPage type.

func (*OperationListResultPage) Next Uses

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 Uses

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 Uses

func (page OperationListResultPage) NotDone() bool

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

func (OperationListResultPage) Response Uses

func (page OperationListResultPage) Response() OperationListResult

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

func (OperationListResultPage) Values Uses

func (page OperationListResultPage) Values() []Operation

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

type OperationsClient Uses

type OperationsClient struct {
    BaseClient
}

OperationsClient is the azure Digital Twins Client for managing DigitalTwinsInstance

func NewOperationsClient Uses

func NewOperationsClient(subscriptionID string) OperationsClient

NewOperationsClient creates an instance of the OperationsClient client.

func NewOperationsClientWithBaseURI Uses

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 Uses

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 Uses

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

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

func (OperationsClient) ListPreparer Uses

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

ListPreparer prepares the List request.

func (OperationsClient) ListResponder Uses

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 Uses

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 Uses

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

PatchDescription the description of the DigitalTwins service.

func (PatchDescription) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for PatchDescription.

type Properties Uses

type Properties struct {
    // CreatedTime - READ-ONLY; Time when DigitalTwinsInstance was created.
    CreatedTime *date.Time `json:"createdTime,omitempty"`
    // LastUpdatedTime - READ-ONLY; Time when DigitalTwinsInstance was created.
    LastUpdatedTime *date.Time `json:"lastUpdatedTime,omitempty"`
    // ProvisioningState - READ-ONLY; The provisioning state. Possible values include: 'ProvisioningStateProvisioning', 'ProvisioningStateDeleting', 'ProvisioningStateSucceeded', 'ProvisioningStateFailed', 'ProvisioningStateCanceled'
    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.

type ProvisioningState Uses

type ProvisioningState string

ProvisioningState enumerates the values for provisioning state.

const (
    // ProvisioningStateCanceled ...
    ProvisioningStateCanceled ProvisioningState = "Canceled"
    // ProvisioningStateDeleting ...
    ProvisioningStateDeleting ProvisioningState = "Deleting"
    // ProvisioningStateFailed ...
    ProvisioningStateFailed ProvisioningState = "Failed"
    // ProvisioningStateProvisioning ...
    ProvisioningStateProvisioning ProvisioningState = "Provisioning"
    // ProvisioningStateSucceeded ...
    ProvisioningStateSucceeded ProvisioningState = "Succeeded"
)

func PossibleProvisioningStateValues Uses

func PossibleProvisioningStateValues() []ProvisioningState

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

type Reason Uses

type Reason string

Reason enumerates the values for reason.

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

func PossibleReasonValues Uses

func PossibleReasonValues() []Reason

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

type Resource Uses

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"`
    // Sku - This property is reserved for future use, and will be ignored/omitted
    Sku *SkuInfo `json:"sku,omitempty"`
}

Resource the common properties of a DigitalTwinsInstance.

func (Resource) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for Resource.

type ServiceBus Uses

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'
    ProvisioningState EndpointProvisioningState `json:"provisioningState,omitempty"`
    // CreatedTime - READ-ONLY; Time when the Endpoint was added to DigitalTwinsInstance.
    CreatedTime *date.Time `json:"createdTime,omitempty"`
    // Tags - The resource tags.
    Tags map[string]*string `json:"tags"`
    // EndpointType - Possible values include: 'EndpointTypeDigitalTwinsEndpointResourceProperties', 'EndpointTypeServiceBus', 'EndpointTypeEventHub', 'EndpointTypeEventGrid'
    EndpointType EndpointType `json:"endpointType,omitempty"`
}

ServiceBus properties related to servicebus.

func (ServiceBus) AsBasicEndpointResourceProperties Uses

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

AsBasicEndpointResourceProperties is the BasicEndpointResourceProperties implementation for ServiceBus.

func (ServiceBus) AsEndpointResourceProperties Uses

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

AsEndpointResourceProperties is the BasicEndpointResourceProperties implementation for ServiceBus.

func (ServiceBus) AsEventGrid Uses

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

AsEventGrid is the BasicEndpointResourceProperties implementation for ServiceBus.

func (ServiceBus) AsEventHub Uses

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

AsEventHub is the BasicEndpointResourceProperties implementation for ServiceBus.

func (ServiceBus) AsServiceBus Uses

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

AsServiceBus is the BasicEndpointResourceProperties implementation for ServiceBus.

func (ServiceBus) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for ServiceBus.

type SkuInfo Uses

type SkuInfo struct {
    // Name - The name of the SKU.
    Name *string `json:"name,omitempty"`
}

SkuInfo information about the SKU of the DigitalTwinsInstance.

type UpdateFuture Uses

type UpdateFuture 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)
}

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

Directories

PathSynopsis
digitaltwinsapi

Package digitaltwins imports 10 packages (graph) and is imported by 1 packages. Updated 2021-01-25. Refresh now. Tools for package owners.