DigitalTwinsEndpoint interface

Package:

@azure/arm-digitaltwins

Interface representing a DigitalTwinsEndpoint.

Methods

beginCreateOrUpdate(string, string, string, DigitalTwinsEndpointResource, DigitalTwinsEndpointCreateOrUpdateOptionalParams)	Create or update DigitalTwinsInstance endpoint.
beginCreateOrUpdateAndWait(string, string, string, DigitalTwinsEndpointResource, DigitalTwinsEndpointCreateOrUpdateOptionalParams)	Create or update DigitalTwinsInstance endpoint.
beginDelete(string, string, string, DigitalTwinsEndpointDeleteOptionalParams)	Delete a DigitalTwinsInstance endpoint.
beginDeleteAndWait(string, string, string, DigitalTwinsEndpointDeleteOptionalParams)	Delete a DigitalTwinsInstance endpoint.
get(string, string, string, DigitalTwinsEndpointGetOptionalParams)	Get DigitalTwinsInstances Endpoint.
list(string, string, DigitalTwinsEndpointListOptionalParams)	Get DigitalTwinsInstance Endpoints.

Method Details

beginCreateOrUpdate(string, string, string, DigitalTwinsEndpointResource, DigitalTwinsEndpointCreateOrUpdateOptionalParams)

Create or update DigitalTwinsInstance endpoint.

function beginCreateOrUpdate(resourceGroupName: string, resourceName: string, endpointName: string, endpointDescription: DigitalTwinsEndpointResource, options?: DigitalTwinsEndpointCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<DigitalTwinsEndpointResource>, DigitalTwinsEndpointResource>>

Parameters

resourceGroupName

string

The name of the resource group that contains the DigitalTwinsInstance.

resourceName

string

The name of the DigitalTwinsInstance.

endpointName

string

Name of Endpoint Resource.

endpointDescription

DigitalTwinsEndpointResource

The DigitalTwinsInstance endpoint metadata and security metadata.

options

DigitalTwinsEndpointCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<DigitalTwinsEndpointResource>, DigitalTwinsEndpointResource>>

beginCreateOrUpdateAndWait(string, string, string, DigitalTwinsEndpointResource, DigitalTwinsEndpointCreateOrUpdateOptionalParams)

Create or update DigitalTwinsInstance endpoint.

function beginCreateOrUpdateAndWait(resourceGroupName: string, resourceName: string, endpointName: string, endpointDescription: DigitalTwinsEndpointResource, options?: DigitalTwinsEndpointCreateOrUpdateOptionalParams): Promise<DigitalTwinsEndpointResource>

Parameters

resourceGroupName

string

The name of the resource group that contains the DigitalTwinsInstance.

resourceName

string

The name of the DigitalTwinsInstance.

endpointName

string

Name of Endpoint Resource.

endpointDescription

DigitalTwinsEndpointResource

The DigitalTwinsInstance endpoint metadata and security metadata.

options

DigitalTwinsEndpointCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<DigitalTwinsEndpointResource>

beginDelete(string, string, string, DigitalTwinsEndpointDeleteOptionalParams)

Delete a DigitalTwinsInstance endpoint.

function beginDelete(resourceGroupName: string, resourceName: string, endpointName: string, options?: DigitalTwinsEndpointDeleteOptionalParams): Promise<SimplePollerLike<OperationState<DigitalTwinsEndpointResource>, DigitalTwinsEndpointResource>>

Parameters

resourceGroupName

string

The name of the resource group that contains the DigitalTwinsInstance.

resourceName

string

The name of the DigitalTwinsInstance.

endpointName

string

Name of Endpoint Resource.

options

DigitalTwinsEndpointDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<DigitalTwinsEndpointResource>, DigitalTwinsEndpointResource>>

beginDeleteAndWait(string, string, string, DigitalTwinsEndpointDeleteOptionalParams)

Delete a DigitalTwinsInstance endpoint.

function beginDeleteAndWait(resourceGroupName: string, resourceName: string, endpointName: string, options?: DigitalTwinsEndpointDeleteOptionalParams): Promise<DigitalTwinsEndpointResource>

Parameters

resourceGroupName

string

The name of the resource group that contains the DigitalTwinsInstance.

resourceName

string

The name of the DigitalTwinsInstance.

endpointName

string

Name of Endpoint Resource.

options

DigitalTwinsEndpointDeleteOptionalParams

The options parameters.

Returns

Promise<DigitalTwinsEndpointResource>

get(string, string, string, DigitalTwinsEndpointGetOptionalParams)

Get DigitalTwinsInstances Endpoint.

function get(resourceGroupName: string, resourceName: string, endpointName: string, options?: DigitalTwinsEndpointGetOptionalParams): Promise<DigitalTwinsEndpointResource>

Parameters

resourceGroupName

string

The name of the resource group that contains the DigitalTwinsInstance.

resourceName

string

The name of the DigitalTwinsInstance.

endpointName

string

Name of Endpoint Resource.

options

DigitalTwinsEndpointGetOptionalParams

The options parameters.

Returns

Promise<DigitalTwinsEndpointResource>

list(string, string, DigitalTwinsEndpointListOptionalParams)

Get DigitalTwinsInstance Endpoints.

function list(resourceGroupName: string, resourceName: string, options?: DigitalTwinsEndpointListOptionalParams): PagedAsyncIterableIterator<DigitalTwinsEndpointResource, DigitalTwinsEndpointResource[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group that contains the DigitalTwinsInstance.

resourceName

string

The name of the DigitalTwinsInstance.

options

DigitalTwinsEndpointListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<DigitalTwinsEndpointResource, DigitalTwinsEndpointResource[], PageSettings>