IotHubResourceOperations 類別
- 繼承
-
builtins.objectIotHubResourceOperations
建構函式
IotHubResourceOperations(*args, **kwargs)方法
begin_create_or_update
建立或更新 IoT 中樞的中繼資料。
建立或更新 IoT 中樞的中繼資料。 修改屬性的一般模式是擷取 IoT 中樞中繼資料和安全性中繼資料，然後將這些中繼資料與新本文中的修改值結合，以更新 IoT 中樞。 如果 JSON 中遺漏特定屬性，更新IoT 中樞可能會導致這些值回復為預設值，這可能會導致非預期的行為。
async 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) -> AsyncLROPoller[_models.IotHubDescription]參數
- iot_hub_description
- IotHubDescription 或 IO
IoT 中樞中繼資料和安全性中繼資料。 這是 IotHubDescription 類型或 IO 類型。 必要。
- content_type
- str
本文參數內容類型。 已知值為：'application/json'。 預設值為 [無]。
- cls
- callable
將傳遞直接回應的自訂類型或函式
- continuation_token
- str
從已儲存狀態重新開機輪詢器的接續權杖。
- polling
- bool 或 AsyncPollingMethod
根據預設，您的輪詢方法會是 AsyncARMPolling。 傳入 False 表示此作業無法輪詢，或傳入您自己的已初始化輪詢物件，以取得個人輪詢策略。
- polling_interval
- int
如果沒有Retry-After標頭，則兩次輪詢 LRO 作業之間的預設等候時間。
傳回
AsyncLROPoller 的實例，會傳回 IotHubDescription 或 cls 的結果 (回應)
傳回類型
例外狀況
begin_delete
刪除 IoT 中樞。
刪除 IoT 中樞。
async begin_delete(resource_group_name: str, resource_name: str, **kwargs: Any) -> AsyncLROPoller[IotHubDescription]參數
- cls
- callable
將傳遞直接回應的自訂類型或函式
- continuation_token
- str
從已儲存狀態重新開機輪詢器的接續權杖。
- polling
- bool 或 AsyncPollingMethod
根據預設，您的輪詢方法會是 AsyncARMPolling。 傳入 False 表示此作業無法輪詢，或傳入您自己的已初始化輪詢物件，以取得個人輪詢策略。
- polling_interval
- int
如果沒有Retry-After標頭，則兩次輪詢 LRO 作業之間的預設等候時間。
傳回
傳回 IotHubDescription 或 AsyncLROPoller 實例的 AsyncLROPoller 實例，會傳回 ErrorDetails 或 cls 的結果 (回應)
傳回類型
例外狀況
begin_update
更新現有的 IoT 中樞標籤。
更新現有的IoT 中樞標記。 若要更新其他欄位，請使用 CreateOrUpdate 方法。
async begin_update(resource_group_name: str, resource_name: str, iot_hub_tags: _models.TagsResource, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.IotHubDescription]參數
- content_type
- str
本文參數內容類型。 已知值為：'application/json'。 預設值為 [無]。
- cls
- callable
將傳遞直接回應的自訂類型或函式
- continuation_token
- str
從已儲存狀態重新開機輪詢器的接續權杖。
- polling
- bool 或 AsyncPollingMethod
根據預設，您的輪詢方法會是 AsyncARMPolling。 傳入 False 表示此作業無法輪詢，或傳入您自己的已初始化輪詢物件，以取得個人輪詢策略。
- polling_interval
- int
如果沒有Retry-After標頭，則兩次輪詢 LRO 作業之間的預設等候時間。
傳回
AsyncLROPoller 的實例，會傳回 IotHubDescription 或 cls 的結果 (回應)
傳回類型
例外狀況
check_name_availability
檢查 IoT 中樞名稱是否可用。
檢查 IoT 中樞名稱是否可用。
async 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'。 預設值為 [無]。
- cls
- callable
將傳遞直接回應的自訂類型或函式
傳回
IotHubNameAvailabilityInfo 或 cls (回應的結果)
傳回類型
例外狀況
create_event_hub_consumer_group
將取用者群組新增至 IoT 中樞的事件中樞相容端點。
將取用者群組新增至 IoT 中樞的事件中樞相容端點。
async create_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 (回應的結果)
傳回類型
例外狀況
delete_event_hub_consumer_group
從 IoT 中樞的事件中樞相容端點刪除取用者群組。
從 IoT 中樞的事件中樞相容端點刪除取用者群組。
async 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 \(英文\)。
async 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
本文參數內容類型。 已知值為：'application/json'。 預設值為 [無]。
- cls
- callable
將傳遞直接回應的自訂類型或函式
傳回
JobResponse 或 cls 的結果 (回應)
傳回類型
例外狀況
get
取得 IoT 中樞的非安全性相關中繼資料。
取得 IoT 中樞的非安全性相關中繼資料。
async get(resource_group_name: str, resource_name: str, **kwargs: Any) -> IotHubDescription參數
- cls
- callable
將傳遞直接回應的自訂類型或函式
傳回
IotHubDescription 或 cls 的結果 (回應)
傳回類型
例外狀況
get_event_hub_consumer_group
從 IoT 中樞的事件中樞相容裝置到雲端端點取得取用者群組。
從 IoT 中樞的事件中樞相容裝置到雲端端點取得取用者群組。
async 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 \(英文\)。
async 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 \(英文\)。
async 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) -> AsyncIterable[IotHubQuotaMetricInfo]參數
- cls
- callable
將傳遞直接回應的自訂類型或函式
傳回
IotHubQuotaMetricInfo 實例或 cls (回應結果的反覆運算器)
傳回類型
例外狀況
get_stats
從 IoT 中樞取得統計資料。
從 IoT 中樞取得統計資料。
async 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) -> AsyncIterable[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 \(英文\)。
async 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'。 預設值為 [無]。
- cls
- callable
將傳遞直接回應的自訂類型或函式
傳回
JobResponse 或 cls 的結果 (回應)
傳回類型
例外狀況
list_by_resource_group
取得資源群組中的所有 IoT 中樞。
取得資源群組中的所有 IoT 中樞。
list_by_resource_group(resource_group_name: str, **kwargs: Any) -> AsyncIterable[IotHubDescription]參數
- cls
- callable
將傳遞直接回應的自訂類型或函式
傳回
IotHubDescription 實例或 cls (回應結果等反覆運算器)
傳回類型
例外狀況
list_by_subscription
取得訂用帳戶中的所有 IoT 中樞。
取得訂用帳戶中的所有 IoT 中樞。
list_by_subscription(**kwargs: Any) -> AsyncIterable[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) -> AsyncIterable[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) -> AsyncIterable[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) -> AsyncIterable[SharedAccessSignatureAuthorizationRule]參數
- cls
- callable
將傳遞直接回應的自訂類型或函式
傳回
像是 SharedAccessSignatureAuthorizationRule 實例的反覆運算器，或 cls (回應的結果)
傳回類型
例外狀況
屬性
models
models = <module 'azure.mgmt.iothub.v2018_01_22.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\mgmt\\iothub\\v2018_01_22\\models\\__init__.py'>