DigitalTwins interface

Pacote:

@azure/arm-digitaltwins

Interface que representa um DigitalTwins.

Métodos

beginCreateOrUpdate(string, string, DigitalTwinsDescription, DigitalTwinsCreateOrUpdateOptionalParams)	Criar ou atualizar os metadados de um DigitalTwinsInstance. O padrão usual para modificar uma propriedade é recuperar os metadados de segurança e DigitalTwinsInstance e combiná-los com os valores modificados em um novo corpo para atualizar o DigitalTwinsInstance.
beginCreateOrUpdateAndWait(string, string, DigitalTwinsDescription, DigitalTwinsCreateOrUpdateOptionalParams)	Criar ou atualizar os metadados de um DigitalTwinsInstance. O padrão usual para modificar uma propriedade é recuperar os metadados de segurança e DigitalTwinsInstance e combiná-los com os valores modificados em um novo corpo para atualizar o DigitalTwinsInstance.
beginDelete(string, string, DigitalTwinsDeleteOptionalParams)	Exclua um DigitalTwinsInstance.
beginDeleteAndWait(string, string, DigitalTwinsDeleteOptionalParams)	Exclua um DigitalTwinsInstance.
beginUpdate(string, string, DigitalTwinsPatchDescription, DigitalTwinsUpdateOptionalParams)	Atualizar metadados de DigitalTwinsInstance.
beginUpdateAndWait(string, string, DigitalTwinsPatchDescription, DigitalTwinsUpdateOptionalParams)	Atualizar metadados de DigitalTwinsInstance.
checkNameAvailability(string, CheckNameRequest, DigitalTwinsCheckNameAvailabilityOptionalParams)	Verifique se um nome DigitalTwinsInstance está disponível.
get(string, string, DigitalTwinsGetOptionalParams)	Obter o recurso DigitalTwinsInstances.
list(DigitalTwinsListOptionalParams)	Obtenha todas as DigitalTwinsInstances em uma assinatura.
listByResourceGroup(string, DigitalTwinsListByResourceGroupOptionalParams)	Obtenha todas as DigitalTwinsInstances em um grupo de recursos.

Detalhes do método

beginCreateOrUpdate(string, string, DigitalTwinsDescription, DigitalTwinsCreateOrUpdateOptionalParams)

Criar ou atualizar os metadados de um DigitalTwinsInstance. O padrão usual para modificar uma propriedade é recuperar os metadados de segurança e DigitalTwinsInstance e combiná-los com os valores modificados em um novo corpo para atualizar o DigitalTwinsInstance.

function beginCreateOrUpdate(resourceGroupName: string, resourceName: string, digitalTwinsCreate: DigitalTwinsDescription, options?: DigitalTwinsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<DigitalTwinsDescription>, DigitalTwinsDescription>>

Parâmetros

resourceGroupName

string

O nome do grupo de recursos que contém o DigitalTwinsInstance.

resourceName

string

O nome do DigitalTwinsInstance.

digitalTwinsCreate

DigitalTwinsDescription

Os metadados de segurança e DigitalTwinsInstance.

options

DigitalTwinsCreateOrUpdateOptionalParams

Os parâmetros de opções.

Retornos

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

beginCreateOrUpdateAndWait(string, string, DigitalTwinsDescription, DigitalTwinsCreateOrUpdateOptionalParams)

Criar ou atualizar os metadados de um DigitalTwinsInstance. O padrão usual para modificar uma propriedade é recuperar os metadados de segurança e DigitalTwinsInstance e combiná-los com os valores modificados em um novo corpo para atualizar o DigitalTwinsInstance.

function beginCreateOrUpdateAndWait(resourceGroupName: string, resourceName: string, digitalTwinsCreate: DigitalTwinsDescription, options?: DigitalTwinsCreateOrUpdateOptionalParams): Promise<DigitalTwinsDescription>

Parâmetros

resourceGroupName

string

O nome do grupo de recursos que contém o DigitalTwinsInstance.

resourceName

string

O nome do DigitalTwinsInstance.

digitalTwinsCreate

DigitalTwinsDescription

Os metadados de segurança e DigitalTwinsInstance.

options

DigitalTwinsCreateOrUpdateOptionalParams

Os parâmetros de opções.

Retornos

Promise<DigitalTwinsDescription>

beginDelete(string, string, DigitalTwinsDeleteOptionalParams)

Exclua um DigitalTwinsInstance.

function beginDelete(resourceGroupName: string, resourceName: string, options?: DigitalTwinsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<DigitalTwinsDescription>, DigitalTwinsDescription>>

Parâmetros

resourceGroupName

string

O nome do grupo de recursos que contém o DigitalTwinsInstance.

resourceName

string

O nome do DigitalTwinsInstance.

options

DigitalTwinsDeleteOptionalParams

Os parâmetros de opções.

Retornos

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

beginDeleteAndWait(string, string, DigitalTwinsDeleteOptionalParams)

Exclua um DigitalTwinsInstance.

function beginDeleteAndWait(resourceGroupName: string, resourceName: string, options?: DigitalTwinsDeleteOptionalParams): Promise<DigitalTwinsDescription>

Parâmetros

resourceGroupName

string

O nome do grupo de recursos que contém o DigitalTwinsInstance.

resourceName

string

O nome do DigitalTwinsInstance.

options

DigitalTwinsDeleteOptionalParams

Os parâmetros de opções.

Retornos

Promise<DigitalTwinsDescription>

beginUpdate(string, string, DigitalTwinsPatchDescription, DigitalTwinsUpdateOptionalParams)

Atualizar metadados de DigitalTwinsInstance.

function beginUpdate(resourceGroupName: string, resourceName: string, digitalTwinsPatchDescription: DigitalTwinsPatchDescription, options?: DigitalTwinsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<DigitalTwinsDescription>, DigitalTwinsDescription>>

Parâmetros

resourceGroupName

string

O nome do grupo de recursos que contém o DigitalTwinsInstance.

resourceName

string

O nome do DigitalTwinsInstance.

digitalTwinsPatchDescription

DigitalTwinsPatchDescription

Os metadados de segurança e DigitalTwinsInstance.

options

DigitalTwinsUpdateOptionalParams

Os parâmetros de opções.

Retornos

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

beginUpdateAndWait(string, string, DigitalTwinsPatchDescription, DigitalTwinsUpdateOptionalParams)

Atualizar metadados de DigitalTwinsInstance.

function beginUpdateAndWait(resourceGroupName: string, resourceName: string, digitalTwinsPatchDescription: DigitalTwinsPatchDescription, options?: DigitalTwinsUpdateOptionalParams): Promise<DigitalTwinsDescription>

Parâmetros

resourceGroupName

string

O nome do grupo de recursos que contém o DigitalTwinsInstance.

resourceName

string

O nome do DigitalTwinsInstance.

digitalTwinsPatchDescription

DigitalTwinsPatchDescription

Os metadados de segurança e DigitalTwinsInstance.

options

DigitalTwinsUpdateOptionalParams

Os parâmetros de opções.

Retornos

Promise<DigitalTwinsDescription>

checkNameAvailability(string, CheckNameRequest, DigitalTwinsCheckNameAvailabilityOptionalParams)

Verifique se um nome DigitalTwinsInstance está disponível.

function checkNameAvailability(location: string, digitalTwinsInstanceCheckName: CheckNameRequest, options?: DigitalTwinsCheckNameAvailabilityOptionalParams): Promise<CheckNameResult>

Parâmetros

location

string

Local de DigitalTwinsInstance.

digitalTwinsInstanceCheckName

CheckNameRequest

Defina o parâmetro name na estrutura DigitalTwinsInstanceCheckName como o nome do DigitalTwinsInstance a ser verificado.

options

DigitalTwinsCheckNameAvailabilityOptionalParams

Os parâmetros de opções.

Retornos

Promise<CheckNameResult>

get(string, string, DigitalTwinsGetOptionalParams)

Obter o recurso DigitalTwinsInstances.

function get(resourceGroupName: string, resourceName: string, options?: DigitalTwinsGetOptionalParams): Promise<DigitalTwinsDescription>

Parâmetros

resourceGroupName

string

O nome do grupo de recursos que contém o DigitalTwinsInstance.

resourceName

string

O nome do DigitalTwinsInstance.

options

DigitalTwinsGetOptionalParams

Os parâmetros de opções.

Retornos

Promise<DigitalTwinsDescription>

list(DigitalTwinsListOptionalParams)

Obtenha todas as DigitalTwinsInstances em uma assinatura.

function list(options?: DigitalTwinsListOptionalParams): PagedAsyncIterableIterator<DigitalTwinsDescription, DigitalTwinsDescription[], PageSettings>

Parâmetros

options

DigitalTwinsListOptionalParams

Os parâmetros de opções.

Retornos

PagedAsyncIterableIterator<DigitalTwinsDescription, DigitalTwinsDescription[], PageSettings>

listByResourceGroup(string, DigitalTwinsListByResourceGroupOptionalParams)

Obtenha todas as DigitalTwinsInstances em um grupo de recursos.

function listByResourceGroup(resourceGroupName: string, options?: DigitalTwinsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<DigitalTwinsDescription, DigitalTwinsDescription[], PageSettings>

Parâmetros

resourceGroupName

string

O nome do grupo de recursos que contém o DigitalTwinsInstance.

options

DigitalTwinsListByResourceGroupOptionalParams

Os parâmetros de opções.

Retornos

PagedAsyncIterableIterator<DigitalTwinsDescription, DigitalTwinsDescription[], PageSettings>