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

ResourcesOperations Класс

  • Ссылка

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

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

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

ResourceManagementClient's

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

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

Конструктор

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

Проверяет по идентификатору, существует ли ресурс. В настоящее время этот API работает только для ограниченного набора поставщиков ресурсов. Если поставщик ресурсов не реализует этот API, ARM ответит 405. Вместо этого можно использовать API GET для проверка существования ресурса.
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
Обязательно

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

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

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

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

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

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

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

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

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

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

Версия API, используемая для операции. Обязательный.

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)

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

LROPoller[GenericResource]

Исключения

HttpResponseError

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/{имя_группы_ресурсов}/{пространство_имен_поставщика_ресурсов}/{тип_ресурса}/{имя_ресурса}. Обязательный.

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

Версия API, используемая для операции. Обязательный.

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)

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

LROPoller[GenericResource]

Исключения

HttpResponseError

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

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

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

Пространство имен поставщика ресурсов. Обязательный.

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

Удостоверение родительского ресурса. Обязательный.

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

Тип ресурса. Обязательный.

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

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

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

Версия API, используемая для операции. Обязательный.

cls
callable

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

continuation_token
str

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

polling
bool или PollingMethod

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

polling_interval
int

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

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

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

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

LROPoller[None]

Исключения

HttpResponseError

begin_delete_by_id

Удаляет ресурс по идентификатору.

begin_delete_by_id(resource_id: str, api_version: str, **kwargs: Any) -> LROPoller[None]

Параметры

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

Полный идентификатор ресурса содержит имя и тип ресурса. Используйте формат /subscriptions/{guid}/resourceGroups/{имя_группы_ресурсов}/{пространство_имен_поставщика_ресурсов}/{тип_ресурса}/{имя_ресурса}. Обязательный.

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

Версия API, используемая для операции. Обязательный.

cls
callable

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

continuation_token
str

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

polling
bool или PollingMethod

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

polling_interval
int

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

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

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

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

LROPoller[None]

Исключения

HttpResponseError

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)

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

LROPoller[None]

Исключения

HttpResponseError

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

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

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

Пространство имен поставщика ресурсов. Обязательный.

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

Удостоверение родительского ресурса. Обязательный.

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

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

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

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

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

Версия API, используемая для операции. Обязательный.

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)

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

LROPoller[GenericResource]

Исключения

HttpResponseError

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}. Обязательный.

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

Версия API, используемая для операции. Обязательный.

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)

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

LROPoller[GenericResource]

Исключения

HttpResponseError

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)

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

LROPoller[None]

Исключения

HttpResponseError

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

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

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

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

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

Удостоверение родительского ресурса. Обязательный.

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

Тип ресурса. Обязательный.

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

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

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

Версия API, используемая для операции. Обязательный.

cls
callable

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

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

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

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

bool

Исключения

HttpResponseError

check_existence_by_id

Проверяет по идентификатору, существует ли ресурс. В настоящее время этот API работает только для ограниченного набора поставщиков ресурсов. Если поставщик ресурсов не реализует этот API, ARM ответит 405. Вместо этого можно использовать API GET для проверка существования ресурса.

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}. Обязательный элемент.

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

Версия API, используемая для операции. Обязательный.

cls
callable

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

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

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

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

bool

Исключения

HttpResponseError

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

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

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

Пространство имен поставщика ресурсов. Обязательный.

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

Удостоверение родительского ресурса. Обязательный.

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

Тип ресурса. Обязательный.

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

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

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

Версия API, используемая для операции. Обязательный.

cls
callable

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

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

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

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

GenericResource

Исключения

HttpResponseError

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}. Обязательный элемент.

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

Версия API, используемая для операции. Обязательный.

cls
callable

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

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

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

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

GenericResource

Исключения

HttpResponseError

list

Получение всех ресурсов в подписке.

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

Параметры

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

Фильтр, применяемый к операции.:code:
<br>Операторы сравнения фильтров включают eq (равно) и (не равно) и ne могут использоваться со следующими свойствами: location, resourceType, name, resourceGroup, identityidentity/principalId, plan, plan/publisher, plan/product, , plan/nameplan/versionи plan/promotionCode.:code:
<br>Например, для фильтрации по типу ресурса используйте $filter=resourceType eq 'Microsoft.Network/virtualNetworks'```<br>
<br>` `substringof(value, property)` can be used to filter for substrings of the following currently-supported properties: `name` and `resourceGroup
<br>`For example, to get all resources with 'demo' anywhere in the resource name, use $filter=substringof('demo', name)'''
<br>`Multiple substring operations can also be combined using и/`or` operators.:code:*<br>*`<br>`Note that any truncated number of results queried via $top may also not be compatible when using a filter.:code:*<br>*`<br>
Resources can be filtered by tag names and values. For example, to filter for a tag name and value, use ``$filter=tagName eq 'tag1' and tagValue eq 'Value1'``. Note that when resources are filtered by tag name and value, Исходные теги для каждого ресурса не будут возвращены в результатах.Any list of additional properties queried via $expandmay also not be compatible when filtering by tag names/values.
<br>`For tag names only, resources can be filtered by prefix using the following syntax: $filter=startswith(tagName, 'depart'). This query will return all resources with a tag name prefixed by the phrase `depart` (i.e.`department`, `departureDate`, `departureTime`, etc.):code:*<br>*`<br>
Note that some properties can be combined when filtering resources, which include the following: ``substringof() and/or resourceType``, plan и plan/publisher и plan/name, and identity and identity/principalId'. Значение по умолчанию —Нет.

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

Разделенный запятыми список дополнительных свойств, которые должны быть включены в ответ. Допустимые значения: createdTimeи provisioningStatechangedTime . Например, $expand=createdTime,changedTime. Значение по умолчанию —Нет.

top
int
Обязательно

Количество рекомендаций на странице, если используется страничные версии этого API. Значение по умолчанию —Нет.

cls
callable

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

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

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

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

ItemPaged[GenericResourceExpanded]

Исключения

HttpResponseError

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]

Параметры

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

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

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и provisioningStatechangedTime . Например, $expand=createdTime,changedTime. Значение по умолчанию —Нет.

top
int
Обязательно

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

cls
callable

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

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

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

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

ItemPaged[GenericResourceExpanded]

Исключения

HttpResponseError

Атрибуты

models 

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