你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

IotHubResourceOperations 类

警告

请勿直接实例化此类。

相反，应通过以下方式访问以下操作：

IotHubClient's

<xref:iot_hub_resource> 属性。

继承

builtins.object

IotHubResourceOperations

构造函数

IotHubResourceOperations(*args, **kwargs)

方法

begin_create_or_update	创建或更新 IoT 中心的元数据。 创建或更新 IoT 中心的元数据。 修改属性的常用模式是检索 IoT 中心元数据和安全元数据，然后将它们与新正文中修改的值合并，以更新 IoT 中心。 如果 JSON 中缺少某些属性，更新IoT 中心可能会导致这些值回退为默认值，这可能会导致意外行为。
begin_delete	删除 IoT 中心。 删除 IoT 中心。
check_name_availability	检查 IoT 中心名称是否可用。 检查 IoT 中心名称是否可用。
create_event_hub_consumer_group	将使用者组添加到 IoT 中心内与事件中心兼容的终结点。 将使用者组添加到 IoT 中心内与事件中心兼容的终结点。
delete_event_hub_consumer_group	从 IoT 中心内与事件中心兼容的终结点中删除使用者组。 从 IoT 中心内与事件中心兼容的终结点中删除使用者组。
export_devices	将 IoT 中心标识注册表中的所有设备标识导出到 Azure 存储 Blob 容器。 有关详细信息，请参阅：https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities。 将 IoT 中心标识注册表中的所有设备标识导出到 Azure 存储 Blob 容器。 有关详细信息，请参阅：https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities。
get	获取 IoT 中心的非安全相关元数据。 获取 IoT 中心的非安全相关元数据。
get_event_hub_consumer_group	从 IoT 中心的事件中心兼容设备到云终结点获取使用者组。 从 IoT 中心的事件中心兼容设备到云终结点获取使用者组。
get_job	从 IoT 中心获取作业的详细信息。 有关详细信息，请参阅：https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry。 从 IoT 中心获取作业的详细信息。 有关详细信息，请参阅：https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry。
get_keys_for_key_name	从 IoT 中心按名称获取共享访问策略。 有关详细信息，请参阅：https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security。 从 IoT 中心按名称获取共享访问策略。 有关详细信息，请参阅：https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security。
get_quota_metrics	获取 IoT 中心的配额指标。 获取 IoT 中心的配额指标。
get_stats	从 IoT 中心获取统计信息。 从 IoT 中心获取统计信息。
get_valid_skus	获取 IoT 中心的有效 SKU 列表。 获取 IoT 中心的有效 SKU 列表。
import_devices	从 Blob 导入、更新或删除 IoT 中心标识注册表中的设备标识。 有关详细信息，请参阅：https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities。 从 Blob 导入、更新或删除 IoT 中心标识注册表中的设备标识。 有关详细信息，请参阅：https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities。
list_by_resource_group	获取资源组中的所有 IoT 中心。 获取资源组中的所有 IoT 中心。
list_by_subscription	获取订阅中的所有 IoT 中心。 获取订阅中的所有 IoT 中心。
list_event_hub_consumer_groups	获取 IoT 中心与事件中心兼容的设备到云终结点中的使用者组列表。 获取 IoT 中心与事件中心兼容的设备到云终结点中的使用者组列表。
list_jobs	获取 IoT 中心内所有作业的列表。 有关详细信息，请参阅：https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry。 获取 IoT 中心内所有作业的列表。 有关详细信息，请参阅：https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry。
list_keys	获取 IoT 中心的安全元数据。 有关详细信息，请参阅：https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security。 获取 IoT 中心的安全元数据。 有关详细信息，请参阅：https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security。

begin_create_or_update

创建或更新 IoT 中心的元数据。

创建或更新 IoT 中心的元数据。 修改属性的常用模式是检索 IoT 中心元数据和安全元数据，然后将它们与新正文中修改的值合并，以更新 IoT 中心。 如果 JSON 中缺少某些属性，更新IoT 中心可能会导致这些值回退为默认值，这可能会导致意外行为。

begin_create_or_update(resource_group_name: str, resource_name: str, iot_hub_description: _models.IotHubDescription, if_match: str | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.IotHubDescription]

参数

resource_group_name

str

必需

包含 IoT 中心的资源组的名称。 必需。

resource_name

str

必需

IoT 中心的名称。 必需。

iot_hub_description

IotHubDescription 或 IO

必需

IoT 中心元数据和安全元数据。 是 IotHubDescription 类型或 IO 类型。 必需。

if_match

str

必需

IoT 中心的 ETag。 不要指定 用于创建全新的IoT 中心。 更新现有IoT 中心所必需的。 默认值为 None。

content_type

str

Body 参数内容类型。 已知值为：“application/json”。 默认值为 None。

cls

callable

将传递直接响应的自定义类型或函数

continuation_token

str

用于从保存状态重启轮询的继续标记。

polling

bool 或 PollingMethod

默认情况下，轮询方法将为 ARMPolling。 将此操作传入 False 以不进行轮询，或为个人轮询策略传入你自己的初始化轮询对象。

polling_interval

int

如果没有Retry-After标头，则 LRO 操作的两次轮询之间的默认等待时间。

返回

LROPoller 的实例，返回 IotHubDescription 或 cls 的结果 (响应)

返回类型

LROPoller[IotHubDescription]

例外

HttpResponseError

begin_delete

删除 IoT 中心。

删除 IoT 中心。

begin_delete(resource_group_name: str, resource_name: str, **kwargs: Any) -> LROPoller[IotHubDescription]

参数

resource_group_name

str

必需

包含 IoT 中心的资源组的名称。 必需。

resource_name

str

必需

IoT 中心的名称。 必需。

cls

callable

将传递直接响应的自定义类型或函数

continuation_token

str

用于从保存状态重启轮询的继续标记。

polling

bool 或 PollingMethod

默认情况下，轮询方法将为 ARMPolling。 将此操作传入 False 以不进行轮询，或为个人轮询策略传入你自己的初始化轮询对象。

polling_interval

int

如果没有Retry-After标头，则 LRO 操作的两次轮询之间的默认等待时间。

返回

返回 IotHubDescription 或返回 ErrorDetails 或 cls 结果的 LROPoller 实例， (响应)

返回类型

LROPoller[IotHubDescription],

LROPoller[ErrorDetails]

例外

HttpResponseError

check_name_availability

检查 IoT 中心名称是否可用。

检查 IoT 中心名称是否可用。

check_name_availability(operation_inputs: _models.OperationInputs, *, content_type: str = 'application/json', **kwargs: Any) -> _models.IotHubNameAvailabilityInfo

参数

operation_inputs

OperationInputs 或 IO

必需

将 OperationInputs 结构中的 name 参数设置为 IoT 中心的名称以检查。 是 OperationInputs 类型或 IO 类型。 必需。

content_type

str

Body 参数内容类型。 已知值为：“application/json”。 默认值为 None。

cls

callable

将传递直接响应的自定义类型或函数

返回

IotHubNameAvailabilityInfo 或 cls 的结果 (响应)

返回类型

IotHubNameAvailabilityInfo

例外

HttpResponseError

create_event_hub_consumer_group

将使用者组添加到 IoT 中心内与事件中心兼容的终结点。

将使用者组添加到 IoT 中心内与事件中心兼容的终结点。

create_event_hub_consumer_group(resource_group_name: str, resource_name: str, event_hub_endpoint_name: str, name: str, **kwargs: Any) -> EventHubConsumerGroupInfo

参数

resource_group_name

str

必需

包含 IoT 中心的资源组的名称。 必需。

resource_name

str

必需

IoT 中心的名称。 必需。

event_hub_endpoint_name

str

必需

IoT 中心内与事件中心兼容的终结点的名称。 必需。

name

str

必需

要添加的使用者组的名称。 必需。

cls

callable

将传递直接响应的自定义类型或函数

返回

EventHubConsumerGroupInfo 或 cls 的结果 (响应)

返回类型

EventHubConsumerGroupInfo

例外

HttpResponseError

delete_event_hub_consumer_group

从 IoT 中心内与事件中心兼容的终结点中删除使用者组。

从 IoT 中心内与事件中心兼容的终结点中删除使用者组。

delete_event_hub_consumer_group(resource_group_name: str, resource_name: str, event_hub_endpoint_name: str, name: str, **kwargs: Any) -> None

参数

resource_group_name

str

必需

包含 IoT 中心的资源组的名称。 必需。

resource_name

str

必需

IoT 中心的名称。 必需。

event_hub_endpoint_name

str

必需

IoT 中心内与事件中心兼容的终结点的名称。 必需。

name

str

必需

要删除的使用者组的名称。 必需。

cls

callable

将传递直接响应的自定义类型或函数

返回

无或 cls 的结果 (响应)

返回类型

None

例外

HttpResponseError

export_devices

将 IoT 中心标识注册表中的所有设备标识导出到 Azure 存储 Blob 容器。 有关详细信息，请参阅：https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities。

将 IoT 中心标识注册表中的所有设备标识导出到 Azure 存储 Blob 容器。 有关详细信息，请参阅：https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities。

export_devices(resource_group_name: str, resource_name: str, export_devices_parameters: _models.ExportDevicesRequest, *, content_type: str = 'application/json', **kwargs: Any) -> _models.JobResponse

参数

resource_group_name

str

必需

包含 IoT 中心的资源组的名称。 必需。

resource_name

str

必需

IoT 中心的名称。 必需。

export_devices_parameters

ExportDevicesRequest 或 IO

必需

指定导出设备操作的参数。 是 ExportDevicesRequest 类型或 IO 类型。 必需。

content_type

str

Body 参数内容类型。 已知值为：“application/json”。 默认值为 None。

cls

callable

将传递直接响应的自定义类型或函数

返回

JobResponse 或 cls 的结果 (响应)

返回类型

JobResponse

例外

HttpResponseError

get

获取 IoT 中心的非安全相关元数据。

获取 IoT 中心的非安全相关元数据。

get(resource_group_name: str, resource_name: str, **kwargs: Any) -> IotHubDescription

参数

resource_group_name

str

必需

包含 IoT 中心的资源组的名称。 必需。

resource_name

str

必需

IoT 中心的名称。 必需。

cls

callable

将传递直接响应的自定义类型或函数

返回

IotHubDescription 或 cls 的结果 (响应)

返回类型

IotHubDescription

例外

HttpResponseError

get_event_hub_consumer_group

从 IoT 中心的事件中心兼容设备到云终结点获取使用者组。

从 IoT 中心的事件中心兼容设备到云终结点获取使用者组。

get_event_hub_consumer_group(resource_group_name: str, resource_name: str, event_hub_endpoint_name: str, name: str, **kwargs: Any) -> EventHubConsumerGroupInfo

参数

resource_group_name

str

必需

包含 IoT 中心的资源组的名称。 必需。

resource_name

str

必需

IoT 中心的名称。 必需。

event_hub_endpoint_name

str

必需

IoT 中心内与事件中心兼容的终结点的名称。 必需。

name

str

必需

要检索的使用者组的名称。 必需。

cls

callable

将传递直接响应的自定义类型或函数

返回

EventHubConsumerGroupInfo 或 cls 的结果 (响应)

返回类型

EventHubConsumerGroupInfo

例外

HttpResponseError

get_job

从 IoT 中心获取作业的详细信息。 有关详细信息，请参阅：https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry。

从 IoT 中心获取作业的详细信息。 有关详细信息，请参阅：https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry。

get_job(resource_group_name: str, resource_name: str, job_id: str, **kwargs: Any) -> JobResponse

参数

resource_group_name

str

必需

包含 IoT 中心的资源组的名称。 必需。

resource_name

str

必需

IoT 中心的名称。 必需。

job_id

str

必需

作业标识符。 必需。

cls

callable

将传递直接响应的自定义类型或函数

返回

JobResponse 或 cls 的结果 (响应)

返回类型

JobResponse

例外

HttpResponseError

get_keys_for_key_name

从 IoT 中心按名称获取共享访问策略。 有关详细信息，请参阅：https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security。

从 IoT 中心按名称获取共享访问策略。 有关详细信息，请参阅：https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security。

get_keys_for_key_name(resource_group_name: str, resource_name: str, key_name: str, **kwargs: Any) -> SharedAccessSignatureAuthorizationRule

参数

resource_group_name

str

必需

包含 IoT 中心的资源组的名称。 必需。

resource_name

str

必需

IoT 中心的名称。 必需。

key_name

str

必需

共享访问策略的名称。 必需。

cls

callable

将传递直接响应的自定义类型或函数

返回

SharedAccessSignatureAuthorizationRule 或 cls 的结果 (响应)

返回类型

SharedAccessSignatureAuthorizationRule

例外

HttpResponseError

get_quota_metrics

获取 IoT 中心的配额指标。

获取 IoT 中心的配额指标。

get_quota_metrics(resource_group_name: str, resource_name: str, **kwargs: Any) -> Iterable[IotHubQuotaMetricInfo]

参数

resource_group_name

str

必需

包含 IoT 中心的资源组的名称。 必需。

resource_name

str

必需

IoT 中心的名称。 必需。

cls

callable

将传递直接响应的自定义类型或函数

返回

迭代器，如 IotHubQuotaMetricInfo 的实例或 cls 的结果 (响应)

返回类型

ItemPaged[IotHubQuotaMetricInfo]

例外

HttpResponseError

get_stats

从 IoT 中心获取统计信息。

从 IoT 中心获取统计信息。

get_stats(resource_group_name: str, resource_name: str, **kwargs: Any) -> RegistryStatistics

参数

resource_group_name

str

必需

包含 IoT 中心的资源组的名称。 必需。

resource_name

str

必需

IoT 中心的名称。 必需。

cls

callable

将传递直接响应的自定义类型或函数

返回

RegistryStatistics 或 cls 的结果 (响应)

返回类型

RegistryStatistics

例外

HttpResponseError

get_valid_skus

获取 IoT 中心的有效 SKU 列表。

获取 IoT 中心的有效 SKU 列表。

get_valid_skus(resource_group_name: str, resource_name: str, **kwargs: Any) -> Iterable[IotHubSkuDescription]

参数

resource_group_name

str

必需

包含 IoT 中心的资源组的名称。 必需。

resource_name

str

必需

IoT 中心的名称。 必需。

cls

callable

将传递直接响应的自定义类型或函数

返回

迭代器，如 IotHubSkuDescription 的实例或 cls 的结果 (响应)

返回类型

ItemPaged[IotHubSkuDescription]

例外

HttpResponseError

import_devices

从 Blob 导入、更新或删除 IoT 中心标识注册表中的设备标识。 有关详细信息，请参阅：https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities。

从 Blob 导入、更新或删除 IoT 中心标识注册表中的设备标识。 有关详细信息，请参阅：https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities。

import_devices(resource_group_name: str, resource_name: str, import_devices_parameters: _models.ImportDevicesRequest, *, content_type: str = 'application/json', **kwargs: Any) -> _models.JobResponse

参数

resource_group_name

str

必需

包含 IoT 中心的资源组的名称。 必需。

resource_name

str

必需

IoT 中心的名称。 必需。

import_devices_parameters

ImportDevicesRequest 或 IO

必需

指定导入设备操作的参数。 是 ImportDevicesRequest 类型或 IO 类型。 必需。

content_type

str

Body 参数内容类型。 已知值为：“application/json”。 默认值为 None。

cls

callable

将传递直接响应的自定义类型或函数

返回

JobResponse 或 cls 的结果 (响应)

返回类型

JobResponse

例外

HttpResponseError

list_by_resource_group

获取资源组中的所有 IoT 中心。

获取资源组中的所有 IoT 中心。

list_by_resource_group(resource_group_name: str, **kwargs: Any) -> Iterable[IotHubDescription]

参数

resource_group_name

str

必需

包含 IoT 中心的资源组的名称。 必需。

cls

callable

将传递直接响应的自定义类型或函数

返回

迭代器，例如 IotHubDescription 的实例或 cls 的结果 (响应)

返回类型

ItemPaged[IotHubDescription]

例外

HttpResponseError

list_by_subscription

获取订阅中的所有 IoT 中心。

获取订阅中的所有 IoT 中心。

list_by_subscription(**kwargs: Any) -> Iterable[IotHubDescription]

参数

cls

callable

将传递直接响应的自定义类型或函数

返回

迭代器，例如 IotHubDescription 的实例或 cls 的结果 (响应)

返回类型

ItemPaged[IotHubDescription]

例外

HttpResponseError

list_event_hub_consumer_groups

获取 IoT 中心与事件中心兼容的设备到云终结点中的使用者组列表。

获取 IoT 中心与事件中心兼容的设备到云终结点中的使用者组列表。

list_event_hub_consumer_groups(resource_group_name: str, resource_name: str, event_hub_endpoint_name: str, **kwargs: Any) -> Iterable[str]

参数

resource_group_name

str

必需

包含 IoT 中心的资源组的名称。 必需。

resource_name

str

必需

IoT 中心的名称。 必需。

event_hub_endpoint_name

str

必需

与事件中心兼容的终结点的名称。 必需。

cls

callable

将传递直接响应的自定义类型或函数

返回

迭代器，如 str 实例或 cls 的结果 (响应)

返回类型

ItemPaged[str]

例外

HttpResponseError

list_jobs

获取 IoT 中心内所有作业的列表。 有关详细信息，请参阅：https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry。

获取 IoT 中心内所有作业的列表。 有关详细信息，请参阅：https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry。

list_jobs(resource_group_name: str, resource_name: str, **kwargs: Any) -> Iterable[JobResponse]

参数

resource_group_name

str

必需

包含 IoT 中心的资源组的名称。 必需。

resource_name

str

必需

IoT 中心的名称。 必需。

cls

callable

将传递直接响应的自定义类型或函数

返回

迭代器，如 JobResponse 的实例或 cls 的结果 (响应)

返回类型

ItemPaged[JobResponse]

例外

HttpResponseError

list_keys

获取 IoT 中心的安全元数据。 有关详细信息，请参阅：https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security。

获取 IoT 中心的安全元数据。 有关详细信息，请参阅：https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security。

list_keys(resource_group_name: str, resource_name: str, **kwargs: Any) -> Iterable[SharedAccessSignatureAuthorizationRule]

参数

resource_group_name

str

必需

包含 IoT 中心的资源组的名称。 必需。

resource_name

str

必需

IoT 中心的名称。 必需。

cls

callable

将传递直接响应的自定义类型或函数

返回

迭代器，如 SharedAccessSignatureAuthorizationRule 的实例或 cls 的结果 (响应)

返回类型

ItemPaged[SharedAccessSignatureAuthorizationRule]

例外

HttpResponseError

属性

models

models = <module 'azure.mgmt.iothub.v2017_07_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\mgmt\\iothub\\v2017_07_01\\models\\__init__.py'>