IotDpsResource interface

Paquete:

@azure/arm-deviceprovisioningservices

Interfaz que representa un IotDpsResource.

Métodos

beginCreateOrUpdate(string, string, ProvisioningServiceDescription, IotDpsResourceCreateOrUpdateOptionalParams)	Cree o actualice los metadatos del servicio de aprovisionamiento. El patrón habitual para modificar una propiedad es recuperar los metadatos del servicio de aprovisionamiento y los metadatos de seguridad y, a continuación, combinarlos con los valores modificados en un nuevo cuerpo para actualizar el servicio de aprovisionamiento.
beginCreateOrUpdateAndWait(string, string, ProvisioningServiceDescription, IotDpsResourceCreateOrUpdateOptionalParams)	Cree o actualice los metadatos del servicio de aprovisionamiento. El patrón habitual para modificar una propiedad es recuperar los metadatos del servicio de aprovisionamiento y los metadatos de seguridad y, a continuación, combinarlos con los valores modificados en un nuevo cuerpo para actualizar el servicio de aprovisionamiento.
beginCreateOrUpdatePrivateEndpointConnection(string, string, string, PrivateEndpointConnection, IotDpsResourceCreateOrUpdatePrivateEndpointConnectionOptionalParams)	Crear o actualizar el estado de una conexión de punto de conexión privado con el nombre especificado
beginCreateOrUpdatePrivateEndpointConnectionAndWait(string, string, string, PrivateEndpointConnection, IotDpsResourceCreateOrUpdatePrivateEndpointConnectionOptionalParams)	Crear o actualizar el estado de una conexión de punto de conexión privado con el nombre especificado
beginDelete(string, string, IotDpsResourceDeleteOptionalParams)	Elimina el servicio de aprovisionamiento.
beginDeleteAndWait(string, string, IotDpsResourceDeleteOptionalParams)	Elimina el servicio de aprovisionamiento.
beginDeletePrivateEndpointConnection(string, string, string, IotDpsResourceDeletePrivateEndpointConnectionOptionalParams)	Eliminación de la conexión de punto de conexión privado con el nombre especificado
beginDeletePrivateEndpointConnectionAndWait(string, string, string, IotDpsResourceDeletePrivateEndpointConnectionOptionalParams)	Eliminación de la conexión de punto de conexión privado con el nombre especificado
beginUpdate(string, string, TagsResource, IotDpsResourceUpdateOptionalParams)	Actualice las etiquetas de un servicio de aprovisionamiento existente. para actualizar otros campos, use el método CreateOrUpdate.
beginUpdateAndWait(string, string, TagsResource, IotDpsResourceUpdateOptionalParams)	Actualice las etiquetas de un servicio de aprovisionamiento existente. para actualizar otros campos, use el método CreateOrUpdate
checkProvisioningServiceNameAvailability(OperationInputs, IotDpsResourceCheckProvisioningServiceNameAvailabilityOptionalParams)	Compruebe si hay disponible un nombre de servicio de aprovisionamiento. Esto validará si el nombre es sintácticamente válido y si el nombre es utilizable
get(string, string, IotDpsResourceGetOptionalParams)	Obtenga los metadatos del servicio de aprovisionamiento sin claves SAS.
getOperationResult(string, string, string, string, IotDpsResourceGetOperationResultOptionalParams)	Obtiene el estado de una operación de larga duración, como crear, actualizar o eliminar un servicio de aprovisionamiento.
getPrivateEndpointConnection(string, string, string, IotDpsResourceGetPrivateEndpointConnectionOptionalParams)	Obtención de propiedades de conexión de punto de conexión privado
getPrivateLinkResources(string, string, string, IotDpsResourceGetPrivateLinkResourcesOptionalParams)	Obtención del recurso de vínculo privado especificado para el servicio de aprovisionamiento especificado
listByResourceGroup(string, IotDpsResourceListByResourceGroupOptionalParams)	Obtenga una lista de todos los servicios de aprovisionamiento del grupo de recursos especificado.
listBySubscription(IotDpsResourceListBySubscriptionOptionalParams)	Enumere todos los servicios de aprovisionamiento de un identificador de suscripción determinado.
listKeys(string, string, IotDpsResourceListKeysOptionalParams)	Enumere las claves principal y secundaria de un servicio de aprovisionamiento.
listKeysForKeyName(string, string, string, IotDpsResourceListKeysForKeyNameOptionalParams)	Enumeración de claves principales y secundarias para un nombre de clave específico
listPrivateEndpointConnections(string, string, IotDpsResourceListPrivateEndpointConnectionsOptionalParams)	Enumeración de las propiedades de conexión de punto de conexión privado
listPrivateLinkResources(string, string, IotDpsResourceListPrivateLinkResourcesOptionalParams)	Enumeración de recursos de vínculo privado para el servicio de aprovisionamiento dado
listValidSkus(string, string, IotDpsResourceListValidSkusOptionalParams)	Obtiene la lista de SKU y niveles válidos para un servicio de aprovisionamiento.

Detalles del método

beginCreateOrUpdate(string, string, ProvisioningServiceDescription, IotDpsResourceCreateOrUpdateOptionalParams)

Cree o actualice los metadatos del servicio de aprovisionamiento. El patrón habitual para modificar una propiedad es recuperar los metadatos del servicio de aprovisionamiento y los metadatos de seguridad y, a continuación, combinarlos con los valores modificados en un nuevo cuerpo para actualizar el servicio de aprovisionamiento.

function beginCreateOrUpdate(resourceGroupName: string, provisioningServiceName: string, iotDpsDescription: ProvisioningServiceDescription, options?: IotDpsResourceCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<ProvisioningServiceDescription>, ProvisioningServiceDescription>>

Parámetros

resourceGroupName

string

Identificador del grupo de recursos.

provisioningServiceName

string

Nombre del servicio de aprovisionamiento para crear o actualizar.

iotDpsDescription

ProvisioningServiceDescription

Descripción del servicio de aprovisionamiento que se va a crear o actualizar.

options

IotDpsResourceCreateOrUpdateOptionalParams

Parámetros de opciones.

Devoluciones

Promise<PollerLike<@azure/core-lro.PollOperationState<ProvisioningServiceDescription>, ProvisioningServiceDescription>>

beginCreateOrUpdateAndWait(string, string, ProvisioningServiceDescription, IotDpsResourceCreateOrUpdateOptionalParams)

Cree o actualice los metadatos del servicio de aprovisionamiento. El patrón habitual para modificar una propiedad es recuperar los metadatos del servicio de aprovisionamiento y los metadatos de seguridad y, a continuación, combinarlos con los valores modificados en un nuevo cuerpo para actualizar el servicio de aprovisionamiento.

function beginCreateOrUpdateAndWait(resourceGroupName: string, provisioningServiceName: string, iotDpsDescription: ProvisioningServiceDescription, options?: IotDpsResourceCreateOrUpdateOptionalParams): Promise<ProvisioningServiceDescription>

Parámetros

resourceGroupName

string

Identificador del grupo de recursos.

provisioningServiceName

string

Nombre del servicio de aprovisionamiento para crear o actualizar.

iotDpsDescription

ProvisioningServiceDescription

Descripción del servicio de aprovisionamiento que se va a crear o actualizar.

options

IotDpsResourceCreateOrUpdateOptionalParams

Parámetros de opciones.

Devoluciones

Promise<ProvisioningServiceDescription>

beginCreateOrUpdatePrivateEndpointConnection(string, string, string, PrivateEndpointConnection, IotDpsResourceCreateOrUpdatePrivateEndpointConnectionOptionalParams)

Crear o actualizar el estado de una conexión de punto de conexión privado con el nombre especificado

function beginCreateOrUpdatePrivateEndpointConnection(resourceGroupName: string, resourceName: string, privateEndpointConnectionName: string, privateEndpointConnection: PrivateEndpointConnection, options?: IotDpsResourceCreateOrUpdatePrivateEndpointConnectionOptionalParams): Promise<PollerLike<PollOperationState<PrivateEndpointConnection>, PrivateEndpointConnection>>

Parámetros

resourceGroupName

string

Nombre del grupo de recursos que contiene el servicio de aprovisionamiento.

resourceName

string

Nombre del servicio de aprovisionamiento.

privateEndpointConnectionName

string

Nombre de la conexión de punto de conexión privado

privateEndpointConnection

PrivateEndpointConnection

Conexión de punto de conexión privado con propiedades actualizadas

options

IotDpsResourceCreateOrUpdatePrivateEndpointConnectionOptionalParams

Parámetros de opciones.

Devoluciones

Promise<PollerLike<@azure/core-lro.PollOperationState<PrivateEndpointConnection>, PrivateEndpointConnection>>

beginCreateOrUpdatePrivateEndpointConnectionAndWait(string, string, string, PrivateEndpointConnection, IotDpsResourceCreateOrUpdatePrivateEndpointConnectionOptionalParams)

Crear o actualizar el estado de una conexión de punto de conexión privado con el nombre especificado

function beginCreateOrUpdatePrivateEndpointConnectionAndWait(resourceGroupName: string, resourceName: string, privateEndpointConnectionName: string, privateEndpointConnection: PrivateEndpointConnection, options?: IotDpsResourceCreateOrUpdatePrivateEndpointConnectionOptionalParams): Promise<PrivateEndpointConnection>

Parámetros

resourceGroupName

string

Nombre del grupo de recursos que contiene el servicio de aprovisionamiento.

resourceName

string

Nombre del servicio de aprovisionamiento.

privateEndpointConnectionName

string

Nombre de la conexión de punto de conexión privado

privateEndpointConnection

PrivateEndpointConnection

Conexión de punto de conexión privado con propiedades actualizadas

options

IotDpsResourceCreateOrUpdatePrivateEndpointConnectionOptionalParams

Parámetros de opciones.

Devoluciones

Promise<PrivateEndpointConnection>

beginDelete(string, string, IotDpsResourceDeleteOptionalParams)

Elimina el servicio de aprovisionamiento.

function beginDelete(provisioningServiceName: string, resourceGroupName: string, options?: IotDpsResourceDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parámetros

provisioningServiceName

string

Nombre del servicio de aprovisionamiento que se va a eliminar.

resourceGroupName

string

Identificador del grupo de recursos.

options

IotDpsResourceDeleteOptionalParams

Parámetros de opciones.

Devoluciones

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginDeleteAndWait(string, string, IotDpsResourceDeleteOptionalParams)

Elimina el servicio de aprovisionamiento.

function beginDeleteAndWait(provisioningServiceName: string, resourceGroupName: string, options?: IotDpsResourceDeleteOptionalParams): Promise<void>

Parámetros

provisioningServiceName

string

Nombre del servicio de aprovisionamiento que se va a eliminar.

resourceGroupName

string

Identificador del grupo de recursos.

options

IotDpsResourceDeleteOptionalParams

Parámetros de opciones.

Devoluciones

Promise<void>

beginDeletePrivateEndpointConnection(string, string, string, IotDpsResourceDeletePrivateEndpointConnectionOptionalParams)

Eliminación de la conexión de punto de conexión privado con el nombre especificado

function beginDeletePrivateEndpointConnection(resourceGroupName: string, resourceName: string, privateEndpointConnectionName: string, options?: IotDpsResourceDeletePrivateEndpointConnectionOptionalParams): Promise<PollerLike<PollOperationState<PrivateEndpointConnection>, PrivateEndpointConnection>>

Parámetros

resourceGroupName

string

Nombre del grupo de recursos que contiene el servicio de aprovisionamiento.

resourceName

string

Nombre del servicio de aprovisionamiento.

privateEndpointConnectionName

string

Nombre de la conexión de punto de conexión privado

options

IotDpsResourceDeletePrivateEndpointConnectionOptionalParams

Parámetros de opciones.

Devoluciones

Promise<PollerLike<@azure/core-lro.PollOperationState<PrivateEndpointConnection>, PrivateEndpointConnection>>

beginDeletePrivateEndpointConnectionAndWait(string, string, string, IotDpsResourceDeletePrivateEndpointConnectionOptionalParams)

Eliminación de la conexión de punto de conexión privado con el nombre especificado

function beginDeletePrivateEndpointConnectionAndWait(resourceGroupName: string, resourceName: string, privateEndpointConnectionName: string, options?: IotDpsResourceDeletePrivateEndpointConnectionOptionalParams): Promise<PrivateEndpointConnection>

Parámetros

resourceGroupName

string

Nombre del grupo de recursos que contiene el servicio de aprovisionamiento.

resourceName

string

Nombre del servicio de aprovisionamiento.

privateEndpointConnectionName

string

Nombre de la conexión de punto de conexión privado

options

IotDpsResourceDeletePrivateEndpointConnectionOptionalParams

Parámetros de opciones.

Devoluciones

Promise<PrivateEndpointConnection>

beginUpdate(string, string, TagsResource, IotDpsResourceUpdateOptionalParams)

Actualice las etiquetas de un servicio de aprovisionamiento existente. para actualizar otros campos, use el método CreateOrUpdate.

function beginUpdate(resourceGroupName: string, provisioningServiceName: string, provisioningServiceTags: TagsResource, options?: IotDpsResourceUpdateOptionalParams): Promise<PollerLike<PollOperationState<ProvisioningServiceDescription>, ProvisioningServiceDescription>>

Parámetros

resourceGroupName

string

Identificador del grupo de recursos.

provisioningServiceName

string

Nombre del servicio de aprovisionamiento para crear o actualizar.

provisioningServiceTags

TagsResource

Se ha actualizado la información de etiqueta para establecerla en la instancia del servicio de aprovisionamiento.

options

IotDpsResourceUpdateOptionalParams

Parámetros de opciones.

Devoluciones

Promise<PollerLike<@azure/core-lro.PollOperationState<ProvisioningServiceDescription>, ProvisioningServiceDescription>>

beginUpdateAndWait(string, string, TagsResource, IotDpsResourceUpdateOptionalParams)

Actualice las etiquetas de un servicio de aprovisionamiento existente. para actualizar otros campos, use el método CreateOrUpdate

function beginUpdateAndWait(resourceGroupName: string, provisioningServiceName: string, provisioningServiceTags: TagsResource, options?: IotDpsResourceUpdateOptionalParams): Promise<ProvisioningServiceDescription>

Parámetros

resourceGroupName

string

Identificador del grupo de recursos.

provisioningServiceName

string

Nombre del servicio de aprovisionamiento para crear o actualizar.

provisioningServiceTags

TagsResource

Se ha actualizado la información de etiqueta para establecerla en la instancia del servicio de aprovisionamiento.

options

IotDpsResourceUpdateOptionalParams

Parámetros de opciones.

Devoluciones

Promise<ProvisioningServiceDescription>

checkProvisioningServiceNameAvailability(OperationInputs, IotDpsResourceCheckProvisioningServiceNameAvailabilityOptionalParams)

Compruebe si hay disponible un nombre de servicio de aprovisionamiento. Esto validará si el nombre es sintácticamente válido y si el nombre es utilizable

function checkProvisioningServiceNameAvailability(argumentsParam: OperationInputs, options?: IotDpsResourceCheckProvisioningServiceNameAvailabilityOptionalParams): Promise<NameAvailabilityInfo>

Parámetros

argumentsParam

OperationInputs

Establezca el parámetro name en la estructura OperationInputs en el nombre del servicio de aprovisionamiento que se va a comprobar.

options

IotDpsResourceCheckProvisioningServiceNameAvailabilityOptionalParams

Parámetros de opciones.

Devoluciones

Promise<NameAvailabilityInfo>

get(string, string, IotDpsResourceGetOptionalParams)

Obtenga los metadatos del servicio de aprovisionamiento sin claves SAS.

function get(provisioningServiceName: string, resourceGroupName: string, options?: IotDpsResourceGetOptionalParams): Promise<ProvisioningServiceDescription>

Parámetros

provisioningServiceName

string

Nombre del servicio de aprovisionamiento que se va a recuperar.

resourceGroupName

string

Nombre del grupo de recursos.

options

IotDpsResourceGetOptionalParams

Parámetros de opciones.

Devoluciones

Promise<ProvisioningServiceDescription>

getOperationResult(string, string, string, string, IotDpsResourceGetOperationResultOptionalParams)

Obtiene el estado de una operación de larga duración, como crear, actualizar o eliminar un servicio de aprovisionamiento.

function getOperationResult(operationId: string, resourceGroupName: string, provisioningServiceName: string, asyncinfo: string, options?: IotDpsResourceGetOperationResultOptionalParams): Promise<AsyncOperationResult>

Parámetros

operationId

string

Identificador de la operación correspondiente a la operación de larga duración. Úselo para sondear el estado.

resourceGroupName

string

Identificador del grupo de recursos.

provisioningServiceName

string

Nombre del servicio de aprovisionamiento en el que se ejecuta la operación.

asyncinfo

string

Encabezado asincrónico usado para sondear el estado de la operación, obtenido al crear la operación de larga duración.

options

IotDpsResourceGetOperationResultOptionalParams

Parámetros de opciones.

Devoluciones

Promise<AsyncOperationResult>

getPrivateEndpointConnection(string, string, string, IotDpsResourceGetPrivateEndpointConnectionOptionalParams)

Obtención de propiedades de conexión de punto de conexión privado

function getPrivateEndpointConnection(resourceGroupName: string, resourceName: string, privateEndpointConnectionName: string, options?: IotDpsResourceGetPrivateEndpointConnectionOptionalParams): Promise<PrivateEndpointConnection>

Parámetros

resourceGroupName

string

Nombre del grupo de recursos que contiene el servicio de aprovisionamiento.

resourceName

string

Nombre del servicio de aprovisionamiento.

privateEndpointConnectionName

string

Nombre de la conexión del punto de conexión privado

options

IotDpsResourceGetPrivateEndpointConnectionOptionalParams

Parámetros de opciones.

Devoluciones

Promise<PrivateEndpointConnection>

getPrivateLinkResources(string, string, string, IotDpsResourceGetPrivateLinkResourcesOptionalParams)

Obtención del recurso de vínculo privado especificado para el servicio de aprovisionamiento especificado

function getPrivateLinkResources(resourceGroupName: string, resourceName: string, groupId: string, options?: IotDpsResourceGetPrivateLinkResourcesOptionalParams): Promise<GroupIdInformation>

Parámetros

resourceGroupName

string

Nombre del grupo de recursos que contiene el servicio de aprovisionamiento.

resourceName

string

Nombre del servicio de aprovisionamiento.

groupId

string

Nombre del recurso de vínculo privado

options

IotDpsResourceGetPrivateLinkResourcesOptionalParams

Parámetros de opciones.

Devoluciones

Promise<GroupIdInformation>

listByResourceGroup(string, IotDpsResourceListByResourceGroupOptionalParams)

Obtenga una lista de todos los servicios de aprovisionamiento del grupo de recursos especificado.

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

Parámetros

resourceGroupName

string

Identificador del grupo de recursos.

options

IotDpsResourceListByResourceGroupOptionalParams

Parámetros de opciones.

Devoluciones

PagedAsyncIterableIterator<ProvisioningServiceDescription, ProvisioningServiceDescription[], PageSettings>

listBySubscription(IotDpsResourceListBySubscriptionOptionalParams)

Enumere todos los servicios de aprovisionamiento de un identificador de suscripción determinado.

function listBySubscription(options?: IotDpsResourceListBySubscriptionOptionalParams): PagedAsyncIterableIterator<ProvisioningServiceDescription, ProvisioningServiceDescription[], PageSettings>

Parámetros

options

IotDpsResourceListBySubscriptionOptionalParams

Parámetros de opciones.

Devoluciones

PagedAsyncIterableIterator<ProvisioningServiceDescription, ProvisioningServiceDescription[], PageSettings>

listKeys(string, string, IotDpsResourceListKeysOptionalParams)

Enumere las claves principal y secundaria de un servicio de aprovisionamiento.

function listKeys(provisioningServiceName: string, resourceGroupName: string, options?: IotDpsResourceListKeysOptionalParams): PagedAsyncIterableIterator<SharedAccessSignatureAuthorizationRuleAccessRightsDescription, SharedAccessSignatureAuthorizationRuleAccessRightsDescription[], PageSettings>

Parámetros

provisioningServiceName

string

Nombre del servicio de aprovisionamiento para el que se obtienen las claves de acceso compartido.

resourceGroupName

string

nombre del grupo de recursos

options

IotDpsResourceListKeysOptionalParams

Parámetros de opciones.

Devoluciones

PagedAsyncIterableIterator<SharedAccessSignatureAuthorizationRuleAccessRightsDescription, SharedAccessSignatureAuthorizationRuleAccessRightsDescription[], PageSettings>

listKeysForKeyName(string, string, string, IotDpsResourceListKeysForKeyNameOptionalParams)

Enumeración de claves principales y secundarias para un nombre de clave específico

function listKeysForKeyName(provisioningServiceName: string, keyName: string, resourceGroupName: string, options?: IotDpsResourceListKeysForKeyNameOptionalParams): Promise<SharedAccessSignatureAuthorizationRuleAccessRightsDescription>

Parámetros

provisioningServiceName

string

Nombre del servicio de aprovisionamiento.

keyName

string

Nombre de clave lógica para el que se van a obtener los valores de clave.

resourceGroupName

string

Nombre del grupo de recursos que contiene el servicio de aprovisionamiento.

options

IotDpsResourceListKeysForKeyNameOptionalParams

Parámetros de opciones.

Devoluciones

Promise<SharedAccessSignatureAuthorizationRuleAccessRightsDescription>

listPrivateEndpointConnections(string, string, IotDpsResourceListPrivateEndpointConnectionsOptionalParams)

Enumeración de las propiedades de conexión de punto de conexión privado

function listPrivateEndpointConnections(resourceGroupName: string, resourceName: string, options?: IotDpsResourceListPrivateEndpointConnectionsOptionalParams): Promise<IotDpsResourceListPrivateEndpointConnectionsResponse>

Parámetros

resourceGroupName

string

Nombre del grupo de recursos que contiene el servicio de aprovisionamiento.

resourceName

string

Nombre del servicio de aprovisionamiento.

options

IotDpsResourceListPrivateEndpointConnectionsOptionalParams

Parámetros de opciones.

Devoluciones

Promise<IotDpsResourceListPrivateEndpointConnectionsResponse>

listPrivateLinkResources(string, string, IotDpsResourceListPrivateLinkResourcesOptionalParams)

Enumeración de recursos de vínculo privado para el servicio de aprovisionamiento dado

function listPrivateLinkResources(resourceGroupName: string, resourceName: string, options?: IotDpsResourceListPrivateLinkResourcesOptionalParams): Promise<PrivateLinkResources>

Parámetros

resourceGroupName

string

Nombre del grupo de recursos que contiene el servicio de aprovisionamiento.

resourceName

string

Nombre del servicio de aprovisionamiento.

options

IotDpsResourceListPrivateLinkResourcesOptionalParams

Parámetros de opciones.

Devoluciones

Promise<PrivateLinkResources>

listValidSkus(string, string, IotDpsResourceListValidSkusOptionalParams)

Obtiene la lista de SKU y niveles válidos para un servicio de aprovisionamiento.

function listValidSkus(provisioningServiceName: string, resourceGroupName: string, options?: IotDpsResourceListValidSkusOptionalParams): PagedAsyncIterableIterator<IotDpsSkuDefinition, IotDpsSkuDefinition[], PageSettings>

Parámetros

provisioningServiceName

string

Nombre del servicio de aprovisionamiento.

resourceGroupName

string

Nombre del grupo de recursos.

options

IotDpsResourceListValidSkusOptionalParams

Parámetros de opciones.

Devoluciones

PagedAsyncIterableIterator<IotDpsSkuDefinition, IotDpsSkuDefinition[], PageSettings>