ResourceGroupsOperations Classe

  • Referência

Aviso

NÃO instancie essa classe diretamente.

Em vez disso, você deve acessar as operações a seguir por meio de

ResourceManagementClient's

Atributo <xref:resource_groups>.

Herança
builtins.object
ResourceGroupsOperations

Construtor

ResourceGroupsOperations(*args, **kwargs)

Métodos

begin_delete

Exclui um grupo de recursos.

Quando você exclui um grupo de recursos, todos os seus recursos também são excluídos. Excluir um grupo de recursos exclui todas as implantações de modelo e as operações armazenadas no momento.
begin_export_template

Captura o grupo de recursos especificado como um modelo.
check_existence

Verifica se existe um grupo de recursos.
create_or_update

Criar ou atualizar um grupo de recursos.
get

Obtém um grupo de recursos.
list

Obtém todos os grupos de recursos de uma assinatura.
update

Atualizações um grupo de recursos.

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 para a criação de um grupo de recursos. Se um campo não for especificado, o valor atual será retido.

begin_delete

Exclui um grupo de recursos.

Quando você exclui um grupo de recursos, todos os seus recursos também são excluídos. Excluir um grupo de recursos exclui todas as implantações de modelo e as operações armazenadas no momento.

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

Parâmetros

resource_group_name
str
Obrigatório

O nome do grupo de recursos a ser excluído. O nome diferencia maiúsculas de minúsculas. Obrigatórios.

force_deletion_types
str
Obrigatório

Os tipos de recursos que você deseja forçar a exclusão. Atualmente, há suporte apenas para o seguinte: forceDeletionTypes=Microsoft.Compute/virtualMachines,Microsoft.Compute/virtualMachineScaleSets. 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 poller de um estado salvo.

polling
bool ou PollingMethod

Por padrão, seu método de sondagem será ARMPolling. Passe em False para que esta operação não sondar 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

LROPoller[None]

Exceções

HttpResponseError

begin_export_template

Captura o grupo de recursos especificado como um modelo.

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

Parâmetros

resource_group_name
str
Obrigatório

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas. Obrigatórios.

parameters
ExportTemplateRequest ou IO
Obrigatório

Parâmetros para exportar o modelo. É um tipo ExportTemplateRequest ou um tipo de E/S. Obrigatórios.

content_type
str

Tipo de conteúdo do Parâmetro do Corpo. 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 poller de um estado salvo.

polling
bool ou PollingMethod

Por padrão, seu método de sondagem será ARMPolling. Passe em False para que esta operação não sondar 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 ResourceGroupExportResult ou o resultado de cls(response)

Tipo de retorno

LROPoller[ResourceGroupExportResult]

Exceções

HttpResponseError

check_existence

Verifica se existe um grupo de recursos.

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

Parâmetros

resource_group_name
str
Obrigatório

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

bool

Exceções

HttpResponseError

create_or_update

Criar ou atualizar um grupo de recursos.

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
Obrigatório

O nome do grupo de recursos a ser criado ou atualizado. Pode incluir caracteres alfanuméricos, sublinhados, parênteses, hífen, ponto (exceto no final) e caracteres Unicode que correspondem aos caracteres permitidos. Obrigatórios.

parameters
ResourceGroup ou IO
Obrigatório

Parâmetros fornecidos para criar ou atualizar um grupo de recursos. É um tipo ResourceGroup ou um tipo de E/S. Obrigatórios.

content_type
str

Tipo de conteúdo do Parâmetro do Corpo. 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

ResourceGroup

Exceções

HttpResponseError

get

Obtém um grupo de recursos.

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

Parâmetros

resource_group_name
str
Obrigatório

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

ResourceGroup

Exceções

HttpResponseError

list

Obtém todos os grupos de recursos de uma assinatura.

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

Parâmetros

filter
str
Obrigatório

O filtro a ser aplicado no operation.:code:
:code:>><<<br>Você pode filtrar por nomes de marca e valores. Por exemplo, para filtrar um nome de marca e um valor, use $filter=tagName eq 'tag1' e tagValue eq 'Value1'. O valor padrão é Nenhum.

top
int
Obrigatório

O número de resultados a serem retornados. Se nulo for passado, retornará 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 do ResourceGroup ou o resultado de cls(response)

Tipo de retorno

ItemPaged[ResourceGroup]

Exceções

HttpResponseError

update

Atualizações um grupo de recursos.

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 para a criação de um grupo de recursos. Se um campo não for especificado, o valor atual será retido.

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

Parâmetros

resource_group_name
str
Obrigatório

O nome do grupo de recursos a ser atualizado. O nome diferencia maiúsculas de minúsculas. Obrigatórios.

parameters
ResourceGroupPatchable ou IO
Obrigatório

Parâmetros fornecidos para atualizar um grupo de recursos. É um tipo ResourceGroupPatchable ou um tipo de E/S. Obrigatórios.

content_type
str

Tipo de conteúdo do Parâmetro do Corpo. 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

ResourceGroup

Exceções

HttpResponseError

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