IotHubResource interface
Gränssnitt som representerar en IotHubResource.
Metoder
Metodinformation
beginCreateOrUpdate(string, string, IotHubDescription, IotHubResourceCreateOrUpdateOptionalParams)
Skapa eller uppdatera metadata för en Iot-hubb. Det vanliga mönstret för att ändra en egenskap är att hämta IoT Hub-metadata och säkerhetsmetadata och sedan kombinera dem med de ändrade värdena i en ny brödtext för att uppdatera IoT-hubben. Om vissa egenskaper saknas i JSON kan uppdatering av IoT Hub leda till att dessa värden återgår till standardvärdet, vilket kan leda till oväntat beteende.
function beginCreateOrUpdate(resourceGroupName: string, resourceName: string, iotHubDescription: IotHubDescription, options?: IotHubResourceCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<IotHubDescription>, IotHubDescription>>Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen som innehåller IoT-hubben.
- resourceName
-
string
Namnet på IoT-hubben.
- iotHubDescription
- IotHubDescription
IoT Hub-metadata och säkerhetsmetadata.
Alternativparametrarna.
Returer
Promise<PollerLike<@azure/core-lro.PollOperationState<IotHubDescription>, IotHubDescription>>
beginCreateOrUpdateAndWait(string, string, IotHubDescription, IotHubResourceCreateOrUpdateOptionalParams)
Skapa eller uppdatera metadata för en Iot-hubb. Det vanliga mönstret för att ändra en egenskap är att hämta IoT Hub-metadata och säkerhetsmetadata och sedan kombinera dem med de ändrade värdena i en ny brödtext för att uppdatera IoT-hubben. Om vissa egenskaper saknas i JSON kan uppdatering av IoT Hub leda till att dessa värden återgår till standardvärdet, vilket kan leda till oväntat beteende.
function beginCreateOrUpdateAndWait(resourceGroupName: string, resourceName: string, iotHubDescription: IotHubDescription, options?: IotHubResourceCreateOrUpdateOptionalParams): Promise<IotHubDescription>Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen som innehåller IoT-hubben.
- resourceName
-
string
Namnet på IoT-hubben.
- iotHubDescription
- IotHubDescription
IoT Hub-metadata och säkerhetsmetadata.
Alternativparametrarna.
Returer
Promise<IotHubDescription>
beginDelete(string, string, IotHubResourceDeleteOptionalParams)
Ta bort en IoT-hubb.
function beginDelete(resourceGroupName: string, resourceName: string, options?: IotHubResourceDeleteOptionalParams): Promise<PollerLike<PollOperationState<IotHubDescription>, IotHubDescription>>Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen som innehåller IoT-hubben.
- resourceName
-
string
Namnet på IoT-hubben.
Alternativparametrarna.
Returer
Promise<PollerLike<@azure/core-lro.PollOperationState<IotHubDescription>, IotHubDescription>>
beginDeleteAndWait(string, string, IotHubResourceDeleteOptionalParams)
Ta bort en IoT-hubb.
function beginDeleteAndWait(resourceGroupName: string, resourceName: string, options?: IotHubResourceDeleteOptionalParams): Promise<IotHubDescription>Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen som innehåller IoT-hubben.
- resourceName
-
string
Namnet på IoT-hubben.
Alternativparametrarna.
Returer
Promise<IotHubDescription>
beginUpdate(string, string, TagsResource, IotHubResourceUpdateOptionalParams)
Uppdatera en befintlig IoT Hub-taggar. om du vill uppdatera andra fält använder du metoden CreateOrUpdate
function beginUpdate(resourceGroupName: string, resourceName: string, iotHubTags: TagsResource, options?: IotHubResourceUpdateOptionalParams): Promise<PollerLike<PollOperationState<IotHubDescription>, IotHubDescription>>Parametrar
- resourceGroupName
-
string
Resursgruppsidentifierare.
- resourceName
-
string
Namnet på den iot-hubb som ska uppdateras.
- iotHubTags
- TagsResource
Tagginformationen har uppdaterats till iot Hub-instansen.
Alternativparametrarna.
Returer
Promise<PollerLike<@azure/core-lro.PollOperationState<IotHubDescription>, IotHubDescription>>
beginUpdateAndWait(string, string, TagsResource, IotHubResourceUpdateOptionalParams)
Uppdatera en befintlig IoT Hub-taggar. om du vill uppdatera andra fält använder du metoden CreateOrUpdate
function beginUpdateAndWait(resourceGroupName: string, resourceName: string, iotHubTags: TagsResource, options?: IotHubResourceUpdateOptionalParams): Promise<IotHubDescription>Parametrar
- resourceGroupName
-
string
Resursgruppsidentifierare.
- resourceName
-
string
Namnet på den iot-hubb som ska uppdateras.
- iotHubTags
- TagsResource
Tagginformationen har uppdaterats till iot Hub-instansen.
Alternativparametrarna.
Returer
Promise<IotHubDescription>
checkNameAvailability(OperationInputs, IotHubResourceCheckNameAvailabilityOptionalParams)
Kontrollera om ett IoT-hubbnamn är tillgängligt.
function checkNameAvailability(operationInputs: OperationInputs, options?: IotHubResourceCheckNameAvailabilityOptionalParams): Promise<IotHubNameAvailabilityInfo>Parametrar
- operationInputs
- OperationInputs
Ange namnparametern i OperationInputs-strukturen till namnet på den IoT-hubb som ska kontrolleras.
Alternativparametrarna.
Returer
Promise<IotHubNameAvailabilityInfo>
createEventHubConsumerGroup(string, string, string, string, IotHubResourceCreateEventHubConsumerGroupOptionalParams)
Lägg till en konsumentgrupp i en Event Hub-kompatibel slutpunkt i en IoT-hubb.
function createEventHubConsumerGroup(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, name: string, options?: IotHubResourceCreateEventHubConsumerGroupOptionalParams): Promise<EventHubConsumerGroupInfo>Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen som innehåller IoT-hubben.
- resourceName
-
string
Namnet på IoT-hubben.
- eventHubEndpointName
-
string
Namnet på den Event Hub-kompatibla slutpunkten i IoT-hubben.
- name
-
string
Namnet på den konsumentgrupp som ska läggas till.
Alternativparametrarna.
Returer
Promise<EventHubConsumerGroupInfo>
deleteEventHubConsumerGroup(string, string, string, string, IotHubResourceDeleteEventHubConsumerGroupOptionalParams)
Ta bort en konsumentgrupp från en Event Hub-kompatibel slutpunkt i en IoT-hubb.
function deleteEventHubConsumerGroup(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, name: string, options?: IotHubResourceDeleteEventHubConsumerGroupOptionalParams): Promise<void>Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen som innehåller IoT-hubben.
- resourceName
-
string
Namnet på IoT-hubben.
- eventHubEndpointName
-
string
Namnet på den Event Hub-kompatibla slutpunkten i IoT-hubben.
- name
-
string
Namnet på den konsumentgrupp som ska tas bort.
Alternativparametrarna.
Returer
Promise<void>
exportDevices(string, string, ExportDevicesRequest, IotHubResourceExportDevicesOptionalParams)
Exporterar alla enhetsidentiteter i IoT Hub-identitetsregistret till en Azure Storage-blobcontainer. Mer information finns i: 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>Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen som innehåller IoT-hubben.
- resourceName
-
string
Namnet på IoT-hubben.
- exportDevicesParameters
- ExportDevicesRequest
Parametrarna som anger åtgärden exportera enheter.
Alternativparametrarna.
Returer
Promise<JobResponse>
get(string, string, IotHubResourceGetOptionalParams)
Hämta icke-säkerhetsrelaterade metadata för en IoT-hubb.
function get(resourceGroupName: string, resourceName: string, options?: IotHubResourceGetOptionalParams): Promise<IotHubDescription>Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen som innehåller IoT-hubben.
- resourceName
-
string
Namnet på IoT-hubben.
- options
- IotHubResourceGetOptionalParams
Alternativparametrarna.
Returer
Promise<IotHubDescription>
getEventHubConsumerGroup(string, string, string, string, IotHubResourceGetEventHubConsumerGroupOptionalParams)
Hämta en konsumentgrupp från den Event Hub-kompatibla slutpunkten från enhet till moln för en IoT-hubb.
function getEventHubConsumerGroup(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, name: string, options?: IotHubResourceGetEventHubConsumerGroupOptionalParams): Promise<EventHubConsumerGroupInfo>Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen som innehåller IoT-hubben.
- resourceName
-
string
Namnet på IoT-hubben.
- eventHubEndpointName
-
string
Namnet på den Event Hub-kompatibla slutpunkten i IoT-hubben.
- name
-
string
Namnet på den konsumentgrupp som ska hämtas.
Alternativparametrarna.
Returer
Promise<EventHubConsumerGroupInfo>
getJob(string, string, string, IotHubResourceGetJobOptionalParams)
Hämta information om ett jobb från en IoT-hubb. Mer information finns i: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.
function getJob(resourceGroupName: string, resourceName: string, jobId: string, options?: IotHubResourceGetJobOptionalParams): Promise<JobResponse>Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen som innehåller IoT-hubben.
- resourceName
-
string
Namnet på IoT-hubben.
- jobId
-
string
Jobbidentifieraren.
Alternativparametrarna.
Returer
Promise<JobResponse>
getKeysForKeyName(string, string, string, IotHubResourceGetKeysForKeyNameOptionalParams)
Hämta en princip för delad åtkomst med namn från en IoT-hubb. Mer information finns i: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.
function getKeysForKeyName(resourceGroupName: string, resourceName: string, keyName: string, options?: IotHubResourceGetKeysForKeyNameOptionalParams): Promise<SharedAccessSignatureAuthorizationRule>Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen som innehåller IoT-hubben.
- resourceName
-
string
Namnet på IoT-hubben.
- keyName
-
string
Namnet på principen för delad åtkomst.
Alternativparametrarna.
Returer
getStats(string, string, IotHubResourceGetStatsOptionalParams)
Hämta statistiken från en IoT-hubb.
function getStats(resourceGroupName: string, resourceName: string, options?: IotHubResourceGetStatsOptionalParams): Promise<RegistryStatistics>Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen som innehåller IoT-hubben.
- resourceName
-
string
Namnet på IoT-hubben.
Alternativparametrarna.
Returer
Promise<RegistryStatistics>
importDevices(string, string, ImportDevicesRequest, IotHubResourceImportDevicesOptionalParams)
Importera, uppdatera eller ta bort enhetsidentiteter i IoT Hub-identitetsregistret från en blob. Mer information finns i: 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>Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen som innehåller IoT-hubben.
- resourceName
-
string
Namnet på IoT-hubben.
- importDevicesParameters
- ImportDevicesRequest
Parametrarna som anger åtgärden importera enheter.
Alternativparametrarna.
Returer
Promise<JobResponse>
listByResourceGroup(string, IotHubResourceListByResourceGroupOptionalParams)
Hämta alla IoT-hubbar i en resursgrupp.
function listByResourceGroup(resourceGroupName: string, options?: IotHubResourceListByResourceGroupOptionalParams): PagedAsyncIterableIterator<IotHubDescription, IotHubDescription[], PageSettings>Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen som innehåller IoT-hubben.
Alternativparametrarna.
Returer
listBySubscription(IotHubResourceListBySubscriptionOptionalParams)
Hämta alla IoT-hubbar i en prenumeration.
function listBySubscription(options?: IotHubResourceListBySubscriptionOptionalParams): PagedAsyncIterableIterator<IotHubDescription, IotHubDescription[], PageSettings>Parametrar
Alternativparametrarna.
Returer
listEndpointHealth(string, string, IotHubResourceGetEndpointHealthOptionalParams)
Hämta hälsotillståndet för routningsslutpunkter.
function listEndpointHealth(resourceGroupName: string, iotHubName: string, options?: IotHubResourceGetEndpointHealthOptionalParams): PagedAsyncIterableIterator<EndpointHealthData, EndpointHealthData[], PageSettings>Parametrar
- resourceGroupName
-
string
- iotHubName
-
string
Alternativparametrarna.
Returer
listEventHubConsumerGroups(string, string, string, IotHubResourceListEventHubConsumerGroupsOptionalParams)
Hämta en lista över konsumentgrupper i den Event Hub-kompatibla slutpunkten från enhet till moln i en IoT-hubb.
function listEventHubConsumerGroups(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, options?: IotHubResourceListEventHubConsumerGroupsOptionalParams): PagedAsyncIterableIterator<EventHubConsumerGroupInfo, EventHubConsumerGroupInfo[], PageSettings>Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen som innehåller IoT-hubben.
- resourceName
-
string
Namnet på IoT-hubben.
- eventHubEndpointName
-
string
Namnet på den Event Hub-kompatibla slutpunkten.
Alternativparametrarna.
Returer
listJobs(string, string, IotHubResourceListJobsOptionalParams)
Hämta en lista över alla jobb i en IoT-hubb. Mer information finns i: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.
function listJobs(resourceGroupName: string, resourceName: string, options?: IotHubResourceListJobsOptionalParams): PagedAsyncIterableIterator<JobResponse, JobResponse[], PageSettings>Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen som innehåller IoT-hubben.
- resourceName
-
string
Namnet på IoT-hubben.
Alternativparametrarna.
Returer
listKeys(string, string, IotHubResourceListKeysOptionalParams)
Hämta säkerhetsmetadata för en IoT-hubb. Mer information finns i: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.
function listKeys(resourceGroupName: string, resourceName: string, options?: IotHubResourceListKeysOptionalParams): PagedAsyncIterableIterator<SharedAccessSignatureAuthorizationRule, SharedAccessSignatureAuthorizationRule[], PageSettings>Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen som innehåller IoT-hubben.
- resourceName
-
string
Namnet på IoT-hubben.
Alternativparametrarna.
Returer
listQuotaMetrics(string, string, IotHubResourceGetQuotaMetricsOptionalParams)
Hämta kvotmåtten för en IoT-hubb.
function listQuotaMetrics(resourceGroupName: string, resourceName: string, options?: IotHubResourceGetQuotaMetricsOptionalParams): PagedAsyncIterableIterator<IotHubQuotaMetricInfo, IotHubQuotaMetricInfo[], PageSettings>Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen som innehåller IoT-hubben.
- resourceName
-
string
Namnet på IoT-hubben.
Alternativparametrarna.
Returer
listValidSkus(string, string, IotHubResourceGetValidSkusOptionalParams)
Hämta listan över giltiga SKU:er för en IoT-hubb.
function listValidSkus(resourceGroupName: string, resourceName: string, options?: IotHubResourceGetValidSkusOptionalParams): PagedAsyncIterableIterator<IotHubSkuDescription, IotHubSkuDescription[], PageSettings>Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen som innehåller IoT-hubben.
- resourceName
-
string
Namnet på IoT-hubben.
Alternativparametrarna.
Returer
testAllRoutes(string, string, TestAllRoutesInput, IotHubResourceTestAllRoutesOptionalParams)
Testa alla vägar som konfigurerats i den här Iot Hub
function testAllRoutes(iotHubName: string, resourceGroupName: string, input: TestAllRoutesInput, options?: IotHubResourceTestAllRoutesOptionalParams): Promise<TestAllRoutesResult>Parametrar
- iotHubName
-
string
IotHub ska testas
- resourceGroupName
-
string
resursgrupp som Iot Hub tillhör
- input
- TestAllRoutesInput
Indata för testning av alla vägar
Alternativparametrarna.
Returer
Promise<TestAllRoutesResult>
testRoute(string, string, TestRouteInput, IotHubResourceTestRouteOptionalParams)
Testa den nya vägen för den här Iot Hub
function testRoute(iotHubName: string, resourceGroupName: string, input: TestRouteInput, options?: IotHubResourceTestRouteOptionalParams): Promise<TestRouteResult>Parametrar
- iotHubName
-
string
IotHub ska testas
- resourceGroupName
-
string
resursgrupp som Iot Hub tillhör
- input
- TestRouteInput
Väg som måste testas
Alternativparametrarna.
Returer
Promise<TestRouteResult>