ResourcesOperations Classe
Aviso
NÃO instancie essa classe diretamente.
Em vez disso, você deve acessar as operações a seguir por meio de
Atributo <xref:resources>.
- Herança
-
builtins.objectResourcesOperations
Construtor
ResourcesOperations(*args, **kwargs)Métodos
| begin_create_or_update |
Cria um recurso. |
| begin_create_or_update_by_id |
Crie um recurso por ID. |
| begin_delete |
Exclui um recurso. |
| begin_delete_by_id |
Exclui um recurso por ID. |
| begin_move_resources |
Move recursos de um grupo de recursos para outro. Os recursos a serem movidos devem estar no mesmo grupo de recursos de origem na assinatura de origem que está sendo usada. O grupo de recursos de destino pode estar em uma assinatura diferente. Ao mover recursos, o grupo de origem e o grupo de destino são bloqueados durante a operação. As operações de gravação e exclusão são bloqueadas nos grupos até que a migração seja concluída. |
| begin_update |
Atualiza um recurso. |
| begin_update_by_id |
Atualizações um recurso por ID. |
| begin_validate_move_resources |
Valida se os recursos podem ser movidos de um grupo de recursos para outro. Essa operação verifica se os recursos especificados podem ser movidos para o destino. Os recursos a serem movidos devem estar no mesmo grupo de recursos de origem na assinatura de origem que está sendo usada. O grupo de recursos de destino pode estar em uma assinatura diferente. Se a validação for bem-sucedida, ela retornará o código de resposta HTTP 204 (sem conteúdo). Se a validação falhar, ela retornará o código de resposta HTTP 409 (Conflito) com uma mensagem de erro. Recupere a URL no valor do cabeçalho Location para marcar o resultado da operação de execução longa. |
| check_existence |
Verifica se existe um recurso. |
| check_existence_by_id |
Verifica por ID se existe um recurso. Atualmente, essa API funciona apenas para um conjunto limitado de provedores de recursos. Caso um provedor de recursos não implemente essa API, o ARM responderá com um 405. Em seguida, a alternativa é usar a API GET para marcar para a existência do recurso. |
| get |
Obtém um recurso. |
| get_by_id |
Obtém um recurso por ID. |
| list |
Obtenha todos os recursos em uma assinatura. |
| list_by_resource_group |
Obtenha todos os recursos de um grupo de recursos. |
begin_create_or_update
Cria um 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
O nome do grupo de recursos para o recurso. O nome diferencia maiúsculas de minúsculas. Obrigatórios.
- parameters
- GenericResource ou IO
Parâmetros para criar ou atualizar o recurso. É um tipo GenericResource ou um tipo de E/S. Obrigatórios.
- content_type
- str
Body Parameter content-type. Os valores conhecidos são: 'application/json'. O valor padrão é Nenhum.
- cls
- callable
Um tipo ou função personalizado que será passado para a resposta direta
- continuation_token
- str
Um token de continuação para reiniciar um sondador de um estado salvo.
- polling
- bool ou PollingMethod
Por padrão, o método de sondagem será ARMPolling. Passe False para que essa operação não seja sondada ou passe seu próprio objeto de sondagem inicializado para uma estratégia de sondagem pessoal.
- polling_interval
- int
Tempo de espera padrão entre duas pesquisas para operações LRO se nenhum cabeçalho Retry-After estiver presente.
Retornos
Uma instância de LROPoller que retorna GenericResource ou o resultado de cls(response)
Tipo de retorno
Exceções
begin_create_or_update_by_id
Crie um recurso por 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]Parâmetros
- resource_id
- str
A ID totalmente qualificada do recurso, incluindo o nome e o tipo de recurso. Use o formato /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}. Obrigatórios.
- parameters
- GenericResource ou IO
Cria ou atualiza parâmetros de recursos. É um tipo GenericResource ou um tipo de E/S. Obrigatórios.
- content_type
- str
Body Parameter content-type. Os valores conhecidos são: 'application/json'. O valor padrão é Nenhum.
- cls
- callable
Um tipo ou função personalizado que será passado para a resposta direta
- continuation_token
- str
Um token de continuação para reiniciar um sondador de um estado salvo.
- polling
- bool ou PollingMethod
Por padrão, o método de sondagem será ARMPolling. Passe False para que essa operação não seja sondada ou passe seu próprio objeto de sondagem inicializado para uma estratégia de sondagem pessoal.
- polling_interval
- int
Tempo de espera padrão entre duas pesquisas para operações LRO se nenhum cabeçalho Retry-After estiver presente.
Retornos
Uma instância de LROPoller que retorna GenericResource ou o resultado de cls(response)
Tipo de retorno
Exceções
begin_delete
Exclui um 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
O nome do grupo de recursos que contém o recurso a ser excluído. O nome diferencia maiúsculas de minúsculas. Obrigatórios.
- cls
- callable
Um tipo ou função personalizado que será passado para a resposta direta
- continuation_token
- str
Um token de continuação para reiniciar um sondador de um estado salvo.
- polling
- bool ou PollingMethod
Por padrão, o método de sondagem será ARMPolling. Passe False para que essa operação não seja sondada ou passe seu próprio objeto de sondagem inicializado para uma estratégia de sondagem pessoal.
- polling_interval
- int
Tempo de espera padrão entre duas pesquisas para operações LRO se nenhum cabeçalho Retry-After estiver presente.
Retornos
Uma instância de LROPoller que retorna Nenhum ou o resultado de cls(response)
Tipo de retorno
Exceções
begin_delete_by_id
Exclui um recurso por ID.
begin_delete_by_id(resource_id: str, api_version: str, **kwargs: Any) -> LROPoller[None]Parâmetros
- resource_id
- str
A ID totalmente qualificada do recurso, incluindo o nome e o tipo de recurso. Use o formato /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}. Obrigatórios.
- cls
- callable
Um tipo ou função personalizado que será passado para a resposta direta
- continuation_token
- str
Um token de continuação para reiniciar um sondador de um estado salvo.
- polling
- bool ou PollingMethod
Por padrão, o método de sondagem será ARMPolling. Passe False para que essa operação não seja sondada ou passe seu próprio objeto de sondagem inicializado para uma estratégia de sondagem pessoal.
- polling_interval
- int
Tempo de espera padrão entre duas pesquisas para operações LRO se nenhum cabeçalho Retry-After estiver presente.
Retornos
Uma instância de LROPoller que retorna Nenhum ou o resultado de cls(response)
Tipo de retorno
Exceções
begin_move_resources
Move recursos de um grupo de recursos para outro.
Os recursos a serem movidos devem estar no mesmo grupo de recursos de origem na assinatura de origem que está sendo usada. O grupo de recursos de destino pode estar em uma assinatura diferente. Ao mover recursos, o grupo de origem e o grupo de destino são bloqueados durante a operação. As operações de gravação e exclusão são bloqueadas nos grupos até que a migração seja concluída.
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
O nome do grupo de recursos da assinatura de origem que contém os recursos a serem movidos. Obrigatórios.
- parameters
- ResourcesMoveInfo ou IO
Parâmetros para mover recursos. É um tipo ResourcesMoveInfo ou um tipo de E/S. Obrigatórios.
- content_type
- str
Body Parameter content-type. Os valores conhecidos são: 'application/json'. O valor padrão é Nenhum.
- cls
- callable
Um tipo ou função personalizado que será passado para a resposta direta
- continuation_token
- str
Um token de continuação para reiniciar um sondador de um estado salvo.
- polling
- bool ou PollingMethod
Por padrão, o método de sondagem será ARMPolling. Passe False para que essa operação não seja sondada ou passe seu próprio objeto de sondagem inicializado para uma estratégia de sondagem pessoal.
- polling_interval
- int
Tempo de espera padrão entre duas pesquisas para operações LRO se nenhum cabeçalho Retry-After estiver presente.
Retornos
Uma instância de LROPoller que retorna Nenhum ou o resultado de cls(response)
Tipo de retorno
Exceções
begin_update
Atualiza um 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
O nome do grupo de recursos para o recurso. O nome diferencia maiúsculas de minúsculas. Obrigatórios.
- parameters
- GenericResource ou IO
Parâmetros para atualizar o recurso. É um tipo GenericResource ou um tipo de E/S. Obrigatórios.
- content_type
- str
Body Parameter content-type. Os valores conhecidos são: 'application/json'. O valor padrão é Nenhum.
- cls
- callable
Um tipo ou função personalizado que será passado para a resposta direta
- continuation_token
- str
Um token de continuação para reiniciar um sondador de um estado salvo.
- polling
- bool ou PollingMethod
Por padrão, o método de sondagem será ARMPolling. Passe False para que essa operação não seja sondada ou passe seu próprio objeto de sondagem inicializado para uma estratégia de sondagem pessoal.
- polling_interval
- int
Tempo de espera padrão entre duas pesquisas para operações LRO se nenhum cabeçalho Retry-After estiver presente.
Retornos
Uma instância de LROPoller que retorna GenericResource ou o resultado de cls(response)
Tipo de retorno
Exceções
begin_update_by_id
Atualizações um recurso por ID.
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
A ID totalmente qualificada do recurso, incluindo o nome e o tipo de recurso. Use o formato /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}. Obrigatórios.
- parameters
- GenericResource ou IO
Atualizar parâmetros de recurso. É um tipo GenericResource ou um tipo de E/S. Obrigatórios.
- content_type
- str
Body Parameter content-type. Os valores conhecidos são: 'application/json'. O valor padrão é Nenhum.
- cls
- callable
Um tipo ou função personalizado que será passado para a resposta direta
- continuation_token
- str
Um token de continuação para reiniciar um sondador de um estado salvo.
- polling
- bool ou PollingMethod
Por padrão, o método de sondagem será ARMPolling. Passe False para que essa operação não seja sondada ou passe seu próprio objeto de sondagem inicializado para uma estratégia de sondagem pessoal.
- polling_interval
- int
Tempo de espera padrão entre duas pesquisas para operações LRO se nenhum cabeçalho Retry-After estiver presente.
Retornos
Uma instância de LROPoller que retorna GenericResource ou o resultado de cls(response)
Tipo de retorno
Exceções
begin_validate_move_resources
Valida se os recursos podem ser movidos de um grupo de recursos para outro.
Essa operação verifica se os recursos especificados podem ser movidos para o destino. Os recursos a serem movidos devem estar no mesmo grupo de recursos de origem na assinatura de origem que está sendo usada. O grupo de recursos de destino pode estar em uma assinatura diferente. Se a validação for bem-sucedida, ela retornará o código de resposta HTTP 204 (sem conteúdo). Se a validação falhar, ela retornará o código de resposta HTTP 409 (Conflito) com uma mensagem de erro. Recupere a URL no valor do cabeçalho Location para marcar o resultado da operação de execução longa.
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
O nome do grupo de recursos da assinatura de origem que contém os recursos a serem validados para movimentação. Obrigatórios.
- parameters
- ResourcesMoveInfo ou IO
Parâmetros para mover recursos. É um tipo ResourcesMoveInfo ou um tipo de E/S. Obrigatórios.
- content_type
- str
Body Parameter content-type. Os valores conhecidos são: 'application/json'. O valor padrão é Nenhum.
- cls
- callable
Um tipo ou função personalizado que será passado para a resposta direta
- continuation_token
- str
Um token de continuação para reiniciar um sondador de um estado salvo.
- polling
- bool ou PollingMethod
Por padrão, o método de sondagem será ARMPolling. Passe False para que essa operação não seja sondada ou passe seu próprio objeto de sondagem inicializado para uma estratégia de sondagem pessoal.
- polling_interval
- int
Tempo de espera padrão entre duas pesquisas para operações LRO se nenhum cabeçalho Retry-After estiver presente.
Retornos
Uma instância de LROPoller que retorna Nenhum ou o resultado de cls(response)
Tipo de retorno
Exceções
check_existence
Verifica se existe um 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) -> boolParâmetros
- resource_group_name
- str
O nome do grupo de recursos que contém o recurso a ser marcar. O nome diferencia maiúsculas de minúsculas. Obrigatórios.
- resource_provider_namespace
- str
O provedor de recursos do recurso a ser marcar. Obrigatórios.
- cls
- callable
Um tipo ou função personalizado que será passado para a resposta direta
Retornos
bool ou o resultado de cls(response)
Tipo de retorno
Exceções
check_existence_by_id
Verifica por ID se existe um recurso. Atualmente, essa API funciona apenas para um conjunto limitado de provedores de recursos. Caso um provedor de recursos não implemente essa API, o ARM responderá com um 405. Em seguida, a alternativa é usar a API GET para marcar para a existência do recurso.
check_existence_by_id(resource_id: str, api_version: str, **kwargs: Any) -> boolParâmetros
- resource_id
- str
A ID totalmente qualificada do recurso, incluindo o nome e o tipo de recurso. Use o formato /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}. Obrigatórios.
- cls
- callable
Um tipo ou função personalizado que será passado para a resposta direta
Retornos
bool ou o resultado de cls(response)
Tipo de retorno
Exceções
get
Obtém um 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) -> GenericResourceParâmetros
- resource_group_name
- str
O nome do grupo de recursos que contém o recurso a ser obtido. O nome diferencia maiúsculas de minúsculas. Obrigatórios.
- cls
- callable
Um tipo ou função personalizado que será passado para a resposta direta
Retornos
GenericResource ou o resultado de cls(response)
Tipo de retorno
Exceções
get_by_id
Obtém um recurso por ID.
get_by_id(resource_id: str, api_version: str, **kwargs: Any) -> GenericResourceParâmetros
- resource_id
- str
A ID totalmente qualificada do recurso, incluindo o nome e o tipo de recurso. Use o formato /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}. Obrigatórios.
- cls
- callable
Um tipo ou função personalizado que será passado para a resposta direta
Retornos
GenericResource ou o resultado de cls(response)
Tipo de retorno
Exceções
list
Obtenha todos os recursos em uma assinatura.
list(filter: str | None = None, expand: str | None = None, top: int | None = None, **kwargs: Any) -> Iterable[GenericResourceExpanded]Parâmetros
- filter
- str
O filtro a ser aplicado no operation.:code:<br>Os operadores de comparação de filtro incluem eq (iguais) e ne (não é igual a) e podem ser usados com as seguintes propriedades: location, resourceType, , name, resourceGroup, identity/principalIdidentity , plan, plan/nameplan/productplan/publisherplan/versione plan/promotionCode.:code:<br>Por exemplo, para filtrar por um 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 e/`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, as marcas originais de cada recurso não serão retornadas nos 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 and plan/publisher and plan/name, and identity and identity/principalId'. O valor padrão é Nenhum.
- expand
- str
Lista separada por vírgulas de propriedades adicionais a serem incluídas na resposta.
Os valores válidos incluem createdTime, changedTime e provisioningState. Por exemplo, $expand=createdTime,changedTime. O valor padrão é Nenhum.
- top
- int
O número de recomendações por página se uma versão paginada dessa API estiver sendo usada. O valor padrão é Nenhum.
- cls
- callable
Um tipo ou função personalizado que será passado para a resposta direta
Retornos
Um iterador como a instância de GenericResourceExpanded ou o resultado de cls(response)
Tipo de retorno
Exceções
list_by_resource_group
Obtenha todos os recursos de um 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
O grupo de recursos com os recursos a serem obtidos. Obrigatórios.
- filter
- str
O filtro a ser aplicado no operation.:code:<br>As propriedades que você pode usar para eq (igual a) ou ne (não é igual a) são: localização, resourceType, name, resourceGroup, identity, identity/principalId, plan, plan/publisher, plan/product, plan/name, plan/version e plan/promotionCode.:code:<br>``<br>Por exemplo, para filtrar por um tipo de recurso, use: $filter=resourceType eq 'Microsoft.Network/virtualNetworks':code:<br>``<br>Você pode usar substringof(value, property) no filtro. As propriedades que você pode usar para substring são: name e resourceGroup.:code:<br>``<br>Por exemplo, para obter todos os recursos com 'demo' em qualquer lugar no nome, 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 exemplo, para filtrar um nome e um valor de marca, use $filter=tagName eq 'tag1' e tagValue eq 'Value1'. Quando você filtra por um nome de marca e valor, as marcas de cada recurso não são retornadas nos resultados.:code:<br>:code:>><<<br>Você pode usar algumas propriedades juntas ao filtrar. As combinações que você pode usar são: substringof e/ou resourceType, plan e plan/publisher e plan/name, identity e identity/principalId. O valor padrão é Nenhum.
- expand
- str
Lista separada por vírgulas de propriedades adicionais a serem incluídas na resposta.
Os valores válidos incluem createdTime, changedTime e provisioningState. Por exemplo, $expand=createdTime,changedTime. O valor padrão é Nenhum.
- top
- int
O número de resultados a serem retornados. Se nulo for passado, retornará todos os recursos. O valor padrão é Nenhum.
- cls
- callable
Um tipo ou função personalizado que será passado para a resposta direta
Retornos
Um iterador como a instância de GenericResourceExpanded ou o resultado de cls(response)
Tipo de retorno
Exceções
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'>
Azure SDK for Python
Comentários
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulte https://aka.ms/ContentUserFeedback.
Enviar e exibir comentários de