Поделиться через


IotHubResourceOperations Класс

Предупреждение

НЕ следует создавать экземпляр этого класса напрямую.

Вместо этого вы должны получить доступ к следующим операциям с помощью

IotHubClient's

атрибут<xref:iot_hub_resource> .

Наследование
builtins.object
IotHubResourceOperations

Конструктор

IotHubResourceOperations(*args, **kwargs)

Методы

begin_create_or_update

Создание или обновление метаданных Центра Интернета вещей.

Создание или обновление метаданных центра Интернета вещей. Обычно для изменения свойства используется получение метаданных Центра Интернета вещей и метаданных безопасности, а затем их объединение с измененными значениями в новом тексте для обновления Центра Интернета вещей. Если в JSON отсутствуют определенные свойства, обновление Центр Интернета вещей может привести к откату этих значений до значения по умолчанию, что может привести к непредвиденному поведению.

begin_delete

Удаление Центра Интернета вещей.

Удаление Центра Интернета вещей.

check_name_availability

Проверьте, доступно ли имя центра Интернета вещей.

Проверьте, доступно ли имя центра Интернета вещей.

create_event_hub_consumer_group

Добавьте группу потребителей в конечную точку, совместимую с концентратором событий, в Центре Интернета вещей.

Добавьте группу потребителей в конечную точку, совместимую с концентратором событий, в Центре Интернета вещей.

delete_event_hub_consumer_group

Удаление группы потребителей из конечной точки, совместимой с концентратором событий, в Центре Интернета вещей.

Удаление группы потребителей из конечной точки, совместимой с концентратором событий, в Центре Интернета вещей.

export_devices

Экспортирует все удостоверения устройств из реестра удостоверений Центра Интернета вещей в контейнер больших двоичных объектов службы хранилища Azure. Дополнительные сведения см. на странице https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.

Экспортирует все удостоверения устройств из реестра удостоверений Центра Интернета вещей в контейнер больших двоичных объектов службы хранилища Azure. Дополнительные сведения см. на странице https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.

get

Получение метаданных центра Интернета вещей, не связанных с безопасностью.

Получение метаданных центра Интернета вещей, не связанных с безопасностью.

get_event_hub_consumer_group

Получите группу потребителей из конечной точки, совместимой с устройством в облако, из Концентратора событий для Центра Интернета вещей.

Получите группу потребителей из конечной точки, совместимой с устройством в облако, из Концентратора событий для Центра Интернета вещей.

get_job

Получение сведений о задании из Центра Интернета вещей. Дополнительные сведения см. на странице https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.

Получение сведений о задании из Центра Интернета вещей. Дополнительные сведения см. на странице https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.

get_keys_for_key_name

Получение политики общего доступа по имени из Центра Интернета вещей. Дополнительные сведения см. на странице https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.

Получение политики общего доступа по имени из Центра Интернета вещей. Дополнительные сведения см. на странице https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.

get_quota_metrics

Получение метрик квоты для Центра Интернета вещей.

Получение метрик квоты для Центра Интернета вещей.

get_stats

Получение статистики из Центра Интернета вещей.

Получение статистики из Центра Интернета вещей.

get_valid_skus

Получение списка допустимых номеров SKU для Центра Интернета вещей.

Получение списка допустимых номеров SKU для Центра Интернета вещей.

import_devices

Импорт, обновление или удаление удостоверений устройств в реестре удостоверений Центра Интернета вещей из большого двоичного объекта. Дополнительные сведения см. на странице https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.

Импорт, обновление или удаление удостоверений устройств в реестре удостоверений Центра Интернета вещей из большого двоичного объекта. Дополнительные сведения см. на странице https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.

list_by_resource_group

Получение всех Центров Интернета вещей в группе ресурсов.

Получение всех Центров Интернета вещей в группе ресурсов.

list_by_subscription

Получение всех Центров Интернета вещей в подписке.

Получение всех Центров Интернета вещей в подписке.

list_event_hub_consumer_groups

Получите список групп потребителей в конечной точке, совместимой с устройством и облаком, в Центре Интернета вещей.

Получите список групп потребителей в конечной точке, совместимой с устройством и облаком, в Центре Интернета вещей.

list_jobs

Получение списка всех заданий в Центре Интернета вещей. Дополнительные сведения см. на странице https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.

Получение списка всех заданий в Центре Интернета вещей. Дополнительные сведения см. на странице https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.

list_keys

Получение метаданных безопасности для Центра Интернета вещей. Дополнительные сведения см. на странице https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.

Получение метаданных безопасности для Центра Интернета вещей. Дополнительные сведения см. на странице https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.

begin_create_or_update

Создание или обновление метаданных Центра Интернета вещей.

Создание или обновление метаданных центра Интернета вещей. Обычно для изменения свойства используется получение метаданных Центра Интернета вещей и метаданных безопасности, а затем их объединение с измененными значениями в новом тексте для обновления Центра Интернета вещей. Если в JSON отсутствуют определенные свойства, обновление Центр Интернета вещей может привести к откату этих значений до значения по умолчанию, что может привести к непредвиденному поведению.

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
Обязательно

Имя группы ресурсов, содержащей Центр Интернета вещей. Обязательный элемент.

resource_name
str
Обязательно

Имя Центра Интернета вещей. Обязательный.

iot_hub_description
IotHubDescription или IO
Обязательно

Метаданные Центра Интернета вещей и метаданные безопасности. Тип IotHubDescription или тип ввода-вывода. Обязательный.

if_match
str
Обязательно

ETag Центр Интернета вещей. Не указывайте для создания новой Центр Интернета вещей. Требуется для обновления существующего Центр Интернета вещей. Значение по умолчанию —Нет.

content_type
str

Тип содержимого параметра body. Известные значения: "application/json". Значение по умолчанию —Нет.

cls
callable

Пользовательский тип или функция, которым будет передан прямой ответ

continuation_token
str

Маркер продолжения для перезапуска опроса из сохраненного состояния.

polling
bool или PollingMethod

По умолчанию методом опроса будет ARMPolling. Передайте значение False для этой операции, чтобы не опрашивать, или передайте собственный инициализированный объект опроса для личной стратегии опроса.

polling_interval
int

Время ожидания по умолчанию между двумя опросами для операций LRO, если нет Retry-After заголовка.

Возвращаемое значение

Экземпляр LROPoller, который возвращает IotHubDescription или результат cls(response)

Возвращаемый тип

Исключения

begin_delete

Удаление Центра Интернета вещей.

Удаление Центра Интернета вещей.

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

Параметры

resource_group_name
str
Обязательно

Имя группы ресурсов, содержащей Центр Интернета вещей. Обязательный.

resource_name
str
Обязательно

Имя Центра Интернета вещей. Обязательный.

cls
callable

Пользовательский тип или функция, которым будет передан прямой ответ

continuation_token
str

Маркер продолжения для перезапуска опроса из сохраненного состояния.

polling
bool или PollingMethod

По умолчанию методом опроса будет ARMPolling. Передайте значение False для этой операции, чтобы не опрашивать, или передайте собственный инициализированный объект опроса для личной стратегии опроса.

polling_interval
int

Время ожидания по умолчанию между двумя опросами для операций LRO, если нет Retry-After заголовка.

Возвращаемое значение

Экземпляр LROPoller, возвращающий IotHubDescription или Экземпляр LROPoller, который возвращает errorDetails или результат cls(response)

Возвращаемый тип

Исключения

check_name_availability

Проверьте, доступно ли имя центра Интернета вещей.

Проверьте, доступно ли имя центра Интернета вещей.

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

Параметры

operation_inputs
OperationInputs или IO
Обязательно

Задайте для параметра name в структуре OperationInputs имя Центра Интернета вещей, чтобы проверка. Тип OperationInputs или тип ввода-вывода. Обязательный.

content_type
str

Тип содержимого параметра body. Известные значения: "application/json". Значение по умолчанию —Нет.

cls
callable

Пользовательский тип или функция, которым будет передан прямой ответ

Возвращаемое значение

IotHubNameAvailabilityInfo или результат cls(response)

Возвращаемый тип

Исключения

create_event_hub_consumer_group

Добавьте группу потребителей в конечную точку, совместимую с концентратором событий, в Центре Интернета вещей.

Добавьте группу потребителей в конечную точку, совместимую с концентратором событий, в Центре Интернета вещей.

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
Обязательно

Имя группы ресурсов, содержащей Центр Интернета вещей. Обязательный.

resource_name
str
Обязательно

Имя Центра Интернета вещей. Обязательный.

event_hub_endpoint_name
str
Обязательно

Имя конечной точки, совместимой с концентратором событий, в Центре Интернета вещей. Обязательный.

name
str
Обязательно

Имя добавляемой группы потребителей. Обязательный.

cls
callable

Пользовательский тип или функция, которым будет передан прямой ответ

Возвращаемое значение

EventHubConsumerGroupInfo или результат cls(response)

Возвращаемый тип

Исключения

delete_event_hub_consumer_group

Удаление группы потребителей из конечной точки, совместимой с концентратором событий, в Центре Интернета вещей.

Удаление группы потребителей из конечной точки, совместимой с концентратором событий, в Центре Интернета вещей.

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
Обязательно

Имя группы ресурсов, содержащей Центр Интернета вещей. Обязательный.

resource_name
str
Обязательно

Имя Центра Интернета вещей. Обязательный.

event_hub_endpoint_name
str
Обязательно

Имя конечной точки, совместимой с концентратором событий, в Центре Интернета вещей. Обязательный.

name
str
Обязательно

Имя удаляемой группы потребителей. Обязательный.

cls
callable

Пользовательский тип или функция, которым будет передан прямой ответ

Возвращаемое значение

None или результат cls(response)

Возвращаемый тип

Исключения

export_devices

Экспортирует все удостоверения устройств из реестра удостоверений Центра Интернета вещей в контейнер больших двоичных объектов службы хранилища Azure. Дополнительные сведения см. на странице https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.

Экспортирует все удостоверения устройств из реестра удостоверений Центра Интернета вещей в контейнер больших двоичных объектов службы хранилища Azure. Дополнительные сведения см. на странице 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
Обязательно

Имя группы ресурсов, содержащей Центр Интернета вещей. Обязательный.

resource_name
str
Обязательно

Имя Центра Интернета вещей. Обязательный.

export_devices_parameters
ExportDevicesRequest или IO
Обязательно

Параметры, определяющие операцию экспорта устройств. Тип ExportDevicesRequest или тип ввода-вывода. Обязательный.

content_type
str

Тип содержимого параметра body. Известные значения: "application/json". Значение по умолчанию —Нет.

cls
callable

Пользовательский тип или функция, которым будет передан прямой ответ

Возвращаемое значение

JobResponse или результат cls(response)

Возвращаемый тип

Исключения

get

Получение метаданных центра Интернета вещей, не связанных с безопасностью.

Получение метаданных центра Интернета вещей, не связанных с безопасностью.

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

Параметры

resource_group_name
str
Обязательно

Имя группы ресурсов, содержащей Центр Интернета вещей. Обязательный.

resource_name
str
Обязательно

Имя Центра Интернета вещей. Обязательный.

cls
callable

Пользовательский тип или функция, которые будут переданы в прямой ответ.

Возвращаемое значение

IotHubDescription или результат cls(response)

Возвращаемый тип

Исключения

get_event_hub_consumer_group

Получите группу потребителей из конечной точки, совместимой с устройством в облако, из Концентратора событий для Центра Интернета вещей.

Получите группу потребителей из конечной точки, совместимой с устройством в облако, из Концентратора событий для Центра Интернета вещей.

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
Обязательно

Имя группы ресурсов, содержащей Центр Интернета вещей. Обязательный элемент.

resource_name
str
Обязательно

Имя Центра Интернета вещей. Обязательный элемент.

event_hub_endpoint_name
str
Обязательно

Имя конечной точки, совместимой с Концентратором событий, в Центре Интернета вещей. Обязательный элемент.

name
str
Обязательно

Имя извлекаемой группы потребителей. Обязательный элемент.

cls
callable

Пользовательский тип или функция, которые будут переданы в прямой ответ.

Возвращаемое значение

EventHubConsumerGroupInfo или результат cls(response)

Возвращаемый тип

Исключения

get_job

Получение сведений о задании из Центра Интернета вещей. Дополнительные сведения см. на странице https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.

Получение сведений о задании из Центра Интернета вещей. Дополнительные сведения см. на странице 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
Обязательно

Имя группы ресурсов, содержащей Центр Интернета вещей. Обязательный элемент.

resource_name
str
Обязательно

Имя Центра Интернета вещей. Обязательный элемент.

job_id
str
Обязательно

Идентификатор задания. Обязательный элемент.

cls
callable

Пользовательский тип или функция, которые будут переданы в прямой ответ.

Возвращаемое значение

JobResponse или результат cls(response)

Возвращаемый тип

Исключения

get_keys_for_key_name

Получение политики общего доступа по имени из Центра Интернета вещей. Дополнительные сведения см. на странице https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.

Получение политики общего доступа по имени из Центра Интернета вещей. Дополнительные сведения см. на странице 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
Обязательно

Имя группы ресурсов, содержащей Центр Интернета вещей. Обязательный.

resource_name
str
Обязательно

Имя Центра Интернета вещей. Обязательный элемент.

key_name
str
Обязательно

Название политики общего доступа. Обязательный элемент.

cls
callable

Пользовательский тип или функция, которые будут переданы в прямой ответ.

Возвращаемое значение

SharedAccessSignatureAuthorizationRule или результат cls(response)

Возвращаемый тип

Исключения

get_quota_metrics

Получение метрик квоты для Центра Интернета вещей.

Получение метрик квоты для Центра Интернета вещей.

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

Параметры

resource_group_name
str
Обязательно

Имя группы ресурсов, содержащей Центр Интернета вещей. Обязательный элемент.

resource_name
str
Обязательно

Имя Центра Интернета вещей. Обязательный элемент.

cls
callable

Пользовательский тип или функция, которые будут переданы в прямой ответ.

Возвращаемое значение

Итератор, например экземпляр IotHubQuotaMetricInfo или результат cls(response)

Возвращаемый тип

Исключения

get_stats

Получение статистики из Центра Интернета вещей.

Получение статистики из Центра Интернета вещей.

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

Параметры

resource_group_name
str
Обязательно

Имя группы ресурсов, содержащей Центр Интернета вещей. Обязательный элемент.

resource_name
str
Обязательно

Имя Центра Интернета вещей. Обязательный элемент.

cls
callable

Пользовательский тип или функция, которые будут переданы в прямой ответ.

Возвращаемое значение

RegistryStatistics или результат cls(response)

Возвращаемый тип

Исключения

get_valid_skus

Получение списка допустимых номеров SKU для Центра Интернета вещей.

Получение списка допустимых номеров SKU для Центра Интернета вещей.

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

Параметры

resource_group_name
str
Обязательно

Имя группы ресурсов, содержащей Центр Интернета вещей. Обязательный элемент.

resource_name
str
Обязательно

Имя Центра Интернета вещей. Обязательный элемент.

cls
callable

Пользовательский тип или функция, которые будут переданы в прямой ответ.

Возвращаемое значение

Итератор, например экземпляр IotHubSkuDescription или результат cls(response)

Возвращаемый тип

Исключения

import_devices

Импорт, обновление или удаление удостоверений устройств в реестре удостоверений Центра Интернета вещей из большого двоичного объекта. Дополнительные сведения см. на странице https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.

Импорт, обновление или удаление удостоверений устройств в реестре удостоверений Центра Интернета вещей из большого двоичного объекта. Дополнительные сведения см. на странице 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
Обязательно

Имя группы ресурсов, содержащей Центр Интернета вещей. Обязательный элемент.

resource_name
str
Обязательно

Имя Центра Интернета вещей. Обязательный элемент.

import_devices_parameters
ImportDevicesRequest или IO
Обязательно

Параметры, определяющие операцию импорта устройств. Тип ImportDevicesRequest или тип ввода-вывода. Обязательный элемент.

content_type
str

Тип содержимого параметра тела. Известные значения: "application/json". Значение по умолчанию —Нет.

cls
callable

Пользовательский тип или функция, которые будут переданы в прямой ответ.

Возвращаемое значение

JobResponse или результат cls(response)

Возвращаемый тип

Исключения

list_by_resource_group

Получение всех Центров Интернета вещей в группе ресурсов.

Получение всех Центров Интернета вещей в группе ресурсов.

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

Параметры

resource_group_name
str
Обязательно

Имя группы ресурсов, содержащей Центр Интернета вещей. Обязательный элемент.

cls
callable

Пользовательский тип или функция, которые будут переданы в прямой ответ.

Возвращаемое значение

Итератор, например экземпляр IotHubDescription или результат cls(response)

Возвращаемый тип

Исключения

list_by_subscription

Получение всех Центров Интернета вещей в подписке.

Получение всех Центров Интернета вещей в подписке.

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

Параметры

cls
callable

Пользовательский тип или функция, которые будут переданы в прямой ответ.

Возвращаемое значение

Итератор, например экземпляр IotHubDescription или результат cls(response)

Возвращаемый тип

Исключения

list_event_hub_consumer_groups

Получите список групп потребителей в конечной точке, совместимой с устройством и облаком, в Центре Интернета вещей.

Получите список групп потребителей в конечной точке, совместимой с устройством и облаком, в Центре Интернета вещей.

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
Обязательно

Имя группы ресурсов, содержащей Центр Интернета вещей. Обязательный элемент.

resource_name
str
Обязательно

Имя Центра Интернета вещей. Обязательный элемент.

event_hub_endpoint_name
str
Обязательно

Имя конечной точки, совместимой с концентратором событий. Обязательный элемент.

cls
callable

Пользовательский тип или функция, которые будут переданы в прямой ответ.

Возвращаемое значение

Итератор, например экземпляр str или результат cls(response)

Возвращаемый тип

Исключения

list_jobs

Получение списка всех заданий в Центре Интернета вещей. Дополнительные сведения см. на странице https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.

Получение списка всех заданий в Центре Интернета вещей. Дополнительные сведения см. на странице 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
Обязательно

Имя группы ресурсов, содержащей Центр Интернета вещей. Обязательный.

resource_name
str
Обязательно

Имя Центра Интернета вещей. Обязательный.

cls
callable

Пользовательский тип или функция, которые будут переданы в прямой ответ.

Возвращаемое значение

Итератор, например экземпляр JobResponse или результат cls(response)

Возвращаемый тип

Исключения

list_keys

Получение метаданных безопасности для Центра Интернета вещей. Дополнительные сведения см. на странице https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.

Получение метаданных безопасности для Центра Интернета вещей. Дополнительные сведения см. на странице 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
Обязательно

Имя группы ресурсов, содержащей Центр Интернета вещей. Обязательный элемент.

resource_name
str
Обязательно

Имя Центра Интернета вещей. Обязательный.

cls
callable

Пользовательский тип или функция, которые будут переданы в прямой ответ.

Возвращаемое значение

Итератор, например экземпляр SharedAccessSignatureAuthorizationRule или результат cls(response)

Возвращаемый тип

Исключения

Атрибуты

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'>