ResourceGroupsOperations Класс
Предупреждение
НЕ создавать экземпляр этого класса напрямую.
Вместо этого вы должны получить доступ к следующим операциям с помощью
атрибут<xref:resource_groups> .
- Наследование
-
builtins.objectResourceGroupsOperations
Конструктор
ResourceGroupsOperations(*args, **kwargs)
Методы
begin_delete |
Удаление группы ресурсов. |
check_existence |
Проверяет, существует ли группа ресурсов. |
create_or_update |
Создайте группу ресурсов. |
export_template |
Записывает указанную группу ресурсов в виде шаблона. |
get |
Возвращает группу ресурсов. |
list |
Получает коллекцию групп ресурсов. |
list_resources |
Получение всех ресурсов в подписке. |
patch |
Группы ресурсов можно обновлять посредством простой операции PATCH, выполненной по адресу группы. Формат этого запроса такой же, как у запроса на создание групп ресурсов, при этом, если в каком-либо поле не указано значение, текущее значение будет сохранено. |
begin_delete
Удаление группы ресурсов.
begin_delete(resource_group_name: 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)
Возвращаемый тип
Исключения
check_existence
Проверяет, существует ли группа ресурсов.
check_existence(resource_group_name: str, **kwargs: Any) -> bool
Параметры
- resource_group_name
- str
Имя проверяемой группы ресурсов. Регистр букв в имени не учитывается. Обязательный.
- cls
- callable
Пользовательский тип или функция, которым будет передан прямой ответ
Возвращаемое значение
bool или результат cls(response)
Возвращаемый тип
Исключения
create_or_update
Создайте группу ресурсов.
create_or_update(resource_group_name: str, parameters: _models.ResourceGroup, *, content_type: str = 'application/json', **kwargs: Any) -> _models.ResourceGroup
Параметры
- parameters
- ResourceGroup или IO
Параметры, которые передаются операции create или update службы группы ресурсов. Тип ResourceGroup или тип ввода-вывода. Обязательный элемент.
- content_type
- str
Тип содержимого параметра body. Известные значения: "application/json". Значение по умолчанию —Нет.
- cls
- callable
Пользовательский тип или функция, которым будет передан прямой ответ
Возвращаемое значение
ResourceGroup или результат cls(response)
Возвращаемый тип
Исключения
export_template
Записывает указанную группу ресурсов в виде шаблона.
export_template(resource_group_name: str, parameters: _models.ExportTemplateRequest, *, content_type: str = 'application/json', **kwargs: Any) -> _models.ResourceGroupExportResult
Параметры
- parameters
- ExportTemplateRequest или IO
Параметры, предоставленные для операции группы ресурсов шаблона экспорта. Тип ExportTemplateRequest или тип ввода-вывода. Обязательный элемент.
- content_type
- str
Тип содержимого параметра body. Известные значения: "application/json". Значение по умолчанию —Нет.
- cls
- callable
Пользовательский тип или функция, которым будет передан прямой ответ
Возвращаемое значение
ResourceGroupExportResult или результат cls(response)
Возвращаемый тип
Исключения
get
Возвращает группу ресурсов.
get(resource_group_name: str, **kwargs: Any) -> ResourceGroup
Параметры
- resource_group_name
- str
Имя получаемой группы ресурсов. Регистр букв в имени не учитывается. Обязательный.
- cls
- callable
Пользовательский тип или функция, которым будет передан прямой ответ
Возвращаемое значение
ResourceGroup или результат cls(response)
Возвращаемый тип
Исключения
list
Получает коллекцию групп ресурсов.
list(filter: str | None = None, top: int | None = None, **kwargs: Any) -> Iterable[ResourceGroup]
Параметры
- top
- int
Параметры запроса. Если передается значение NULL, возвращает все группы ресурсов. Значение по умолчанию —Нет.
- cls
- callable
Пользовательский тип или функция, которым будет передан прямой ответ
Возвращаемое значение
Итератор, например экземпляр ResourceGroup или результат cls(response)
Возвращаемый тип
Исключения
list_resources
Получение всех ресурсов в подписке.
list_resources(resource_group_name: str, filter: str | None = None, expand: str | None = None, top: int | None = None, **kwargs: Any) -> Iterable[GenericResourceExpanded]
Параметры
- resource_group_name
- str
Параметры запроса. Если передается значение NULL, возвращает все группы ресурсов. Обязательный элемент.
- expand
- str
Разделенный запятыми список дополнительных свойств, которые будут включены в ответ.
Допустимые значения: createdTime
, changedTime
и provisioningState
. Например, $expand=createdTime,changedTime
. Значение по умолчанию —Нет.
- top
- int
Параметры запроса. Если передается значение NULL, возвращает все группы ресурсов. Значение по умолчанию —Нет.
- cls
- callable
Пользовательский тип или функция, которым будет передан прямой ответ
Возвращаемое значение
Итератор, например экземпляр GenericResourceExpanded или результат cls(response)
Возвращаемый тип
Исключения
patch
Группы ресурсов можно обновлять посредством простой операции PATCH, выполненной по адресу группы. Формат этого запроса такой же, как у запроса на создание групп ресурсов, при этом, если в каком-либо поле не указано значение, текущее значение будет сохранено.
patch(resource_group_name: str, parameters: _models.ResourceGroup, *, content_type: str = 'application/json', **kwargs: Any) -> _models.ResourceGroup
Параметры
- resource_group_name
- str
Имя создаваемой или обновляемой группы ресурсов. Регистр букв в имени не учитывается. Обязательный.
- parameters
- ResourceGroup или IO
Параметры, которые передаются операции update state службы группы ресурсов. Тип ResourceGroup или тип ввода-вывода. Обязательный.
- content_type
- str
Тип содержимого параметра body. Известные значения: "application/json". Значение по умолчанию —Нет.
- cls
- callable
Пользовательский тип или функция, которым будет передан прямой ответ
Возвращаемое значение
ResourceGroup или результат cls(response)
Возвращаемый тип
Исключения
Атрибуты
models
models = <module 'azure.mgmt.resource.resources.v2016_02_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\mgmt\\resource\\resources\\v2016_02_01\\models\\__init__.py'>
Azure SDK for Python