ResourceGroupsOperations Classe
Aviso
NÃO instancie essa classe diretamente.
Em vez disso, você deve acessar as operações a seguir por meio de
Atributo <xref:resource_groups>.
- Herança
-
builtins.objectResourceGroupsOperations
Construtor
ResourceGroupsOperations(*args, **kwargs)
Métodos
begin_delete |
Excluir grupo de recursos. |
check_existence |
Verifica se o grupo de recursos existe. |
create_or_update |
Crie um grupo de recursos. |
export_template |
Captura o grupo de recursos especificado como um modelo. |
get |
Obtenha um grupo de recursos. |
list |
Obtém uma coleção de grupos de recursos. |
list_resources |
Obtém todos os recursos em uma assinatura. |
patch |
Grupos de recursos podem ser atualizados através de uma operação PATCH simples para um endereço de grupo. O formato da solicitação é o mesmo que aquele para criar um grupo de recursos, mas, se um campo não estiver especificado, o valor atual será transferido. |
begin_delete
Excluir grupo de recursos.
async begin_delete(resource_group_name: str, **kwargs: Any) -> AsyncLROPoller[None]
Parâmetros
- resource_group_name
- str
O nome do grupo de recursos a serem excluídos. 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 AsyncPollingMethod
Por padrão, o método de sondagem será AsyncARMPolling. 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 AsyncLROPoller que retorna Nenhum ou o resultado de cls(response)
Tipo de retorno
Exceções
check_existence
Verifica se o grupo de recursos existe.
async check_existence(resource_group_name: str, **kwargs: Any) -> bool
Parâmetros
- resource_group_name
- str
O nome do grupo de recursos para verificar. 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
bool ou o resultado de cls(response)
Tipo de retorno
Exceções
create_or_update
Crie um grupo de recursos.
async create_or_update(resource_group_name: str, parameters: _models.ResourceGroup, *, content_type: str = 'application/json', **kwargs: Any) -> _models.ResourceGroup
Parâmetros
- resource_group_name
- str
O nome do grupo de recursos a ser criado ou atualizado. Obrigatórios.
- parameters
- ResourceGroup ou IO
Parâmetros fornecidos para a operação de serviço de grupo de recursos de criação ou atualização. É um tipo ResourceGroup 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
Retornos
ResourceGroup ou o resultado de cls(response)
Tipo de retorno
Exceções
export_template
Captura o grupo de recursos especificado como um modelo.
async export_template(resource_group_name: str, parameters: _models.ExportTemplateRequest, *, content_type: str = 'application/json', **kwargs: Any) -> _models.ResourceGroupExportResult
Parâmetros
- resource_group_name
- str
O nome do grupo de recursos a ser criado ou atualizado. Obrigatórios.
- parameters
- ExportTemplateRequest ou IO
Parâmetros fornecidos para a operação do grupo de recursos do modelo de exportação. É um tipo ExportTemplateRequest 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
Retornos
ResourceGroupExportResult ou o resultado de cls(response)
Tipo de retorno
Exceções
get
Obtenha um grupo de recursos.
async get(resource_group_name: str, **kwargs: Any) -> ResourceGroup
Parâmetros
- resource_group_name
- str
O nome do grupo de recursos para obter. 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
ResourceGroup ou o resultado de cls(response)
Tipo de retorno
Exceções
list
Obtém uma coleção de grupos de recursos.
list(filter: str | None = None, top: int | None = None, **kwargs: Any) -> AsyncIterable[ResourceGroup]
Parâmetros
- top
- int
Parâmetros da consulta. Se null for passado, retorna todos os grupos de 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 ResourceGroup ou o resultado de cls(response)
Tipo de retorno
Exceções
list_resources
Obtém todos os recursos em uma assinatura.
list_resources(resource_group_name: str, filter: str | None = None, expand: str | None = None, top: int | None = None, **kwargs: Any) -> AsyncIterable[GenericResourceExpanded]
Parâmetros
- resource_group_name
- str
Parâmetros da consulta. Se null for passado, retorna todos os grupos de recursos. Obrigatórios.
- 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
Parâmetros da consulta. Se null for passado, retorna todos os grupos de 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
patch
Grupos de recursos podem ser atualizados através de uma operação PATCH simples para um endereço de grupo. O formato da solicitação é o mesmo que aquele para criar um grupo de recursos, mas, se um campo não estiver especificado, o valor atual será transferido.
async patch(resource_group_name: str, parameters: _models.ResourceGroup, *, content_type: str = 'application/json', **kwargs: Any) -> _models.ResourceGroup
Parâmetros
- resource_group_name
- str
O nome do grupo de recursos a ser criado ou atualizado. O nome diferencia maiúsculas de minúsculas. Obrigatórios.
- parameters
- ResourceGroup ou IO
Parâmetros fornecidos para a operação de serviço do grupo de recursos de estado da atualização. É um tipo ResourceGroup 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
Retornos
ResourceGroup ou o resultado de cls(response)
Tipo de retorno
Exceções
Atributos
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