你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
IotHubResourceOperations 类
- 继承
-
builtins.objectIotHubResourceOperations
构造函数
IotHubResourceOperations(*args, **kwargs)
方法
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]
参数
- content_type
- str
正文参数内容类型。 已知值为:“application/json”。 默认值为 None。
- cls
- callable
将传递直接响应的自定义类型或函数
- continuation_token
- str
用于从保存状态重启轮询的延续标记。
- polling
- bool 或 PollingMethod
默认情况下,轮询方法将为 ARMPolling。 如果此操作不轮询,则传入 False,或者为个人轮询策略传入你自己的初始化轮询对象。
- polling_interval
- int
如果没有 Retry-After 标头,则 LRO 操作的两次轮询之间的默认等待时间。
返回
LROPoller 的实例,返回 IotHubDescription 或 cls 的结果 (响应)
返回类型
例外
begin_delete
删除 IoT 中心。
删除 IoT 中心。
begin_delete(resource_group_name: str, resource_name: str, **kwargs: Any) -> LROPoller[IotHubDescription]
参数
- cls
- callable
将传递直接响应的自定义类型或函数
- continuation_token
- str
用于从保存状态重启轮询的延续标记。
- polling
- bool 或 PollingMethod
默认情况下,轮询方法将为 ARMPolling。 如果此操作不轮询,则传入 False,或者为个人轮询策略传入你自己的初始化轮询对象。
- polling_interval
- int
如果没有 Retry-After 标头,则 LRO 操作的两次轮询之间的默认等待时间。
返回
返回 IotHubDescription 或 LROPoller 的实例,返回 ErrorDetails 或 cls 的结果 (响应)
返回类型
例外
begin_update
更新现有的 IoT 中心标记。
更新现有IoT 中心标记。 若要更新其他字段,请使用 CreateOrUpdate 方法。
begin_update(resource_group_name: str, resource_name: str, iot_hub_tags: _models.TagsResource, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.IotHubDescription]
参数
- content_type
- str
正文参数内容类型。 已知值为:“application/json”。 默认值为 None。
- cls
- callable
将传递直接响应的自定义类型或函数
- continuation_token
- str
用于从保存状态重启轮询的延续标记。
- polling
- bool 或 PollingMethod
默认情况下,轮询方法将为 ARMPolling。 如果此操作不轮询,则传入 False,或者为个人轮询策略传入你自己的初始化轮询对象。
- polling_interval
- int
如果没有 Retry-After 标头,则 LRO 操作的两次轮询之间的默认等待时间。
返回
LROPoller 的实例,返回 IotHubDescription 或 cls 的结果 (响应)
返回类型
例外
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
正文参数内容类型。 已知值为:“application/json”。 默认值为 None。
- cls
- callable
将传递直接响应的自定义类型或函数
返回
IotHubNameAvailabilityInfo 或 cls 的结果 (响应)
返回类型
例外
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, consumer_group_body: _models.EventHubConsumerGroupBodyDescription, *, content_type: str = 'application/json', **kwargs: Any) -> _models.EventHubConsumerGroupInfo
参数
- consumer_group_body
- EventHubConsumerGroupBodyDescription 或 IO
要添加的使用者组。 是 EventHubConsumerGroupBodyDescription 类型或 IO 类型。 必需。
- content_type
- str
正文参数内容类型。 已知值为:“application/json”。 默认值为 None。
- cls
- callable
将传递直接响应的自定义类型或函数
返回
EventHubConsumerGroupInfo 或 cls 的结果 (响应)
返回类型
例外
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
参数
- cls
- callable
将传递直接响应的自定义类型或函数
返回
无或 cls 的结果 (响应)
返回类型
例外
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
参数
- export_devices_parameters
- ExportDevicesRequest 或 IO
指定导出设备操作的参数。 是 ExportDevicesRequest 类型或 IO 类型。 必需。
- content_type
- str
Body 参数内容类型。 已知值为:“application/json”。 默认值为 None。
- cls
- callable
将传递直接响应的自定义类型或函数
返回
JobResponse 或 cls 的结果 (响应)
返回类型
例外
get
获取 IoT 中心的非安全相关元数据。
获取 IoT 中心的非安全相关元数据。
get(resource_group_name: str, resource_name: str, **kwargs: Any) -> IotHubDescription
参数
- cls
- callable
将传递直接响应的自定义类型或函数
返回
IotHubDescription 或 cls 的结果 (响应)
返回类型
例外
get_endpoint_health
获取路由终结点的运行状况。
获取路由终结点的运行状况。
get_endpoint_health(resource_group_name: str, iot_hub_name: str, **kwargs: Any) -> Iterable[EndpointHealthData]
参数
- cls
- callable
将传递直接响应的自定义类型或函数
返回
迭代器,例如 EndpointHealthData 的实例或 cls 的结果 (响应)
返回类型
例外
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
参数
- cls
- callable
将传递直接响应的自定义类型或函数
返回
EventHubConsumerGroupInfo 或 cls 的结果 (响应)
返回类型
例外
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
参数
- cls
- callable
将传递直接响应的自定义类型或函数
返回
JobResponse 或 cls 的结果 (响应)
返回类型
例外
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
参数
- cls
- callable
将传递直接响应的自定义类型或函数
返回
SharedAccessSignatureAuthorizationRule 或 cls 的结果 (响应)
返回类型
例外
get_quota_metrics
获取 IoT 中心的配额指标。
获取 IoT 中心的配额指标。
get_quota_metrics(resource_group_name: str, resource_name: str, **kwargs: Any) -> Iterable[IotHubQuotaMetricInfo]
参数
- cls
- callable
将传递直接响应的自定义类型或函数
返回
迭代器,如 IotHubQuotaMetricInfo 的实例或 cls 的结果 (响应)
返回类型
例外
get_stats
从 IoT 中心获取统计信息。
从 IoT 中心获取统计信息。
get_stats(resource_group_name: str, resource_name: str, **kwargs: Any) -> RegistryStatistics
参数
- cls
- callable
将传递直接响应的自定义类型或函数
返回
RegistryStatistics 或 cls 的结果 (响应)
返回类型
例外
get_valid_skus
获取 IoT 中心的有效 SKU 列表。
获取 IoT 中心的有效 SKU 列表。
get_valid_skus(resource_group_name: str, resource_name: str, **kwargs: Any) -> Iterable[IotHubSkuDescription]
参数
- cls
- callable
将传递直接响应的自定义类型或函数
返回
迭代器,如 IotHubSkuDescription 的实例或 cls 的结果 (响应)
返回类型
例外
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
参数
- import_devices_parameters
- ImportDevicesRequest 或 IO
指定导入设备操作的参数。 是 ImportDevicesRequest 类型或 IO 类型。 必需。
- content_type
- str
正文参数内容类型。 已知值为:“application/json”。 默认值为 None。
- cls
- callable
将传递直接响应的自定义类型或函数
返回
JobResponse 或 cls 的结果 (响应)
返回类型
例外
list_by_resource_group
获取资源组中的所有 IoT 中心。
获取资源组中的所有 IoT 中心。
list_by_resource_group(resource_group_name: str, **kwargs: Any) -> Iterable[IotHubDescription]
参数
- cls
- callable
将传递直接响应的自定义类型或函数
返回
IotHubDescription 的实例或 cls 的结果等迭代器 (响应)
返回类型
例外
list_by_subscription
获取订阅中的所有 IoT 中心。
获取订阅中的所有 IoT 中心。
list_by_subscription(**kwargs: Any) -> Iterable[IotHubDescription]
参数
- cls
- callable
将传递直接响应的自定义类型或函数
返回
IotHubDescription 的实例或 cls 的结果等迭代器 (响应)
返回类型
例外
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[EventHubConsumerGroupInfo]
参数
- cls
- callable
将传递直接响应的自定义类型或函数
返回
一个迭代器,例如 EventHubConsumerGroupInfo 的实例或 cls 的结果 (响应)
返回类型
例外
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]
参数
- cls
- callable
将传递直接响应的自定义类型或函数
返回
一个迭代器,如 JobResponse 的实例或 cls 的结果 (响应)
返回类型
例外
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]
参数
- cls
- callable
将传递直接响应的自定义类型或函数
返回
一个迭代器,如 SharedAccessSignatureAuthorizationRule 的实例或 cls 的结果 (响应)
返回类型
例外
test_all_routes
测试所有路由。
测试在此 Iot 中心配置的所有路由。
test_all_routes(iot_hub_name: str, resource_group_name: str, input: _models.TestAllRoutesInput, *, content_type: str = 'application/json', **kwargs: Any) -> _models.TestAllRoutesResult
参数
- content_type
- str
正文参数内容类型。 已知值为:“application/json”。 默认值为 None。
- cls
- callable
将传递直接响应的自定义类型或函数
返回
TestAllRoutesResult 或 cls 的结果 (响应)
返回类型
例外
test_route
测试新路由。
测试此 Iot 中心的新路由。
test_route(iot_hub_name: str, resource_group_name: str, input: _models.TestRouteInput, *, content_type: str = 'application/json', **kwargs: Any) -> _models.TestRouteResult
参数
- content_type
- str
正文参数内容类型。 已知值为:“application/json”。 默认值为 None。
- cls
- callable
将传递直接响应的自定义类型或函数
返回
TestRouteResult 或 cls 的结果 (响应)
返回类型
例外
属性
models
models = <module 'azure.mgmt.iothub.v2023_06_30.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\mgmt\\iothub\\v2023_06_30\\models\\__init__.py'>