ResourcesOperations Класс
Предупреждение
НЕ следует создавать экземпляр этого класса напрямую.
Вместо этого вы должны получить доступ к следующим операциям с помощью
атрибут<xref:resources> .
- Наследование
-
builtins.objectResourcesOperations
Конструктор
ResourcesOperations(*args, **kwargs)
Методы
begin_create_or_update |
Создает ресурс. |
begin_create_or_update_by_id |
Создайте ресурс по идентификатору. |
begin_delete |
Удаляет ресурс. |
begin_delete_by_id |
Удаляет ресурс по идентификатору. |
begin_move_resources |
Перемещает ресурсы из одной группы ресурсов в другую. Перемещаемые ресурсы должны находиться в одной исходной группе ресурсов. Целевая группа ресурсов может находиться в другой подписке. При перемещении ресурсов исходная и целевая группы блокируются на время операции. Операции записи и удаления для групп блокируются до завершения перемещения. |
begin_update |
Обновление ресурса. |
begin_update_by_id |
Обновления ресурса по идентификатору. |
begin_validate_move_resources |
Проверяет, можно ли перемещать ресурсы из одной группы ресурсов в другую. Эта операция проверяет, можно ли переместить указанные ресурсы в целевой объект. Перемещаемые ресурсы должны находиться в одной исходной группе ресурсов. Целевая группа ресурсов может находиться в другой подписке. Если проверка выполнена успешно, возвращается код HTTP-ответа 204 (без содержимого). В случае сбоя проверки возвращается код HTTP-ответа 409 (конфликт) с сообщением об ошибке. Получите URL-адрес в значении заголовка Location, чтобы проверка результат длительной операции. |
check_existence |
Проверяет, существует ли ресурс. |
check_existence_by_id |
Проверяет по идентификатору, существует ли ресурс. |
get |
Получение ресурса. |
get_by_id |
Возвращает ресурс по идентификатору. |
list |
Получение всех ресурсов в подписке. |
list_by_resource_group |
Получение всех ресурсов для группы ресурсов. |
begin_create_or_update
Создает ресурс.
begin_create_or_update(resource_group_name: str, resource_provider_namespace: str, parent_resource_path: str, resource_type: str, resource_name: str, api_version: str, parameters: _models.GenericResource, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.GenericResource]
Параметры
- resource_group_name
- str
Имя группы ресурсов для ресурса. Регистр букв в имени не учитывается. Обязательный.
- parameters
- GenericResource или IO
Параметры для создания или обновления ресурса. Тип GenericResource или тип ввода-вывода. Обязательный элемент.
- content_type
- str
Тип содержимого параметра body. Известные значения: "application/json". Значение по умолчанию —Нет.
- cls
- callable
Пользовательский тип или функция, которым будет передан прямой ответ
- continuation_token
- str
Маркер продолжения для перезапуска опроса из сохраненного состояния.
- polling
- bool или PollingMethod
По умолчанию методом опроса будет ARMPolling. Передайте значение False для этой операции, чтобы не опрашивать, или передайте собственный инициализированный объект опроса для личной стратегии опроса.
- polling_interval
- int
Время ожидания по умолчанию между двумя опросами для операций LRO, если нет Retry-After заголовка.
Возвращаемое значение
Экземпляр LROPoller, который возвращает genericResource или результат cls(response)
Возвращаемый тип
Исключения
begin_create_or_update_by_id
Создайте ресурс по идентификатору.
begin_create_or_update_by_id(resource_id: str, api_version: str, parameters: _models.GenericResource, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.GenericResource]
Параметры
- resource_id
- str
Полный идентификатор ресурса содержит имя и тип ресурса. Используйте формат /subscriptions/{guid}/resourceGroups/{имя_группы_ресурсов}/{пространство_имен_поставщика_ресурсов}/{тип_ресурса}/{имя_ресурса}. Обязательный.
- parameters
- GenericResource или IO
Создание или обновление параметров ресурса. Тип GenericResource или тип ввода-вывода. Обязательный.
- content_type
- str
Тип содержимого параметра body. Известные значения: "application/json". Значение по умолчанию —Нет.
- cls
- callable
Пользовательский тип или функция, которым будет передан прямой ответ
- continuation_token
- str
Маркер продолжения для перезапуска опроса из сохраненного состояния.
- polling
- bool или PollingMethod
По умолчанию методом опроса будет ARMPolling. Передайте значение False для этой операции, чтобы не опрашивать, или передайте собственный инициализированный объект опроса для личной стратегии опроса.
- polling_interval
- int
Время ожидания по умолчанию между двумя опросами для операций LRO, если нет Retry-After заголовка.
Возвращаемое значение
Экземпляр LROPoller, который возвращает genericResource или результат cls(response)
Возвращаемый тип
Исключения
begin_delete
Удаляет ресурс.
begin_delete(resource_group_name: str, resource_provider_namespace: str, parent_resource_path: str, resource_type: str, resource_name: str, api_version: str, **kwargs: Any) -> LROPoller[None]
Параметры
- resource_group_name
- str
Имя группы ресурсов, содержащей удаляемые ресурсы. Регистр букв в имени не учитывается. Обязательный.
- cls
- callable
Пользовательский тип или функция, которым будет передан прямой ответ
- continuation_token
- str
Маркер продолжения для перезапуска опроса из сохраненного состояния.
- polling
- bool или PollingMethod
По умолчанию методом опроса будет ARMPolling. Передайте значение False для этой операции, чтобы не опрашивать, или передайте собственный инициализированный объект опроса для личной стратегии опроса.
- polling_interval
- int
Время ожидания по умолчанию между двумя опросами для операций LRO, если нет Retry-After заголовка.
Возвращаемое значение
Экземпляр LROPoller, возвращающий значение None или результат cls(response)
Возвращаемый тип
Исключения
begin_delete_by_id
Удаляет ресурс по идентификатору.
begin_delete_by_id(resource_id: str, api_version: str, **kwargs: Any) -> LROPoller[None]
Параметры
- resource_id
- str
Полный идентификатор ресурса содержит имя и тип ресурса. Используйте формат /subscriptions/{guid}/resourceGroups/{имя_группы_ресурсов}/{пространство_имен_поставщика_ресурсов}/{тип_ресурса}/{имя_ресурса}. Обязательный.
- cls
- callable
Пользовательский тип или функция, которым будет передан прямой ответ
- continuation_token
- str
Маркер продолжения для перезапуска опроса из сохраненного состояния.
- polling
- bool или PollingMethod
По умолчанию методом опроса будет ARMPolling. Передайте значение False для этой операции, чтобы не опрашивать, или передайте собственный инициализированный объект опроса для личной стратегии опроса.
- polling_interval
- int
Время ожидания по умолчанию между двумя опросами для операций LRO, если нет Retry-After заголовка.
Возвращаемое значение
Экземпляр LROPoller, возвращающий значение None или результат cls(response)
Возвращаемый тип
Исключения
begin_move_resources
Перемещает ресурсы из одной группы ресурсов в другую.
Перемещаемые ресурсы должны находиться в одной исходной группе ресурсов. Целевая группа ресурсов может находиться в другой подписке. При перемещении ресурсов исходная и целевая группы блокируются на время операции. Операции записи и удаления для групп блокируются до завершения перемещения.
begin_move_resources(source_resource_group_name: str, parameters: _models.ResourcesMoveInfo, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[None]
Параметры
- source_resource_group_name
- str
Имя группы ресурсов, содержащей ресурсы для перемещения. Обязательный.
- parameters
- ResourcesMoveInfo или IO
Параметры для перемещения ресурсов. Тип ResourcesMoveInfo или тип ввода-вывода. Обязательный.
- content_type
- str
Тип содержимого параметра body. Известные значения: "application/json". Значение по умолчанию —Нет.
- cls
- callable
Пользовательский тип или функция, которым будет передан прямой ответ
- continuation_token
- str
Маркер продолжения для перезапуска опроса из сохраненного состояния.
- polling
- bool или PollingMethod
По умолчанию методом опроса будет ARMPolling. Передайте значение False для этой операции, чтобы не опрашивать, или передайте собственный инициализированный объект опроса для личной стратегии опроса.
- polling_interval
- int
Время ожидания по умолчанию между двумя опросами для операций LRO, если нет Retry-After заголовка.
Возвращаемое значение
Экземпляр LROPoller, возвращающий значение None или результат cls(response)
Возвращаемый тип
Исключения
begin_update
Обновление ресурса.
begin_update(resource_group_name: str, resource_provider_namespace: str, parent_resource_path: str, resource_type: str, resource_name: str, api_version: str, parameters: _models.GenericResource, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.GenericResource]
Параметры
- resource_group_name
- str
Имя группы ресурсов для ресурса. Регистр букв в имени не учитывается. Обязательный.
- parameters
- GenericResource или IO
Параметры для обновления ресурса. Тип GenericResource или тип ввода-вывода. Обязательный.
- content_type
- str
Тип содержимого параметра тела. Известные значения: "application/json". Значение по умолчанию —Нет.
- cls
- callable
Пользовательский тип или функция, которые будут переданы в прямой ответ.
- continuation_token
- str
Маркер продолжения для перезапуска опроса из сохраненного состояния.
- polling
- bool или PollingMethod
По умолчанию методом опроса будет ARMPolling. Передайте значение False для этой операции, чтобы не выполнять опрос, или передайте собственный инициализированный объект опроса для личной стратегии опроса.
- polling_interval
- int
Время ожидания по умолчанию между двумя опросами для операций LRO, если заголовок Retry-After отсутствует.
Возвращаемое значение
Экземпляр LROPoller, возвращающий genericResource или результат cls(response)
Возвращаемый тип
Исключения
begin_update_by_id
Обновления ресурса по идентификатору.
begin_update_by_id(resource_id: str, api_version: str, parameters: _models.GenericResource, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.GenericResource]
Параметры
- resource_id
- str
Полный идентификатор ресурса содержит имя и тип ресурса. Используйте формат /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}. Обязательный элемент.
- parameters
- GenericResource или IO
Обновление параметров ресурса. Тип GenericResource или тип ввода-вывода. Обязательный.
- content_type
- str
Тип содержимого параметра тела. Известные значения: "application/json". Значение по умолчанию —Нет.
- cls
- callable
Пользовательский тип или функция, которые будут переданы в прямой ответ.
- continuation_token
- str
Маркер продолжения для перезапуска опроса из сохраненного состояния.
- polling
- bool или PollingMethod
По умолчанию методом опроса будет ARMPolling. Передайте значение False для этой операции, чтобы не выполнять опрос, или передайте собственный инициализированный объект опроса для личной стратегии опроса.
- polling_interval
- int
Время ожидания по умолчанию между двумя опросами для операций LRO, если заголовок Retry-After отсутствует.
Возвращаемое значение
Экземпляр LROPoller, возвращающий genericResource или результат cls(response)
Возвращаемый тип
Исключения
begin_validate_move_resources
Проверяет, можно ли перемещать ресурсы из одной группы ресурсов в другую.
Эта операция проверяет, можно ли переместить указанные ресурсы в целевой объект. Перемещаемые ресурсы должны находиться в одной исходной группе ресурсов. Целевая группа ресурсов может находиться в другой подписке. Если проверка выполнена успешно, возвращается код HTTP-ответа 204 (без содержимого). В случае сбоя проверки возвращается код HTTP-ответа 409 (конфликт) с сообщением об ошибке. Получите URL-адрес в значении заголовка Location, чтобы проверка результат длительной операции.
begin_validate_move_resources(source_resource_group_name: str, parameters: _models.ResourcesMoveInfo, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[None]
Параметры
- source_resource_group_name
- str
Имя группы ресурсов, содержащей ресурсы для проверки перемещения. Обязательный.
- parameters
- ResourcesMoveInfo или IO
Параметры для перемещения ресурсов. Тип ResourcesMoveInfo или тип ввода-вывода. Обязательный.
- content_type
- str
Тип содержимого параметра тела. Известные значения: "application/json". Значение по умолчанию —Нет.
- cls
- callable
Пользовательский тип или функция, которые будут переданы в прямой ответ.
- continuation_token
- str
Маркер продолжения для перезапуска опроса из сохраненного состояния.
- polling
- bool или PollingMethod
По умолчанию методом опроса будет ARMPolling. Передайте значение False для этой операции, чтобы не выполнять опрос, или передайте собственный инициализированный объект опроса для личной стратегии опроса.
- polling_interval
- int
Время ожидания по умолчанию между двумя опросами для операций LRO, если заголовок Retry-After отсутствует.
Возвращаемое значение
Экземпляр LROPoller, возвращающий значение None или результат cls(response)
Возвращаемый тип
Исключения
check_existence
Проверяет, существует ли ресурс.
check_existence(resource_group_name: str, resource_provider_namespace: str, parent_resource_path: str, resource_type: str, resource_name: str, api_version: str, **kwargs: Any) -> bool
Параметры
- resource_group_name
- str
Имя группы ресурсов, содержащей ресурс для проверка. Регистр букв в имени не учитывается. Обязательный.
- cls
- callable
Пользовательский тип или функция, которые будут переданы в прямой ответ.
Возвращаемое значение
bool или результат cls(response)
Возвращаемый тип
Исключения
check_existence_by_id
Проверяет по идентификатору, существует ли ресурс.
check_existence_by_id(resource_id: str, api_version: str, **kwargs: Any) -> bool
Параметры
- resource_id
- str
Полный идентификатор ресурса содержит имя и тип ресурса. Используйте формат /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}. Обязательный элемент.
- cls
- callable
Пользовательский тип или функция, которые будут переданы в прямой ответ.
Возвращаемое значение
bool или результат cls(response)
Возвращаемый тип
Исключения
get
Получение ресурса.
get(resource_group_name: str, resource_provider_namespace: str, parent_resource_path: str, resource_type: str, resource_name: str, api_version: str, **kwargs: Any) -> GenericResource
Параметры
- resource_group_name
- str
Имя группы ресурсов, содержащей ресурс для получения. Регистр букв в имени не учитывается. Обязательный.
- cls
- callable
Пользовательский тип или функция, которые будут переданы в прямой ответ.
Возвращаемое значение
GenericResource или результат cls(response)
Возвращаемый тип
Исключения
get_by_id
Возвращает ресурс по идентификатору.
get_by_id(resource_id: str, api_version: str, **kwargs: Any) -> GenericResource
Параметры
- resource_id
- str
Полный идентификатор ресурса содержит имя и тип ресурса. Используйте формат /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}. Обязательный элемент.
- cls
- callable
Пользовательский тип или функция, которые будут переданы в прямой ответ.
Возвращаемое значение
GenericResource или результат cls(response)
Возвращаемый тип
Исключения
list
Получение всех ресурсов в подписке.
list(filter: str | None = None, expand: str | None = None, top: int | None = None, **kwargs: Any) -> Iterable[GenericResourceExpanded]
Параметры
- filter
- str
Фильтр, применяемый к операции.:code:<br>
Свойства, которые можно использовать для eq (equals) или ne (not equals): location, resourceType, name, resourceGroup, identity, identity/principalId, plan, plan/publisher, plan/product, plan/name, plan/version, and plan/promotionCode.:code:<br>``<br>
Example, to filter by a resource type, use: $filter=resourceType eq 'Microsoft.Network/virtualNetworks':code:<br>``<br>
You can use substringof(value, property) в фильтре. Свойства, которые можно использовать для подстроки: name и resourceGroup.:code:<br>``<br>
Например, чтобы получить все ресурсы с "demo" в любом месте в имени, используйте: $filter=substringof('demo', name:code:<br>``<br>
Вы можете связать несколько подстрок вместе, добавив и/или операторы.:code:<br>``<br>
Вы можете фильтровать по именам тегов и значениям. Например, чтобы отфильтровать имя и значение тега, используйте $filter=tagName eq 'tag1' и tagValue eq 'Value1':code:<br>
:code:>><<<br>
Вы можете использовать некоторые свойства вместе при фильтрации. Вы можете использовать следующие сочетания: substringof и (или) resourceType, plan и plan/publisher и plan/name, identity и identity/principalId. Значение по умолчанию —Нет.
- expand
- str
Разделенный запятыми список дополнительных свойств, которые должны быть включены в ответ.
Допустимые значения: createdTime
и provisioningState
changedTime
. Например, $expand=createdTime,changedTime
. Значение по умолчанию —Нет.
- top
- int
Количество возвращаемых результатов. Если передается значение NULL, возвращает все ресурсы. Значение по умолчанию —Нет.
- cls
- callable
Пользовательский тип или функция, которые будут переданы в прямой ответ.
Возвращаемое значение
Итератор, например экземпляр GenericResourceExpanded или результат cls(response)
Возвращаемый тип
Исключения
list_by_resource_group
Получение всех ресурсов для группы ресурсов.
list_by_resource_group(resource_group_name: str, filter: str | None = None, expand: str | None = None, top: int | None = None, **kwargs: Any) -> Iterable[GenericResourceExpanded]
Параметры
- filter
- str
Фильтр, применяемый к операции.:code:<br>
Свойства, которые можно использовать для eq (equals) или ne (not equals): location, resourceType, name, resourceGroup, identity, identity/principalId, plan, plan/publisher, plan/product, plan/name, plan/version, and plan/promotionCode.:code:<br>``<br>
Example, to filter by a resource type, use: $filter=resourceType eq 'Microsoft.Network/virtualNetworks':code:<br>``<br>
You can use substringof(value, property) в фильтре. Свойства, которые можно использовать для подстроки: name и resourceGroup.:code:<br>``<br>
Например, чтобы получить все ресурсы с "demo" в любом месте в имени, используйте: $filter=substringof('demo', name:code:<br>``<br>
Вы можете связать несколько подстрок вместе, добавив и/или операторы.:code:<br>``<br>
Вы можете фильтровать по именам тегов и значениям. Например, чтобы отфильтровать имя и значение тега, используйте $filter=tagName eq 'tag1' и tagValue eq 'Value1':code:<br>
:code:>><<<br>
Вы можете использовать некоторые свойства вместе при фильтрации. Вы можете использовать следующие сочетания: substringof и (или) resourceType, plan и plan/publisher и plan/name, identity и identity/principalId. Значение по умолчанию —Нет.
- expand
- str
Разделенный запятыми список дополнительных свойств, которые должны быть включены в ответ.
Допустимые значения: createdTime
и provisioningState
changedTime
. Например, $expand=createdTime,changedTime
. Значение по умолчанию —Нет.
- top
- int
Количество возвращаемых результатов. Если передается значение NULL, возвращает все ресурсы. Значение по умолчанию —Нет.
- cls
- callable
Пользовательский тип или функция, которые будут переданы в прямой ответ.
Возвращаемое значение
Итератор, например экземпляр GenericResourceExpanded или результат cls(response)
Возвращаемый тип
Исключения
Атрибуты
models
models = <module 'azure.mgmt.resource.resources.v2018_05_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\mgmt\\resource\\resources\\v2018_05_01\\models\\__init__.py'>
Azure SDK for Python