IotDpsResource interface
Interface que representa um IotDpsResource.
Métodos
| begin |
Crie ou atualize os metadados do serviço de provisionamento. O padrão usual para modificar uma propriedade é recuperar os metadados de serviço de provisionamento e os metadados de segurança e combiná-los com os valores modificados em um novo corpo para atualizar o serviço de provisionamento. |
| begin |
Crie ou atualize os metadados do serviço de provisionamento. O padrão usual para modificar uma propriedade é recuperar os metadados de serviço de provisionamento e os metadados de segurança e combiná-los com os valores modificados em um novo corpo para atualizar o serviço de provisionamento. |
| begin |
Criar ou atualizar o status de uma conexão de ponto de extremidade privado com o nome especificado |
| begin |
Criar ou atualizar o status de uma conexão de ponto de extremidade privado com o nome especificado |
| begin |
Exclui o Serviço de Provisionamento. |
| begin |
Exclui o Serviço de Provisionamento. |
| begin |
Excluir conexão de ponto de extremidade privado com o nome especificado |
| begin |
Excluir conexão de ponto de extremidade privado com o nome especificado |
| begin |
Atualize as marcas de um serviço de provisionamento existente. para atualizar outros campos, use o método CreateOrUpdate |
| begin |
Atualize as marcas de um serviço de provisionamento existente. para atualizar outros campos, use o método CreateOrUpdate |
| check |
Verifique se um nome de serviço de provisionamento está disponível. Isso validará se o nome é sintaticamente válido e se o nome é utilizável |
| get(string, string, Iot |
Obtenha os metadados do serviço de provisionamento sem chaves SAS. |
| get |
Obtém o status de uma operação de execução longa, como criar, atualizar ou excluir um serviço de provisionamento. |
| get |
Obter propriedades de conexão de ponto de extremidade privado |
| get |
Obter o recurso de link privado especificado para o serviço de provisionamento especificado |
| list |
Obtenha uma lista de todos os serviços de provisionamento no grupo de recursos especificado. |
| list |
Liste todos os serviços de provisionamento para uma determinada ID de assinatura. |
| list |
Liste as chaves primárias e secundárias para um serviço de provisionamento. |
| list |
Listar chaves primárias e secundárias para um nome de chave específico |
| list |
Listar propriedades de conexão de ponto de extremidade privado |
| list |
Listar recursos de link privado para o serviço de provisionamento especificado |
| list |
Obtém a lista de SKUs e camadas válidas para um serviço de provisionamento. |
Detalhes do método
beginCreateOrUpdate(string, string, ProvisioningServiceDescription, IotDpsResourceCreateOrUpdateOptionalParams)
Crie ou atualize os metadados do serviço de provisionamento. O padrão usual para modificar uma propriedade é recuperar os metadados de serviço de provisionamento e os metadados de segurança e combiná-los com os valores modificados em um novo corpo para atualizar o serviço de provisionamento.
function beginCreateOrUpdate(resourceGroupName: string, provisioningServiceName: string, iotDpsDescription: ProvisioningServiceDescription, options?: IotDpsResourceCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<ProvisioningServiceDescription>, ProvisioningServiceDescription>>Parâmetros
- resourceGroupName
-
string
Identificador do grupo de recursos.
- provisioningServiceName
-
string
Nome do serviço de provisionamento para criar ou atualizar.
- iotDpsDescription
- ProvisioningServiceDescription
Descrição do serviço de provisionamento a ser criado ou atualizado.
Os parâmetros de opções.
Retornos
Promise<PollerLike<@azure/core-lro.PollOperationState<ProvisioningServiceDescription>, ProvisioningServiceDescription>>
beginCreateOrUpdateAndWait(string, string, ProvisioningServiceDescription, IotDpsResourceCreateOrUpdateOptionalParams)
Crie ou atualize os metadados do serviço de provisionamento. O padrão usual para modificar uma propriedade é recuperar os metadados de serviço de provisionamento e os metadados de segurança e combiná-los com os valores modificados em um novo corpo para atualizar o serviço de provisionamento.
function beginCreateOrUpdateAndWait(resourceGroupName: string, provisioningServiceName: string, iotDpsDescription: ProvisioningServiceDescription, options?: IotDpsResourceCreateOrUpdateOptionalParams): Promise<ProvisioningServiceDescription>Parâmetros
- resourceGroupName
-
string
Identificador do grupo de recursos.
- provisioningServiceName
-
string
Nome do serviço de provisionamento para criar ou atualizar.
- iotDpsDescription
- ProvisioningServiceDescription
Descrição do serviço de provisionamento a ser criado ou atualizado.
Os parâmetros de opções.
Retornos
Promise<ProvisioningServiceDescription>
beginCreateOrUpdatePrivateEndpointConnection(string, string, string, PrivateEndpointConnection, IotDpsResourceCreateOrUpdatePrivateEndpointConnectionOptionalParams)
Criar ou atualizar o status de uma conexão de ponto de extremidade privado com o nome especificado
function beginCreateOrUpdatePrivateEndpointConnection(resourceGroupName: string, resourceName: string, privateEndpointConnectionName: string, privateEndpointConnection: PrivateEndpointConnection, options?: IotDpsResourceCreateOrUpdatePrivateEndpointConnectionOptionalParams): Promise<PollerLike<PollOperationState<PrivateEndpointConnection>, PrivateEndpointConnection>>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos que contém o serviço de provisionamento.
- resourceName
-
string
O nome do serviço de provisionamento.
- privateEndpointConnectionName
-
string
O nome da conexão de ponto de extremidade privado
- privateEndpointConnection
- PrivateEndpointConnection
A conexão de ponto de extremidade privado com as propriedades atualizadas
Os parâmetros de opções.
Retornos
Promise<PollerLike<@azure/core-lro.PollOperationState<PrivateEndpointConnection>, PrivateEndpointConnection>>
beginCreateOrUpdatePrivateEndpointConnectionAndWait(string, string, string, PrivateEndpointConnection, IotDpsResourceCreateOrUpdatePrivateEndpointConnectionOptionalParams)
Criar ou atualizar o status de uma conexão de ponto de extremidade privado com o nome especificado
function beginCreateOrUpdatePrivateEndpointConnectionAndWait(resourceGroupName: string, resourceName: string, privateEndpointConnectionName: string, privateEndpointConnection: PrivateEndpointConnection, options?: IotDpsResourceCreateOrUpdatePrivateEndpointConnectionOptionalParams): Promise<PrivateEndpointConnection>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos que contém o serviço de provisionamento.
- resourceName
-
string
O nome do serviço de provisionamento.
- privateEndpointConnectionName
-
string
O nome da conexão de ponto de extremidade privado
- privateEndpointConnection
- PrivateEndpointConnection
A conexão de ponto de extremidade privado com as propriedades atualizadas
Os parâmetros de opções.
Retornos
Promise<PrivateEndpointConnection>
beginDelete(string, string, IotDpsResourceDeleteOptionalParams)
Exclui o Serviço de Provisionamento.
function beginDelete(provisioningServiceName: string, resourceGroupName: string, options?: IotDpsResourceDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parâmetros
- provisioningServiceName
-
string
Nome do serviço de provisionamento a ser excluído.
- resourceGroupName
-
string
Identificador do grupo de recursos.
Os parâmetros de opções.
Retornos
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginDeleteAndWait(string, string, IotDpsResourceDeleteOptionalParams)
Exclui o Serviço de Provisionamento.
function beginDeleteAndWait(provisioningServiceName: string, resourceGroupName: string, options?: IotDpsResourceDeleteOptionalParams): Promise<void>Parâmetros
- provisioningServiceName
-
string
Nome do serviço de provisionamento a ser excluído.
- resourceGroupName
-
string
Identificador do grupo de recursos.
Os parâmetros de opções.
Retornos
Promise<void>
beginDeletePrivateEndpointConnection(string, string, string, IotDpsResourceDeletePrivateEndpointConnectionOptionalParams)
Excluir conexão de ponto de extremidade privado com o nome especificado
function beginDeletePrivateEndpointConnection(resourceGroupName: string, resourceName: string, privateEndpointConnectionName: string, options?: IotDpsResourceDeletePrivateEndpointConnectionOptionalParams): Promise<PollerLike<PollOperationState<PrivateEndpointConnection>, PrivateEndpointConnection>>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos que contém o serviço de provisionamento.
- resourceName
-
string
O nome do serviço de provisionamento.
- privateEndpointConnectionName
-
string
O nome da conexão de ponto de extremidade privado
Os parâmetros de opções.
Retornos
Promise<PollerLike<@azure/core-lro.PollOperationState<PrivateEndpointConnection>, PrivateEndpointConnection>>
beginDeletePrivateEndpointConnectionAndWait(string, string, string, IotDpsResourceDeletePrivateEndpointConnectionOptionalParams)
Excluir conexão de ponto de extremidade privado com o nome especificado
function beginDeletePrivateEndpointConnectionAndWait(resourceGroupName: string, resourceName: string, privateEndpointConnectionName: string, options?: IotDpsResourceDeletePrivateEndpointConnectionOptionalParams): Promise<PrivateEndpointConnection>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos que contém o serviço de provisionamento.
- resourceName
-
string
O nome do serviço de provisionamento.
- privateEndpointConnectionName
-
string
O nome da conexão de ponto de extremidade privado
Os parâmetros de opções.
Retornos
Promise<PrivateEndpointConnection>
beginUpdate(string, string, TagsResource, IotDpsResourceUpdateOptionalParams)
Atualize as marcas de um serviço de provisionamento existente. para atualizar outros campos, use o método CreateOrUpdate
function beginUpdate(resourceGroupName: string, provisioningServiceName: string, provisioningServiceTags: TagsResource, options?: IotDpsResourceUpdateOptionalParams): Promise<PollerLike<PollOperationState<ProvisioningServiceDescription>, ProvisioningServiceDescription>>Parâmetros
- resourceGroupName
-
string
Identificador do grupo de recursos.
- provisioningServiceName
-
string
Nome do serviço de provisionamento para criar ou atualizar.
- provisioningServiceTags
- TagsResource
Informações de marca atualizadas para definir na instância do serviço de provisionamento.
Os parâmetros de opções.
Retornos
Promise<PollerLike<@azure/core-lro.PollOperationState<ProvisioningServiceDescription>, ProvisioningServiceDescription>>
beginUpdateAndWait(string, string, TagsResource, IotDpsResourceUpdateOptionalParams)
Atualize as marcas de um serviço de provisionamento existente. para atualizar outros campos, use o método CreateOrUpdate
function beginUpdateAndWait(resourceGroupName: string, provisioningServiceName: string, provisioningServiceTags: TagsResource, options?: IotDpsResourceUpdateOptionalParams): Promise<ProvisioningServiceDescription>Parâmetros
- resourceGroupName
-
string
Identificador do grupo de recursos.
- provisioningServiceName
-
string
Nome do serviço de provisionamento para criar ou atualizar.
- provisioningServiceTags
- TagsResource
Informações de marca atualizadas para definir na instância do serviço de provisionamento.
Os parâmetros de opções.
Retornos
Promise<ProvisioningServiceDescription>
checkProvisioningServiceNameAvailability(OperationInputs, IotDpsResourceCheckProvisioningServiceNameAvailabilityOptionalParams)
Verifique se um nome de serviço de provisionamento está disponível. Isso validará se o nome é sintaticamente válido e se o nome é utilizável
function checkProvisioningServiceNameAvailability(argumentsParam: OperationInputs, options?: IotDpsResourceCheckProvisioningServiceNameAvailabilityOptionalParams): Promise<NameAvailabilityInfo>Parâmetros
- argumentsParam
- OperationInputs
Defina o parâmetro de nome na estrutura OperationInputs como o nome do serviço de provisionamento a ser verificado.
Os parâmetros de opções.
Retornos
Promise<NameAvailabilityInfo>
get(string, string, IotDpsResourceGetOptionalParams)
Obtenha os metadados do serviço de provisionamento sem chaves SAS.
function get(provisioningServiceName: string, resourceGroupName: string, options?: IotDpsResourceGetOptionalParams): Promise<ProvisioningServiceDescription>Parâmetros
- provisioningServiceName
-
string
Nome do serviço de provisionamento a ser recuperado.
- resourceGroupName
-
string
Nome do grupo de recursos.
- options
- IotDpsResourceGetOptionalParams
Os parâmetros de opções.
Retornos
Promise<ProvisioningServiceDescription>
getOperationResult(string, string, string, string, IotDpsResourceGetOperationResultOptionalParams)
Obtém o status de uma operação de execução longa, como criar, atualizar ou excluir um serviço de provisionamento.
function getOperationResult(operationId: string, resourceGroupName: string, provisioningServiceName: string, asyncinfo: string, options?: IotDpsResourceGetOperationResultOptionalParams): Promise<AsyncOperationResult>Parâmetros
- operationId
-
string
ID da operação correspondente à operação de execução prolongada. Use isso para sondar o status.
- resourceGroupName
-
string
Identificador do grupo de recursos.
- provisioningServiceName
-
string
Nome do serviço de provisionamento no qual a operação está em execução.
- asyncinfo
-
string
Cabeçalho assíncrono usado para sondar o status da operação, obtido durante a criação da operação de execução prolongada.
Os parâmetros de opções.
Retornos
Promise<AsyncOperationResult>
getPrivateEndpointConnection(string, string, string, IotDpsResourceGetPrivateEndpointConnectionOptionalParams)
Obter propriedades de conexão de ponto de extremidade privado
function getPrivateEndpointConnection(resourceGroupName: string, resourceName: string, privateEndpointConnectionName: string, options?: IotDpsResourceGetPrivateEndpointConnectionOptionalParams): Promise<PrivateEndpointConnection>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos que contém o serviço de provisionamento.
- resourceName
-
string
O nome do serviço de provisionamento.
- privateEndpointConnectionName
-
string
O nome da conexão de ponto de extremidade privado
Os parâmetros de opções.
Retornos
Promise<PrivateEndpointConnection>
getPrivateLinkResources(string, string, string, IotDpsResourceGetPrivateLinkResourcesOptionalParams)
Obter o recurso de link privado especificado para o serviço de provisionamento especificado
function getPrivateLinkResources(resourceGroupName: string, resourceName: string, groupId: string, options?: IotDpsResourceGetPrivateLinkResourcesOptionalParams): Promise<GroupIdInformation>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos que contém o serviço de provisionamento.
- resourceName
-
string
O nome do serviço de provisionamento.
- groupId
-
string
O nome do recurso de link privado
Os parâmetros de opções.
Retornos
Promise<GroupIdInformation>
listByResourceGroup(string, IotDpsResourceListByResourceGroupOptionalParams)
Obtenha uma lista de todos os serviços de provisionamento no grupo de recursos especificado.
function listByResourceGroup(resourceGroupName: string, options?: IotDpsResourceListByResourceGroupOptionalParams): PagedAsyncIterableIterator<ProvisioningServiceDescription, ProvisioningServiceDescription[], PageSettings>Parâmetros
- resourceGroupName
-
string
Identificador do grupo de recursos.
Os parâmetros de opções.
Retornos
listBySubscription(IotDpsResourceListBySubscriptionOptionalParams)
Liste todos os serviços de provisionamento para uma determinada ID de assinatura.
function listBySubscription(options?: IotDpsResourceListBySubscriptionOptionalParams): PagedAsyncIterableIterator<ProvisioningServiceDescription, ProvisioningServiceDescription[], PageSettings>Parâmetros
Os parâmetros de opções.
Retornos
listKeys(string, string, IotDpsResourceListKeysOptionalParams)
Liste as chaves primárias e secundárias para um serviço de provisionamento.
function listKeys(provisioningServiceName: string, resourceGroupName: string, options?: IotDpsResourceListKeysOptionalParams): PagedAsyncIterableIterator<SharedAccessSignatureAuthorizationRuleAccessRightsDescription, SharedAccessSignatureAuthorizationRuleAccessRightsDescription[], PageSettings>Parâmetros
- provisioningServiceName
-
string
O nome do serviço de provisionamento para o qual obter as chaves de acesso compartilhado.
- resourceGroupName
-
string
nome do grupo de recursos
Os parâmetros de opções.
Retornos
listKeysForKeyName(string, string, string, IotDpsResourceListKeysForKeyNameOptionalParams)
Listar chaves primárias e secundárias para um nome de chave específico
function listKeysForKeyName(provisioningServiceName: string, keyName: string, resourceGroupName: string, options?: IotDpsResourceListKeysForKeyNameOptionalParams): Promise<SharedAccessSignatureAuthorizationRuleAccessRightsDescription>Parâmetros
- provisioningServiceName
-
string
Nome do serviço de provisionamento.
- keyName
-
string
Nome da chave lógica para o qual obter valores-chave.
- resourceGroupName
-
string
O nome do grupo de recursos que contém o serviço de provisionamento.
Os parâmetros de opções.
Retornos
listPrivateEndpointConnections(string, string, IotDpsResourceListPrivateEndpointConnectionsOptionalParams)
Listar propriedades de conexão de ponto de extremidade privado
function listPrivateEndpointConnections(resourceGroupName: string, resourceName: string, options?: IotDpsResourceListPrivateEndpointConnectionsOptionalParams): Promise<IotDpsResourceListPrivateEndpointConnectionsResponse>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos que contém o serviço de provisionamento.
- resourceName
-
string
O nome do serviço de provisionamento.
Os parâmetros de opções.
Retornos
listPrivateLinkResources(string, string, IotDpsResourceListPrivateLinkResourcesOptionalParams)
Listar recursos de link privado para o serviço de provisionamento especificado
function listPrivateLinkResources(resourceGroupName: string, resourceName: string, options?: IotDpsResourceListPrivateLinkResourcesOptionalParams): Promise<PrivateLinkResources>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos que contém o serviço de provisionamento.
- resourceName
-
string
O nome do serviço de provisionamento.
Os parâmetros de opções.
Retornos
Promise<PrivateLinkResources>
listValidSkus(string, string, IotDpsResourceListValidSkusOptionalParams)
Obtém a lista de SKUs e camadas válidas para um serviço de provisionamento.
function listValidSkus(provisioningServiceName: string, resourceGroupName: string, options?: IotDpsResourceListValidSkusOptionalParams): PagedAsyncIterableIterator<IotDpsSkuDefinition, IotDpsSkuDefinition[], PageSettings>Parâmetros
- provisioningServiceName
-
string
Nome do serviço de provisionamento.
- resourceGroupName
-
string
Nome do grupo de recursos.
Os parâmetros de opções.