ResourceGroupsOperations Класс

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

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

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

ResourceManagementClient's

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

Наследование

builtins.object

ResourceGroupsOperations

Конструктор

ResourceGroupsOperations(*args, **kwargs)

Методы

begin_delete	Удаляет группу ресурсов. При удалении группы ресурсов также удаляются все ее ресурсы. При удалении группы ресурсов удаляются все развертывания шаблонов и хранимые в настоящее время операции.
begin_export_template	Записывает указанную группу ресурсов в виде шаблона.
check_existence	Проверяет, существует ли группа ресурсов.
create_or_update	Создает или обновляет группу ресурсов.
get	Возвращает группу ресурсов.
list	Возвращает все группы ресурсов для подписки.
update	Обновления группу ресурсов. Группы ресурсов можно обновлять посредством простой операции PATCH, выполненной по адресу группы. Формат запроса такой же, как и для создания группы ресурсов. Если поле не указано, текущее значение сохраняется.

begin_delete

Удаляет группу ресурсов.

При удалении группы ресурсов также удаляются все ее ресурсы. При удалении группы ресурсов удаляются все развертывания шаблонов и хранимые в настоящее время операции.

begin_delete(resource_group_name: str, force_deletion_types: str | None = None, **kwargs: Any) -> LROPoller[None]

Параметры

resource_group_name

str

Обязательно

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

force_deletion_types

str

Обязательно

Типы ресурсов, которые требуется принудительно удалить. В настоящее время поддерживается только следующее: forceDeletionTypes=Microsoft.Compute/virtualMachines,Microsoft.Compute/virtualMachineScaleSets. Значение по умолчанию —Нет.

cls

callable

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

continuation_token

str

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

polling

bool или PollingMethod

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

polling_interval

int

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

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

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

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

LROPoller[None]

Исключения

HttpResponseError

begin_export_template

Записывает указанную группу ресурсов в виде шаблона.

begin_export_template(resource_group_name: str, parameters: _models.ExportTemplateRequest, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.ResourceGroupExportResult]

Параметры

resource_group_name

str

Обязательно

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

parameters

ExportTemplateRequest или IO

Обязательно

Параметры для экспорта шаблона. Тип ExportTemplateRequest или тип ввода-вывода. Обязательный.

content_type

str

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

cls

callable

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

continuation_token

str

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

polling

bool или PollingMethod

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

polling_interval

int

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

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

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

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

LROPoller[ResourceGroupExportResult]

Исключения

HttpResponseError

check_existence

Проверяет, существует ли группа ресурсов.

check_existence(resource_group_name: str, **kwargs: Any) -> bool

Параметры

resource_group_name

str

Обязательно

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

cls

callable

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

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

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

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

bool

Исключения

HttpResponseError

create_or_update

Создает или обновляет группу ресурсов.

create_or_update(resource_group_name: str, parameters: _models.ResourceGroup, *, content_type: str = 'application/json', **kwargs: Any) -> _models.ResourceGroup

Параметры

resource_group_name

str

Обязательно

Имя создаваемой или обновляемой группы ресурсов. Может включать буквы, цифры, символы подчеркивания, круглые скобки, дефис, точку (за исключением конца) и символы Юникода, соответствующие допустимым символам. Обязательный.

parameters

ResourceGroup или IO

Обязательно

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

content_type

str

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

cls

callable

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

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

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

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

ResourceGroup

Исключения

HttpResponseError

get

Возвращает группу ресурсов.

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

Параметры

resource_group_name

str

Обязательно

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

cls

callable

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

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

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

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

ResourceGroup

Исключения

HttpResponseError

list

Возвращает все группы ресурсов для подписки.

list(filter: str | None = None, top: int | None = None, **kwargs: Any) -> Iterable[ResourceGroup]

Параметры

filter

str

Обязательно

Фильтр, применяемый к операции.:code:
:code:>><<<br>можно фильтровать по именам и значениям тегов. Например, чтобы отфильтровать имя и значение тега, используйте $filter=tagName eq 'tag1' и tagValue eq 'Value1'. Значение по умолчанию —Нет.

top

int

Обязательно

Количество возвращаемых результатов. Если передается значение NULL, возвращает все группы ресурсов. Значение по умолчанию —Нет.

cls

callable

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

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

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

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

ItemPaged[ResourceGroup]

Исключения

HttpResponseError

update

Обновления группу ресурсов.

Группы ресурсов можно обновлять посредством простой операции PATCH, выполненной по адресу группы. Формат запроса такой же, как и для создания группы ресурсов. Если поле не указано, текущее значение сохраняется.

update(resource_group_name: str, parameters: _models.ResourceGroupPatchable, *, content_type: str = 'application/json', **kwargs: Any) -> _models.ResourceGroup

Параметры

resource_group_name

str

Обязательно

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

parameters

ResourceGroupPatchable или IO

Обязательно

Параметры, предоставляемые для обновления группы ресурсов. Тип ResourceGroupPatchable или тип ввода-вывода. Обязательный.

content_type

str

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

cls

callable

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

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

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

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

ResourceGroup

Исключения

HttpResponseError

Атрибуты

models

models = <module 'azure.mgmt.resource.resources.v2021_01_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\mgmt\\resource\\resources\\v2021_01_01\\models\\__init__.py'>