ResourcesOperations Clase

Advertencia

NO cree instancias de esta clase directamente.

En su lugar, debe acceder a las siguientes operaciones a través de

ResourceManagementClient's

Atributo<xref:resources> .

Herencia
builtins.object
ResourcesOperations

Constructor

ResourcesOperations(*args, **kwargs)

Métodos

begin_create_or_update

Crea un recurso.

begin_create_or_update_by_id

Cree un recurso por identificador.

begin_delete

Elimina un recurso.

begin_delete_by_id

Elimina un recurso por identificador.

begin_move_resources

Mueve recursos de un grupo de recursos a otro.

Los recursos que se van a mover deben estar en el mismo grupo de recursos de origen en la suscripción de origen que se va a usar. El grupo de recursos de destino puede estar en otra suscripción. Al mover recursos, tanto el grupo de origen como el grupo de destino se bloquean durante la operación. Las operaciones de escritura y eliminación están bloqueadas en los grupos hasta que se completa el movimiento.

begin_update

Actualiza un recurso.

begin_update_by_id

Novedades un recurso por identificador.

begin_validate_move_resources

Valida si los recursos se pueden mover de un grupo de recursos a otro.

Esta operación comprueba si los recursos especificados se pueden mover al destino. Los recursos que se van a mover deben estar en el mismo grupo de recursos de origen en la suscripción de origen que se va a usar. El grupo de recursos de destino puede estar en otra suscripción. Si la validación se realiza correctamente, devuelve el código de respuesta HTTP 204 (sin contenido). Si se produce un error en la validación, devuelve el código de respuesta HTTP 409 (conflicto) con un mensaje de error. Recupere la dirección URL en el valor del encabezado Location para comprobar el resultado de la operación de larga duración.

check_existence

Comprueba si existe un recurso.

check_existence_by_id

Comprueba por identificador si existe un recurso. Actualmente, esta API solo funciona para un conjunto limitado de proveedores de recursos. En caso de que un proveedor de recursos no implemente esta API, ARM responderá con un 405. La alternativa es usar la API GET para comprobar la existencia del recurso.

get

Obtiene un recurso.

get_by_id

Obtiene un recurso por identificador.

list

Obtenga todos los recursos de una suscripción.

list_by_resource_group

Obtenga todos los recursos de un grupo de recursos.

begin_create_or_update

Crea un recurso.

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]

Parámetros

resource_group_name
str
Requerido

Nombre del grupo de recursos del recurso. El nombre distingue mayúsculas de minúsculas. Necesario.

resource_provider_namespace
str
Requerido

Espacio de nombres del proveedor de recursos. Necesario.

parent_resource_path
str
Requerido

La identidad del recurso primario. Necesario.

resource_type
str
Requerido

Tipo de recurso del recurso que se va a crear. Necesario.

resource_name
str
Requerido

es el nombre del recurso que se va a crear. Necesario.

api_version
str
Requerido

Versión de la API que se va a usar para la operación. Necesario.

parameters
GenericResource o IO
Requerido

Parámetros para crear o actualizar el recurso. Es un tipo GenericResource o un tipo de E/S. Necesario.

content_type
str

Body Parameter content-type. Los valores conocidos son: "application/json". El valor predeterminado es Ninguno.

cls
callable

Un tipo o función personalizados que se pasarán a la respuesta directa.

continuation_token
str

Token de continuación para reiniciar un sondeo desde un estado guardado.

polling
bool o PollingMethod

De forma predeterminada, el método de sondeo será ARMPolling. Pase False para que esta operación no sondee o pase su propio objeto de sondeo inicializado para una estrategia de sondeo personal.

polling_interval
int

Tiempo de espera predeterminado entre dos sondeos para las operaciones LRO si no hay ningún encabezado Retry-After presente.

Devoluciones

Instancia de LROPoller que devuelve GenericResource o el resultado de cls(response)

Tipo de valor devuelto

Excepciones

begin_create_or_update_by_id

Cree un recurso por identificador.

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]

Parámetros

resource_id
str
Requerido

Identificador completo del recurso, incluido el nombre del recurso y el tipo de recurso. Use el formato /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}. Necesario.

api_version
str
Requerido

Versión de la API que se va a usar para la operación. Necesario.

parameters
GenericResource o IO
Requerido

Crea o actualiza los parámetros de recursos. Es un tipo GenericResource o un tipo de E/S. Necesario.

content_type
str

Body Parameter content-type. Los valores conocidos son: "application/json". El valor predeterminado es Ninguno.

cls
callable

Un tipo o función personalizados que se pasarán a la respuesta directa.

continuation_token
str

Token de continuación para reiniciar un sondeo desde un estado guardado.

polling
bool o PollingMethod

De forma predeterminada, el método de sondeo será ARMPolling. Pase False para que esta operación no sondee o pase su propio objeto de sondeo inicializado para una estrategia de sondeo personal.

polling_interval
int

Tiempo de espera predeterminado entre dos sondeos para las operaciones LRO si no hay ningún encabezado Retry-After presente.

Devoluciones

Instancia de LROPoller que devuelve GenericResource o el resultado de cls(response)

Tipo de valor devuelto

Excepciones

begin_delete

Elimina un recurso.

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]

Parámetros

resource_group_name
str
Requerido

Nombre del grupo de recursos que contiene el recurso que se va a eliminar. El nombre distingue mayúsculas de minúsculas. Necesario.

resource_provider_namespace
str
Requerido

Espacio de nombres del proveedor de recursos. Necesario.

parent_resource_path
str
Requerido

La identidad del recurso primario. Necesario.

resource_type
str
Requerido

El tipo de recurso. Necesario.

resource_name
str
Requerido

Nombre del recurso que se va a eliminar. Necesario.

api_version
str
Requerido

Versión de la API que se va a usar para la operación. Necesario.

cls
callable

Un tipo o función personalizados que se pasarán a la respuesta directa.

continuation_token
str

Token de continuación para reiniciar un sondeo desde un estado guardado.

polling
bool o PollingMethod

De forma predeterminada, el método de sondeo será ARMPolling. Pase False para que esta operación no sondee o pase su propio objeto de sondeo inicializado para una estrategia de sondeo personal.

polling_interval
int

Tiempo de espera predeterminado entre dos sondeos para las operaciones LRO si no hay ningún encabezado Retry-After presente.

Devoluciones

Instancia de LROPoller que devuelve None o el resultado de cls(response)

Tipo de valor devuelto

Excepciones

begin_delete_by_id

Elimina un recurso por identificador.

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

Parámetros

resource_id
str
Requerido

Identificador completo del recurso, incluido el nombre del recurso y el tipo de recurso. Use el formato /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}. Necesario.

api_version
str
Requerido

Versión de la API que se va a usar para la operación. Necesario.

cls
callable

Un tipo o función personalizados que se pasarán a la respuesta directa.

continuation_token
str

Token de continuación para reiniciar un sondeo desde un estado guardado.

polling
bool o PollingMethod

De forma predeterminada, el método de sondeo será ARMPolling. Pase False para que esta operación no sondee o pase su propio objeto de sondeo inicializado para una estrategia de sondeo personal.

polling_interval
int

Tiempo de espera predeterminado entre dos sondeos para las operaciones LRO si no hay ningún encabezado Retry-After presente.

Devoluciones

Instancia de LROPoller que devuelve None o el resultado de cls(response)

Tipo de valor devuelto

Excepciones

begin_move_resources

Mueve recursos de un grupo de recursos a otro.

Los recursos que se van a mover deben estar en el mismo grupo de recursos de origen en la suscripción de origen que se va a usar. El grupo de recursos de destino puede estar en otra suscripción. Al mover recursos, tanto el grupo de origen como el grupo de destino se bloquean durante la operación. Las operaciones de escritura y eliminación están bloqueadas en los grupos hasta que se completa el movimiento.

begin_move_resources(source_resource_group_name: str, parameters: _models.ResourcesMoveInfo, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[None]

Parámetros

source_resource_group_name
str
Requerido

Nombre del grupo de recursos de la suscripción de origen que contiene los recursos que se van a mover. Necesario.

parameters
ResourcesMoveInfo o IO
Requerido

Parámetros para mover recursos. Es un tipo ResourcesMoveInfo o un tipo de E/S. Necesario.

content_type
str

Body Parameter content-type. Los valores conocidos son: "application/json". El valor predeterminado es Ninguno.

cls
callable

Un tipo o función personalizados que se pasarán a la respuesta directa.

continuation_token
str

Token de continuación para reiniciar un sondeo desde un estado guardado.

polling
bool o PollingMethod

De forma predeterminada, el método de sondeo será ARMPolling. Pase False para que esta operación no sondee o pase su propio objeto de sondeo inicializado para una estrategia de sondeo personal.

polling_interval
int

Tiempo de espera predeterminado entre dos sondeos para las operaciones LRO si no hay ningún encabezado Retry-After presente.

Devoluciones

Instancia de LROPoller que devuelve None o el resultado de cls(response)

Tipo de valor devuelto

Excepciones

begin_update

Actualiza un recurso.

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]

Parámetros

resource_group_name
str
Requerido

Nombre del grupo de recursos del recurso. El nombre distingue mayúsculas de minúsculas. Necesario.

resource_provider_namespace
str
Requerido

Espacio de nombres del proveedor de recursos. Necesario.

parent_resource_path
str
Requerido

La identidad del recurso primario. Necesario.

resource_type
str
Requerido

Tipo de recurso del recurso que se va a actualizar. Necesario.

resource_name
str
Requerido

Nombre del recurso que se va a actualizar. Necesario.

api_version
str
Requerido

La versión de API que se va a usar para la operación. Necesario.

parameters
GenericResource o IO
Requerido

Parámetros para actualizar el recurso. Es un tipo GenericResource o un tipo de E/S. Necesario.

content_type
str

Tipo de contenido del parámetro body. Los valores conocidos son: "application/json". El valor predeterminado es Ninguno.

cls
callable

Un tipo o función personalizados que se pasarán a la respuesta directa

continuation_token
str

Token de continuación para reiniciar un sondeo desde un estado guardado.

polling
bool o PollingMethod

De forma predeterminada, el método de sondeo será ARMPolling. Pase False para que esta operación no sondee o pase su propio objeto de sondeo inicializado para una estrategia de sondeo personal.

polling_interval
int

Tiempo de espera predeterminado entre dos sondeos para las operaciones LRO si no hay ningún encabezado Retry-After presente.

Devoluciones

Instancia de LROPoller que devuelve GenericResource o el resultado de cls(response)

Tipo de valor devuelto

Excepciones

begin_update_by_id

Novedades un recurso por identificador.

begin_update_by_id(resource_id: str, api_version: str, parameters: _models.GenericResource, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.GenericResource]

Parámetros

resource_id
str
Requerido

Identificador completo del recurso, incluido el nombre del recurso y el tipo de recurso. Use el formato /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}. Necesario.

api_version
str
Requerido

La versión de API que se va a usar para la operación. Necesario.

parameters
GenericResource o IO
Requerido

Actualice los parámetros de recursos. Es un tipo GenericResource o un tipo de E/S. Necesario.

content_type
str

Tipo de contenido del parámetro body. Los valores conocidos son: "application/json". El valor predeterminado es Ninguno.

cls
callable

Un tipo o función personalizados que se pasarán a la respuesta directa

continuation_token
str

Token de continuación para reiniciar un sondeo desde un estado guardado.

polling
bool o PollingMethod

De forma predeterminada, el método de sondeo será ARMPolling. Pase False para que esta operación no sondee o pase su propio objeto de sondeo inicializado para una estrategia de sondeo personal.

polling_interval
int

Tiempo de espera predeterminado entre dos sondeos para las operaciones LRO si no hay ningún encabezado Retry-After presente.

Devoluciones

Instancia de LROPoller que devuelve GenericResource o el resultado de cls(response)

Tipo de valor devuelto

Excepciones

begin_validate_move_resources

Valida si los recursos se pueden mover de un grupo de recursos a otro.

Esta operación comprueba si los recursos especificados se pueden mover al destino. Los recursos que se van a mover deben estar en el mismo grupo de recursos de origen en la suscripción de origen que se va a usar. El grupo de recursos de destino puede estar en otra suscripción. Si la validación se realiza correctamente, devuelve el código de respuesta HTTP 204 (sin contenido). Si se produce un error en la validación, devuelve el código de respuesta HTTP 409 (conflicto) con un mensaje de error. Recupere la dirección URL en el valor del encabezado Location para comprobar el resultado de la operación de larga duración.

begin_validate_move_resources(source_resource_group_name: str, parameters: _models.ResourcesMoveInfo, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[None]

Parámetros

source_resource_group_name
str
Requerido

Nombre del grupo de recursos de la suscripción de origen que contiene los recursos que se van a validar para el traslado. Necesario.

parameters
ResourcesMoveInfo o IO
Requerido

Parámetros para mover recursos. Es un tipo ResourcesMoveInfo o un tipo de E/S. Necesario.

content_type
str

Tipo de contenido del parámetro body. Los valores conocidos son: "application/json". El valor predeterminado es Ninguno.

cls
callable

Un tipo o función personalizados que se pasarán a la respuesta directa

continuation_token
str

Token de continuación para reiniciar un sondeo desde un estado guardado.

polling
bool o PollingMethod

De forma predeterminada, el método de sondeo será ARMPolling. Pase False para que esta operación no sondee o pase su propio objeto de sondeo inicializado para una estrategia de sondeo personal.

polling_interval
int

Tiempo de espera predeterminado entre dos sondeos para las operaciones LRO si no hay ningún encabezado Retry-After presente.

Devoluciones

Instancia de LROPoller que devuelve None o el resultado de cls(response)

Tipo de valor devuelto

Excepciones

check_existence

Comprueba si existe un recurso.

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

Parámetros

resource_group_name
str
Requerido

Nombre del grupo de recursos que contiene el recurso que se va a comprobar. El nombre distingue mayúsculas de minúsculas. Necesario.

resource_provider_namespace
str
Requerido

Proveedor de recursos del recurso que se va a comprobar. Necesario.

parent_resource_path
str
Requerido

La identidad del recurso primario. Necesario.

resource_type
str
Requerido

El tipo de recurso. Necesario.

resource_name
str
Requerido

Nombre del recurso que se va a comprobar si existe. Necesario.

api_version
str
Requerido

La versión de API que se va a usar para la operación. Necesario.

cls
callable

Un tipo o función personalizados que se pasarán a la respuesta directa

Devoluciones

bool o el resultado de cls(response)

Tipo de valor devuelto

Excepciones

check_existence_by_id

Comprueba por identificador si existe un recurso. Actualmente, esta API solo funciona para un conjunto limitado de proveedores de recursos. En caso de que un proveedor de recursos no implemente esta API, ARM responderá con un 405. La alternativa es usar la API GET para comprobar la existencia del recurso.

check_existence_by_id(resource_id: str, api_version: str, **kwargs: Any) -> bool

Parámetros

resource_id
str
Requerido

Identificador completo del recurso, incluido el nombre del recurso y el tipo de recurso. Use el formato /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}. Necesario.

api_version
str
Requerido

La versión de API que se va a usar para la operación. Necesario.

cls
callable

Un tipo o función personalizados que se pasarán a la respuesta directa

Devoluciones

bool o el resultado de cls(response)

Tipo de valor devuelto

Excepciones

get

Obtiene un recurso.

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

Parámetros

resource_group_name
str
Requerido

Nombre del grupo de recursos que contiene el recurso que se va a obtener. El nombre distingue mayúsculas de minúsculas. Necesario.

resource_provider_namespace
str
Requerido

Espacio de nombres del proveedor de recursos. Necesario.

parent_resource_path
str
Requerido

La identidad del recurso primario. Necesario.

resource_type
str
Requerido

Tipo de recurso del recurso. Necesario.

resource_name
str
Requerido

Nombre del recurso que se va a obtener. Necesario.

api_version
str
Requerido

La versión de API que se va a usar para la operación. Necesario.

cls
callable

Un tipo o función personalizados que se pasarán a la respuesta directa

Devoluciones

GenericResource o el resultado de cls(response)

Tipo de valor devuelto

Excepciones

get_by_id

Obtiene un recurso por identificador.

get_by_id(resource_id: str, api_version: str, **kwargs: Any) -> GenericResource

Parámetros

resource_id
str
Requerido

Identificador completo del recurso, incluido el nombre del recurso y el tipo de recurso. Use el formato /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}. Necesario.

api_version
str
Requerido

La versión de API que se va a usar para la operación. Necesario.

cls
callable

Un tipo o función personalizados que se pasarán a la respuesta directa

Devoluciones

GenericResource o el resultado de cls(response)

Tipo de valor devuelto

Excepciones

list

Obtenga todos los recursos de una suscripción.

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

Parámetros

filter
str
Requerido

Filtro que se va a aplicar en operation.:code:
<br>Los operadores de comparación de filtros incluyen eq (iguales) y ne (no iguales) y se pueden usar con las siguientes propiedades: location, , identity/principalIdresourceGroupplan/publisheridentitynameresourceTypeplan/productplan/nameplan, plan/versiony plan/promotionCode.:code:
<br>Por ejemplo, para filtrar por un tipo de recurso, use $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 y/`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, Las etiquetas originales de cada recurso no se devolverán en los resultados.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 y plan/publisher y plan/name, and identity and identity/principalId'. El valor predeterminado es Ninguno.

expand
str
Requerido

Lista separada por comas de propiedades adicionales que se incluirán en la respuesta. Los valores válidos incluyen createdTime, changedTime y provisioningState. Por ejemplo, $expand=createdTime,changedTime. El valor predeterminado es Ninguno.

top
int
Requerido

Número de recomendaciones por página si se usa una versión paginada de esta API. El valor predeterminado es Ninguno.

cls
callable

Un tipo o función personalizados que se pasarán a la respuesta directa

Devoluciones

Iterador como una instancia de GenericResourceExpanded o el resultado de cls(response)

Tipo de valor devuelto

Excepciones

list_by_resource_group

Obtenga todos los recursos de un grupo de recursos.

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

Parámetros

resource_group_name
str
Requerido

Grupo de recursos con los recursos que se van a obtener. Necesario.

filter
str
Requerido

Filtro que se va a aplicar en operation.:code:
<br>Las propiedades que puede usar para eq (iguales) o ne (no iguales) son: ubicación, resourceType, name, resourceGroup, identity/principalId, plan, plan/publisher, plan/product, plan/name, plan/version y plan/promotionCode.:code:<br>``<br>por ejemplo, para filtrar por un tipo de recurso, use: $filter=resourceType eq 'Microsoft.Network/virtualNetworks':code:<br>``<br>You can use substringof(value, property) en el filtro. Las propiedades que puede usar para la subcadena son: name y resourceGroup.:code:<br>``<br>Por ejemplo, para obtener todos los recursos con 'demo' en cualquier parte del nombre, use: $filter=substringof('demo', name):code:<br>``<br>You can link more than one substringof together by adding and/or operators.:code:<br>``<br>You can filter by tag names and values. Por ejemplo, para filtrar por un nombre y un valor de etiqueta, use $filter=tagName eq 'tag1' y tagValue eq 'Value1'. Al filtrar por un nombre de etiqueta y un valor, las etiquetas de cada recurso no se devuelven en results.:code::code:<br>:code:>><<<br>You can use algunas propiedades juntas al filtrar. Las combinaciones que puede usar son: substringof o resourceType, plan/publisher y plan/name, identity e identity/principalId. El valor predeterminado es Ninguno.

expand
str
Requerido

Lista separada por comas de propiedades adicionales que se incluirán en la respuesta. Los valores válidos incluyen createdTime, changedTime y provisioningState. Por ejemplo, $expand=createdTime,changedTime. El valor predeterminado es Ninguno.

top
int
Requerido

Número de resultados que se van a devolver. Si se pasa null, devuelve todos los recursos. El valor predeterminado es Ninguno.

cls
callable

Un tipo o función personalizados que se pasarán a la respuesta directa

Devoluciones

Iterador como una instancia de GenericResourceExpanded o el resultado de cls(response)

Tipo de valor devuelto

Excepciones

Atributos

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