@azure/arm-deviceprovisioningservices package
Clases
| IotDpsClient |
Interfaces
| AsyncOperationResult |
Resultado de una operación de larga duración. |
| CertificateListDescription |
Matriz serializada por JSON de objetos Certificate. |
| CertificateProperties |
Descripción de un certificado de entidad de certificación X509. |
| CertificateResponse |
Certificado X509. |
| DpsCertificateCreateOrUpdateOptionalParams |
Parámetros opcionales. |
| DpsCertificateDeleteOptionalParams |
Parámetros opcionales. |
| DpsCertificateGenerateVerificationCodeOptionalParams |
Parámetros opcionales. |
| DpsCertificateGetOptionalParams |
Parámetros opcionales. |
| DpsCertificateListOptionalParams |
Parámetros opcionales. |
| DpsCertificateOperations |
Interfaz que representa una operación DpsCertificate. |
| DpsCertificateVerifyCertificateOptionalParams |
Parámetros opcionales. |
| ErrorAdditionalInfo |
Información adicional sobre el error de administración de recursos. |
| ErrorDetail |
Detalle del error. |
| ErrorDetails |
Detalles del error. |
| ErrorMessage |
Respuesta de error que contiene el mensaje y el código. |
| ErrorResponse |
Respuesta de error común para todas las API de Azure Resource Manager para devolver los detalles de error de las operaciones con errores. |
| GroupIdInformation |
Información de grupo para crear un punto de conexión privado en un servicio de aprovisionamiento |
| GroupIdInformationProperties |
Propiedades de un objeto de información de grupo |
| IotDpsClientOptionalParams |
Parámetros opcionales para el cliente. |
| IotDpsPropertiesDescription |
las propiedades específicas del servicio de un servicio de aprovisionamiento, incluidas las claves, los centros de iot vinculados, el estado actual y las propiedades generadas por el sistema, como el nombre de host y idScope |
| IotDpsResourceCheckProvisioningServiceNameAvailabilityOptionalParams |
Parámetros opcionales. |
| IotDpsResourceCreateOrUpdateOptionalParams |
Parámetros opcionales. |
| IotDpsResourceCreateOrUpdatePrivateEndpointConnectionOptionalParams |
Parámetros opcionales. |
| IotDpsResourceDeleteOptionalParams |
Parámetros opcionales. |
| IotDpsResourceDeletePrivateEndpointConnectionOptionalParams |
Parámetros opcionales. |
| IotDpsResourceGetOperationResultOptionalParams |
Parámetros opcionales. |
| IotDpsResourceGetOptionalParams |
Parámetros opcionales. |
| IotDpsResourceGetPrivateEndpointConnectionOptionalParams |
Parámetros opcionales. |
| IotDpsResourceGetPrivateLinkResourcesOptionalParams |
Parámetros opcionales. |
| IotDpsResourceListByResourceGroupOptionalParams |
Parámetros opcionales. |
| IotDpsResourceListBySubscriptionOptionalParams |
Parámetros opcionales. |
| IotDpsResourceListKeysForKeyNameOptionalParams |
Parámetros opcionales. |
| IotDpsResourceListKeysOptionalParams |
Parámetros opcionales. |
| IotDpsResourceListPrivateEndpointConnectionsOptionalParams |
Parámetros opcionales. |
| IotDpsResourceListPrivateLinkResourcesOptionalParams |
Parámetros opcionales. |
| IotDpsResourceListValidSkusOptionalParams |
Parámetros opcionales. |
| IotDpsResourceOperations |
Interfaz que representa una operación IotDpsResource. |
| IotDpsResourceUpdateOptionalParams |
Parámetros opcionales. |
| IotDpsSkuDefinition |
SKU disponibles de nivel y unidades. |
| IotDpsSkuInfo |
Lista de posibles SKU del servicio de aprovisionamiento. |
| IotHubDefinitionDescription |
Descripción del centro de IoT. |
| IpFilterRule |
Reglas de filtro IP para un servicio de aprovisionamiento. |
| ManagedServiceIdentity |
Identidad de servicio administrada (identidades asignadas por el sistema o asignadas por el usuario) |
| NameAvailabilityInfo |
Descripción de la disponibilidad del nombre. |
| Operation |
Representa una operación. |
| OperationInputs |
Valores de entrada para la llamada a los resultados de la operación. |
| OperationsListOptionalParams |
Parámetros opcionales. |
| OperationsOperations |
Interfaz que representa operaciones de operaciones. |
| PageSettings |
Opciones para el método byPage |
| PagedAsyncIterableIterator |
Interfaz que permite la iteración asincrónica tanto a la finalización como a la página. |
| PrivateEndpoint |
La propiedad de punto de conexión privado de una conexión de punto de conexión privado |
| PrivateEndpointConnection |
Conexión de punto de conexión privado de un servicio de aprovisionamiento |
| PrivateEndpointConnectionProperties |
Propiedades de una conexión de punto de conexión privado |
| PrivateLinkResources |
Los recursos de private link disponibles para un servicio de aprovisionamiento |
| PrivateLinkServiceConnectionState |
Estado actual de una conexión de punto de conexión privado |
| ProvisioningServiceDescription |
Descripción del servicio de aprovisionamiento. |
| ProxyResource |
Definición del modelo de recursos para un recurso proxy de Azure Resource Manager. No tendrá etiquetas ni una ubicación |
| Resource |
Campos comunes que se devuelven en la respuesta de todos los recursos de Azure Resource Manager |
| RestorePollerOptions | |
| SharedAccessSignatureAuthorizationRuleAccessRightsDescription |
Descripción de la clave de acceso compartido. |
| SystemData |
Metadatos relativos a la creación y última modificación del recurso. |
| TagsResource |
Un contenedor que contiene solo las etiquetas de un recurso, lo que permite al usuario actualizar las etiquetas en una instancia de Provisioning Service. |
| TrackedResource |
La definición del modelo de recursos para un recurso de nivel superior con seguimiento de Azure Resource Manager que tiene "etiquetas" y una "ubicación". |
| UserAssignedIdentity |
Propiedades de identidad asignadas por el usuario |
| VerificationCodeRequest |
El certificado hoja serializado por JSON |
| VerificationCodeResponse |
Descripción de la respuesta del código de verificación. |
| VerificationCodeResponseProperties |
interfaz de modelo VerificationCodeResponseProperties |
Alias de tipos
| AccessRightsDescription |
Derechos que tiene esta clave. Valores conocidos admitidos por el servicio
ServiceConfig |
| AllocationPolicy |
Directiva de asignación que usará este servicio de aprovisionamiento. Valores conocidos admitidos por el servicio
hash |
| AzureSupportedClouds |
Los valores admitidos para la configuración de nube como un tipo literal de cadena |
| CertificatePurpose |
Tipo de certificadoPropósito |
| ContinuablePage |
Interfaz que describe una página de resultados. |
| CreatedByType |
El tipo de entidad que creó el recurso. Valores conocidos admitidos por el servicio
Usuario: la entidad fue creada por un usuario. |
| IotDpsSku |
Nombre de la SKU. Valores conocidos admitidos por el servicioS1 |
| IotHubAuthenticationType |
Tipo de autenticación MI de IotHub: Basado en Claves, Asignado por Usuario, Asignado al Sistema. Valores conocidos admitidos por el servicio
Basado en claves: Tipo de autenticación basada en claves. |
| IpFilterActionType |
Acción deseada para las solicitudes capturadas por esta regla. |
| IpFilterTargetType |
Destino de las solicitudes capturadas por esta regla. |
| ManagedServiceIdentityType |
Tipo de identidad de servicio administrada (donde se permiten los tipos SystemAssigned y UserAssigned). Valores conocidos admitidos por el servicio
Ninguno: no hay identidad administrada. |
| NameUnavailabilityReason |
especifica la razón por la que un nombre no está disponible Valores conocidos admitidos por el servicio
no válidos |
| PrivateLinkServiceConnectionStatus |
El estado de una conexión de punto de conexión privado Valores conocidos admitidos por el servicio
pendiente |
| PublicNetworkAccess |
Si se permiten solicitudes de red pública Valores conocidos admitidos por el servicio
habilitado para |
| State |
Estado actual del servicio de aprovisionamiento. Valores conocidos admitidos por el servicio
activar |
Enumeraciones
| AzureClouds |
Una enumeración para describir los entornos de la nube de Azure. |
| KnownAccessRightsDescription |
Derechos que tiene esta clave. |
| KnownAllocationPolicy |
Directiva de asignación que usará este servicio de aprovisionamiento. |
| KnownCertificatePurpose |
Valores conocidos de CertificatePurpose que acepta el servicio. |
| KnownCreatedByType |
El tipo de entidad que creó el recurso. |
| KnownIotDpsSku |
Nombre de la SKU. |
| KnownIotHubAuthenticationType |
Tipo de autenticación MI de IotHub: Basado en Claves, Asignado por Usuario, Asignado al Sistema. |
| KnownManagedServiceIdentityType |
Tipo de identidad de servicio administrada (donde se permiten los tipos SystemAssigned y UserAssigned). |
| KnownNameUnavailabilityReason |
especifica la razón por la que un nombre no está disponible |
| KnownPrivateLinkServiceConnectionStatus |
Estado de una conexión de punto de conexión privado |
| KnownPublicNetworkAccess |
Indica si se permiten solicitudes de la red pública |
| KnownState |
Estado actual del servicio de aprovisionamiento. |
| KnownVersions |
Las versiones de API disponibles. |
Funciones
| is |
Typeguard para RestError |
| restore |
Crea un sondeador a partir del estado serializado de otro sondeador. Esto puede ser útil cuando desea crear sondeadores en un host diferente o cuando es necesario construir un sondeador después de que el original no esté en el ámbito. |
Variables
| Rest |
Tipo de error personalizado para solicitudes de canalización con error. |
Detalles de la función
isRestError(unknown)
Typeguard para RestError
function isRestError(e: unknown): e is RestError
Parámetros
- e
-
unknown
Algo capturado por una cláusula catch.
Devoluciones
e is RestError
restorePoller<TResponse, TResult>(IotDpsClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)
Crea un sondeador a partir del estado serializado de otro sondeador. Esto puede ser útil cuando desea crear sondeadores en un host diferente o cuando es necesario construir un sondeador después de que el original no esté en el ámbito.
function restorePoller<TResponse, TResult>(client: IotDpsClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>
Parámetros
- client
- IotDpsClient
- serializedState
-
string
- sourceOperation
-
(args: any[]) => PollerLike<OperationState<TResult>, TResult>
- options
-
RestorePollerOptions<TResult, PathUncheckedResponse>
Devoluciones
PollerLike<OperationState<TResult>, TResult>
Detalles de variables
RestError
Tipo de error personalizado para solicitudes de canalización con error.
RestError: RestErrorConstructor