IotHubResource interface
Interface représentant un IotHubResource.
Méthodes
| begin |
Créez ou mettez à jour les métadonnées d’un hub Iot. Le modèle habituel de modification d’une propriété consiste à récupérer les métadonnées du hub IoT et les métadonnées de sécurité, puis à les combiner avec les valeurs modifiées dans un nouveau corps pour mettre à jour le hub IoT. Si certaines propriétés sont manquantes dans le JSON, la mise à jour d’IoT Hub peut entraîner la restauration par défaut de ces valeurs, ce qui peut entraîner un comportement inattendu. |
| begin |
Créez ou mettez à jour les métadonnées d’un hub Iot. Le modèle habituel de modification d’une propriété consiste à récupérer les métadonnées du hub IoT et les métadonnées de sécurité, puis à les combiner avec les valeurs modifiées dans un nouveau corps pour mettre à jour le hub IoT. Si certaines propriétés sont manquantes dans le JSON, la mise à jour d’IoT Hub peut entraîner la restauration par défaut de ces valeurs, ce qui peut entraîner un comportement inattendu. |
| begin |
Supprimez un hub IoT. |
| begin |
Supprimez un hub IoT. |
| begin |
Mettez à jour des balises IoT Hub existantes. pour mettre à jour d’autres champs, utilisez la méthode CreateOrUpdate |
| begin |
Mettez à jour des balises IoT Hub existantes. pour mettre à jour d’autres champs, utilisez la méthode CreateOrUpdate |
| check |
Vérifiez si un nom ioT Hub est disponible. |
| create |
Ajoutez un groupe de consommateurs à un point de terminaison compatible Event Hub dans un hub IoT. |
| delete |
Supprimez un groupe de consommateurs d’un point de terminaison compatible Event Hub dans un hub IoT. |
| export |
Exporte toutes les identités d’appareil dans le registre d’identités IoT Hub vers un conteneur d’objets blob Stockage Azure. Pour plus d’informations, consultez : https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities. |
| get(string, string, Iot |
Obtenez les métadonnées non liées à la sécurité d’un hub IoT. |
| get |
Obtenez un groupe de consommateurs à partir du point de terminaison appareil-à-cloud compatible avec Event Hub pour un hub IoT. |
| get |
Obtenez les détails d’un travail à partir d’un hub IoT. Pour plus d’informations, consultez : https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry. |
| get |
Obtenez une stratégie d’accès partagé par nom à partir d’un hub IoT. Pour plus d’informations, consultez : https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security. |
| get |
Obtenez les statistiques à partir d’un hub IoT. |
| import |
Importez, mettez à jour ou supprimez des identités d’appareil dans le registre des identités IoT Hub à partir d’un objet blob. Pour plus d’informations, consultez : https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities. |
| list |
Obtenez tous les hubs IoT dans un groupe de ressources. |
| list |
Obtenez tous les hubs IoT dans un abonnement. |
| list |
Obtenez l’intégrité des points de terminaison de routage. |
| list |
Obtenez la liste des groupes de consommateurs dans le point de terminaison appareil-à-cloud compatible avec Event Hub dans un hub IoT. |
| list |
Obtenez la liste de tous les travaux dans un hub IoT. Pour plus d’informations, consultez : https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry. |
| list |
Obtenez les métadonnées de sécurité d’un hub IoT. Pour plus d’informations, consultez : https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security. |
| list |
Obtenez les métriques de quota pour un hub IoT. |
| list |
Obtenez la liste des références SKU valides pour un hub IoT. |
| test |
Tester tous les itinéraires configurés dans ce hub Iot |
| test |
Tester la nouvelle route pour ce hub Iot |
Détails de la méthode
beginCreateOrUpdate(string, string, IotHubDescription, IotHubResourceCreateOrUpdateOptionalParams)
Créez ou mettez à jour les métadonnées d’un hub Iot. Le modèle habituel de modification d’une propriété consiste à récupérer les métadonnées du hub IoT et les métadonnées de sécurité, puis à les combiner avec les valeurs modifiées dans un nouveau corps pour mettre à jour le hub IoT. Si certaines propriétés sont manquantes dans le JSON, la mise à jour d’IoT Hub peut entraîner la restauration par défaut de ces valeurs, ce qui peut entraîner un comportement inattendu.
function beginCreateOrUpdate(resourceGroupName: string, resourceName: string, iotHubDescription: IotHubDescription, options?: IotHubResourceCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<IotHubDescription>, IotHubDescription>>
Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources qui contient le hub IoT.
- resourceName
-
string
Nom du hub IoT.
- iotHubDescription
- IotHubDescription
Métadonnées du hub IoT et métadonnées de sécurité.
Paramètres d’options.
Retours
Promise<@azure/core-lro.SimplePollerLike<OperationState<IotHubDescription>, IotHubDescription>>
beginCreateOrUpdateAndWait(string, string, IotHubDescription, IotHubResourceCreateOrUpdateOptionalParams)
Créez ou mettez à jour les métadonnées d’un hub Iot. Le modèle habituel de modification d’une propriété consiste à récupérer les métadonnées du hub IoT et les métadonnées de sécurité, puis à les combiner avec les valeurs modifiées dans un nouveau corps pour mettre à jour le hub IoT. Si certaines propriétés sont manquantes dans le JSON, la mise à jour d’IoT Hub peut entraîner la restauration par défaut de ces valeurs, ce qui peut entraîner un comportement inattendu.
function beginCreateOrUpdateAndWait(resourceGroupName: string, resourceName: string, iotHubDescription: IotHubDescription, options?: IotHubResourceCreateOrUpdateOptionalParams): Promise<IotHubDescription>
Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources qui contient le hub IoT.
- resourceName
-
string
Nom du hub IoT.
- iotHubDescription
- IotHubDescription
Métadonnées du hub IoT et métadonnées de sécurité.
Paramètres d’options.
Retours
Promise<IotHubDescription>
beginDelete(string, string, IotHubResourceDeleteOptionalParams)
Supprimez un hub IoT.
function beginDelete(resourceGroupName: string, resourceName: string, options?: IotHubResourceDeleteOptionalParams): Promise<SimplePollerLike<OperationState<IotHubDescription>, IotHubDescription>>
Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources qui contient le hub IoT.
- resourceName
-
string
Nom du hub IoT.
Paramètres d’options.
Retours
Promise<@azure/core-lro.SimplePollerLike<OperationState<IotHubDescription>, IotHubDescription>>
beginDeleteAndWait(string, string, IotHubResourceDeleteOptionalParams)
Supprimez un hub IoT.
function beginDeleteAndWait(resourceGroupName: string, resourceName: string, options?: IotHubResourceDeleteOptionalParams): Promise<IotHubDescription>
Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources qui contient le hub IoT.
- resourceName
-
string
Nom du hub IoT.
Paramètres d’options.
Retours
Promise<IotHubDescription>
beginUpdate(string, string, TagsResource, IotHubResourceUpdateOptionalParams)
Mettez à jour des balises IoT Hub existantes. pour mettre à jour d’autres champs, utilisez la méthode CreateOrUpdate
function beginUpdate(resourceGroupName: string, resourceName: string, iotHubTags: TagsResource, options?: IotHubResourceUpdateOptionalParams): Promise<SimplePollerLike<OperationState<IotHubDescription>, IotHubDescription>>
Paramètres
- resourceGroupName
-
string
Identificateur du groupe de ressources.
- resourceName
-
string
Nom du hub iot à mettre à jour.
- iotHubTags
- TagsResource
Mise à jour des informations de balise à définir dans l’instance du hub iot.
Paramètres d’options.
Retours
Promise<@azure/core-lro.SimplePollerLike<OperationState<IotHubDescription>, IotHubDescription>>
beginUpdateAndWait(string, string, TagsResource, IotHubResourceUpdateOptionalParams)
Mettez à jour des balises IoT Hub existantes. pour mettre à jour d’autres champs, utilisez la méthode CreateOrUpdate
function beginUpdateAndWait(resourceGroupName: string, resourceName: string, iotHubTags: TagsResource, options?: IotHubResourceUpdateOptionalParams): Promise<IotHubDescription>
Paramètres
- resourceGroupName
-
string
Identificateur du groupe de ressources.
- resourceName
-
string
Nom du hub iot à mettre à jour.
- iotHubTags
- TagsResource
Mise à jour des informations de balise à définir dans l’instance du hub iot.
Paramètres d’options.
Retours
Promise<IotHubDescription>
checkNameAvailability(OperationInputs, IotHubResourceCheckNameAvailabilityOptionalParams)
Vérifiez si un nom ioT Hub est disponible.
function checkNameAvailability(operationInputs: OperationInputs, options?: IotHubResourceCheckNameAvailabilityOptionalParams): Promise<IotHubNameAvailabilityInfo>
Paramètres
- operationInputs
- OperationInputs
Définissez le paramètre de nom dans la structure OperationInputs sur le nom du hub IoT à vérifier.
Paramètres d’options.
Retours
Promise<IotHubNameAvailabilityInfo>
createEventHubConsumerGroup(string, string, string, string, EventHubConsumerGroupBodyDescription, IotHubResourceCreateEventHubConsumerGroupOptionalParams)
Ajoutez un groupe de consommateurs à un point de terminaison compatible Event Hub dans un hub IoT.
function createEventHubConsumerGroup(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, name: string, consumerGroupBody: EventHubConsumerGroupBodyDescription, options?: IotHubResourceCreateEventHubConsumerGroupOptionalParams): Promise<EventHubConsumerGroupInfo>
Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources qui contient le hub IoT.
- resourceName
-
string
Nom du hub IoT.
- eventHubEndpointName
-
string
Nom du point de terminaison compatible Event Hub dans le hub IoT.
- name
-
string
Nom du groupe de consommateurs à ajouter.
- consumerGroupBody
- EventHubConsumerGroupBodyDescription
Groupe de consommateurs à ajouter.
Paramètres d’options.
Retours
Promise<EventHubConsumerGroupInfo>
deleteEventHubConsumerGroup(string, string, string, string, IotHubResourceDeleteEventHubConsumerGroupOptionalParams)
Supprimez un groupe de consommateurs d’un point de terminaison compatible Event Hub dans un hub IoT.
function deleteEventHubConsumerGroup(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, name: string, options?: IotHubResourceDeleteEventHubConsumerGroupOptionalParams): Promise<void>
Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources qui contient le hub IoT.
- resourceName
-
string
Nom du hub IoT.
- eventHubEndpointName
-
string
Nom du point de terminaison compatible Event Hub dans le hub IoT.
- name
-
string
Nom du groupe de consommateurs à supprimer.
Paramètres d’options.
Retours
Promise<void>
exportDevices(string, string, ExportDevicesRequest, IotHubResourceExportDevicesOptionalParams)
Exporte toutes les identités d’appareil dans le registre d’identités IoT Hub vers un conteneur d’objets blob Stockage Azure. Pour plus d’informations, consultez : https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.
function exportDevices(resourceGroupName: string, resourceName: string, exportDevicesParameters: ExportDevicesRequest, options?: IotHubResourceExportDevicesOptionalParams): Promise<JobResponse>
Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources qui contient le hub IoT.
- resourceName
-
string
Nom du hub IoT.
- exportDevicesParameters
- ExportDevicesRequest
Paramètres qui spécifient l’opération d’exportation des appareils.
Paramètres d’options.
Retours
Promise<JobResponse>
get(string, string, IotHubResourceGetOptionalParams)
Obtenez les métadonnées non liées à la sécurité d’un hub IoT.
function get(resourceGroupName: string, resourceName: string, options?: IotHubResourceGetOptionalParams): Promise<IotHubDescription>
Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources qui contient le hub IoT.
- resourceName
-
string
Nom du hub IoT.
- options
- IotHubResourceGetOptionalParams
Paramètres d’options.
Retours
Promise<IotHubDescription>
getEventHubConsumerGroup(string, string, string, string, IotHubResourceGetEventHubConsumerGroupOptionalParams)
Obtenez un groupe de consommateurs à partir du point de terminaison appareil-à-cloud compatible avec Event Hub pour un hub IoT.
function getEventHubConsumerGroup(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, name: string, options?: IotHubResourceGetEventHubConsumerGroupOptionalParams): Promise<EventHubConsumerGroupInfo>
Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources qui contient le hub IoT.
- resourceName
-
string
Nom du hub IoT.
- eventHubEndpointName
-
string
Nom du point de terminaison compatible Event Hub dans le hub IoT.
- name
-
string
Nom du groupe de consommateurs à récupérer.
Paramètres d’options.
Retours
Promise<EventHubConsumerGroupInfo>
getJob(string, string, string, IotHubResourceGetJobOptionalParams)
Obtenez les détails d’un travail à partir d’un hub IoT. Pour plus d’informations, consultez : https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.
function getJob(resourceGroupName: string, resourceName: string, jobId: string, options?: IotHubResourceGetJobOptionalParams): Promise<JobResponse>
Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources qui contient le hub IoT.
- resourceName
-
string
Nom du hub IoT.
- jobId
-
string
Identificateur du travail.
Paramètres d’options.
Retours
Promise<JobResponse>
getKeysForKeyName(string, string, string, IotHubResourceGetKeysForKeyNameOptionalParams)
Obtenez une stratégie d’accès partagé par nom à partir d’un hub IoT. Pour plus d’informations, consultez : https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.
function getKeysForKeyName(resourceGroupName: string, resourceName: string, keyName: string, options?: IotHubResourceGetKeysForKeyNameOptionalParams): Promise<SharedAccessSignatureAuthorizationRule>
Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources qui contient le hub IoT.
- resourceName
-
string
Nom du hub IoT.
- keyName
-
string
Nom de la stratégie d’accès partagé.
Paramètres d’options.
Retours
getStats(string, string, IotHubResourceGetStatsOptionalParams)
Obtenez les statistiques à partir d’un hub IoT.
function getStats(resourceGroupName: string, resourceName: string, options?: IotHubResourceGetStatsOptionalParams): Promise<RegistryStatistics>
Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources qui contient le hub IoT.
- resourceName
-
string
Nom du hub IoT.
Paramètres d’options.
Retours
Promise<RegistryStatistics>
importDevices(string, string, ImportDevicesRequest, IotHubResourceImportDevicesOptionalParams)
Importez, mettez à jour ou supprimez des identités d’appareil dans le registre des identités IoT Hub à partir d’un objet blob. Pour plus d’informations, consultez : https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.
function importDevices(resourceGroupName: string, resourceName: string, importDevicesParameters: ImportDevicesRequest, options?: IotHubResourceImportDevicesOptionalParams): Promise<JobResponse>
Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources qui contient le hub IoT.
- resourceName
-
string
Nom du hub IoT.
- importDevicesParameters
- ImportDevicesRequest
Paramètres qui spécifient l’opération d’importation des appareils.
Paramètres d’options.
Retours
Promise<JobResponse>
listByResourceGroup(string, IotHubResourceListByResourceGroupOptionalParams)
Obtenez tous les hubs IoT dans un groupe de ressources.
function listByResourceGroup(resourceGroupName: string, options?: IotHubResourceListByResourceGroupOptionalParams): PagedAsyncIterableIterator<IotHubDescription, IotHubDescription[], PageSettings>
Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources qui contient le hub IoT.
Paramètres d’options.
Retours
listBySubscription(IotHubResourceListBySubscriptionOptionalParams)
Obtenez tous les hubs IoT dans un abonnement.
function listBySubscription(options?: IotHubResourceListBySubscriptionOptionalParams): PagedAsyncIterableIterator<IotHubDescription, IotHubDescription[], PageSettings>
Paramètres
Paramètres d’options.
Retours
listEndpointHealth(string, string, IotHubResourceGetEndpointHealthOptionalParams)
Obtenez l’intégrité des points de terminaison de routage.
function listEndpointHealth(resourceGroupName: string, iotHubName: string, options?: IotHubResourceGetEndpointHealthOptionalParams): PagedAsyncIterableIterator<EndpointHealthData, EndpointHealthData[], PageSettings>
Paramètres
- resourceGroupName
-
string
- iotHubName
-
string
Paramètres d’options.
Retours
listEventHubConsumerGroups(string, string, string, IotHubResourceListEventHubConsumerGroupsOptionalParams)
Obtenez la liste des groupes de consommateurs dans le point de terminaison appareil-à-cloud compatible avec Event Hub dans un hub IoT.
function listEventHubConsumerGroups(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, options?: IotHubResourceListEventHubConsumerGroupsOptionalParams): PagedAsyncIterableIterator<EventHubConsumerGroupInfo, EventHubConsumerGroupInfo[], PageSettings>
Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources qui contient le hub IoT.
- resourceName
-
string
Nom du hub IoT.
- eventHubEndpointName
-
string
Nom du point de terminaison compatible Event Hub.
Paramètres d’options.
Retours
listJobs(string, string, IotHubResourceListJobsOptionalParams)
Obtenez la liste de tous les travaux dans un hub IoT. Pour plus d’informations, consultez : https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.
function listJobs(resourceGroupName: string, resourceName: string, options?: IotHubResourceListJobsOptionalParams): PagedAsyncIterableIterator<JobResponse, JobResponse[], PageSettings>
Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources qui contient le hub IoT.
- resourceName
-
string
Nom du hub IoT.
Paramètres d’options.
Retours
listKeys(string, string, IotHubResourceListKeysOptionalParams)
Obtenez les métadonnées de sécurité d’un hub IoT. Pour plus d’informations, consultez : https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.
function listKeys(resourceGroupName: string, resourceName: string, options?: IotHubResourceListKeysOptionalParams): PagedAsyncIterableIterator<SharedAccessSignatureAuthorizationRule, SharedAccessSignatureAuthorizationRule[], PageSettings>
Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources qui contient le hub IoT.
- resourceName
-
string
Nom du hub IoT.
Paramètres d’options.
Retours
listQuotaMetrics(string, string, IotHubResourceGetQuotaMetricsOptionalParams)
Obtenez les métriques de quota pour un hub IoT.
function listQuotaMetrics(resourceGroupName: string, resourceName: string, options?: IotHubResourceGetQuotaMetricsOptionalParams): PagedAsyncIterableIterator<IotHubQuotaMetricInfo, IotHubQuotaMetricInfo[], PageSettings>
Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources qui contient le hub IoT.
- resourceName
-
string
Nom du hub IoT.
Paramètres d’options.
Retours
listValidSkus(string, string, IotHubResourceGetValidSkusOptionalParams)
Obtenez la liste des références SKU valides pour un hub IoT.
function listValidSkus(resourceGroupName: string, resourceName: string, options?: IotHubResourceGetValidSkusOptionalParams): PagedAsyncIterableIterator<IotHubSkuDescription, IotHubSkuDescription[], PageSettings>
Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources qui contient le hub IoT.
- resourceName
-
string
Nom du hub IoT.
Paramètres d’options.
Retours
testAllRoutes(string, string, TestAllRoutesInput, IotHubResourceTestAllRoutesOptionalParams)
Tester tous les itinéraires configurés dans ce hub Iot
function testAllRoutes(iotHubName: string, resourceGroupName: string, input: TestAllRoutesInput, options?: IotHubResourceTestAllRoutesOptionalParams): Promise<TestAllRoutesResult>
Paramètres
- iotHubName
-
string
IotHub à tester
- resourceGroupName
-
string
groupe de ressources auquel iot Hub appartient
- input
- TestAllRoutesInput
Entrée pour le test de tous les itinéraires
Paramètres d’options.
Retours
Promise<TestAllRoutesResult>
testRoute(string, string, TestRouteInput, IotHubResourceTestRouteOptionalParams)
Tester la nouvelle route pour ce hub Iot
function testRoute(iotHubName: string, resourceGroupName: string, input: TestRouteInput, options?: IotHubResourceTestRouteOptionalParams): Promise<TestRouteResult>
Paramètres
- iotHubName
-
string
IotHub à tester
- resourceGroupName
-
string
groupe de ressources auquel iot Hub appartient
- input
- TestRouteInput
Itinéraire à tester
Paramètres d’options.
Retours
Promise<TestRouteResult>