Partilhar via

ResourceGroupsOperations Classe

  • Referência

Aviso

NÃO instancia esta classe diretamente.

Em vez disso, deve aceder às seguintes operações através de

ResourceManagementClient's

<xref:resource_groups> atributo.

Herança
builtins.object
ResourceGroupsOperations

Construtor

ResourceGroupsOperations(*args, **kwargs)

Métodos

begin_delete

Elimina um grupo de recursos.

Quando elimina um grupo de recursos, todos os recursos também são eliminados. Eliminar um grupo de recursos elimina todas as implementações de modelos e operações atualmente armazenadas.
begin_export_template

Captura o grupo de recursos especificado como um modelo.
check_existence

Verifica se existe um grupo de recursos.
create_or_update

Cria ou atualiza um grupo de recursos.
get

Obtém um grupo de recursos.
list

Obtém todos os grupos de recursos de uma subscrição.
update

Atualizações um grupo de recursos.

Os grupos de recursos podem ser atualizados através de uma operação PATCH simples para um endereço de grupo. O formato do pedido é o mesmo para criar um grupo de recursos. Se um campo não for especificado, o valor atual será mantido.

begin_delete

Elimina um grupo de recursos.

Quando elimina um grupo de recursos, todos os recursos também são eliminados. Eliminar um grupo de recursos elimina todas as implementações de modelos e operações atualmente armazenadas.

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

Parâmetros

resource_group_name
str
Necessário

O nome do grupo de recursos a eliminar. O nome não é sensível a maiúsculas e minúsculas. Obrigatório.

cls
callable

Um tipo ou função personalizado que será transmitido a resposta direta

continuation_token
str

Um token de continuação para reiniciar um poller a partir de um estado guardado.

polling
bool ou PollingMethod

Por predefinição, o seu método de consulta será ARMPolling. Transmita Falso para que esta operação não seja consultada ou transmita o seu próprio objeto de consulta inicializado para uma estratégia de consulta pessoal.

polling_interval
int

Tempo de espera predefinido entre duas sondagens para operações LRO se não existir nenhum cabeçalho de Retry-After.

Devoluções

Uma instância do LROPoller que devolve Nenhum ou o resultado de cls(resposta)

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
Necessário

O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas. Obrigatório.

parameters
ExportTemplateRequest ou IO
Necessário

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

content_type
str

Tipo de conteúdo do Parâmetro do Corpo. Os valores conhecidos são: "application/json". O valor predefinido é Nenhum.

cls
callable

Um tipo ou função personalizado que será transmitido a resposta direta

continuation_token
str

Um token de continuação para reiniciar um poller a partir de um estado guardado.

polling
bool ou PollingMethod

Por predefinição, o seu método de consulta será ARMPolling. Transmita Falso para que esta operação não seja consultada ou transmita o seu próprio objeto de consulta inicializado para uma estratégia de consulta pessoal.

polling_interval
int

Tempo de espera predefinido entre duas sondagens para operações LRO se não existir nenhum cabeçalho de Retry-After.

Devoluções

Uma instância do LROPoller que devolve 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
Necessário

O nome do grupo de recursos a verificar. O nome não é sensível a maiúsculas e minúsculas. Obrigatório.

cls
callable

Um tipo ou função personalizado que será transmitido a resposta direta

Devoluções

bool ou o resultado de cls(resposta)

Tipo de retorno

bool

Exceções

HttpResponseError

create_or_update

Cria ou atualiza 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
Necessário

O nome do grupo de recursos a criar ou atualizar. Pode incluir carateres alfanuméricos, caráter de sublinhado, parênteses, hífen, ponto final (exceto no final) e Carateres Unicode que correspondem aos carateres permitidos. Obrigatório.

parameters
ResourceGroup ou IO
Necessário

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

content_type
str

Tipo de conteúdo do Parâmetro do Corpo. Os valores conhecidos são: "application/json". O valor predefinido é Nenhum.

cls
callable

Um tipo ou função personalizado que será transmitido a resposta direta

Devoluções

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
Necessário

O nome do grupo de recursos a obter. O nome não é sensível a maiúsculas e minúsculas. Obrigatório.

cls
callable

Um tipo ou função personalizado que será transmitido a resposta direta

Devoluções

ResourceGroup ou o resultado de cls(response)

Tipo de retorno

ResourceGroup

Exceções

HttpResponseError

list

Obtém todos os grupos de recursos de uma subscrição.

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

Parâmetros

filter
str
Necessário

O filtro a aplicar na operação.:code:
:code:>><<<br>Pode filtrar por nomes de etiquetas e valores. Por exemplo, para filtrar um nome e valor de etiqueta, utilize $filter=tagName eq 'tag1' e tagValue eq 'Value1'. O valor predefinido é Nenhum.

top
int
Necessário

O número de resultados a devolver. Se for transmitido nulo, devolve todos os grupos de recursos. O valor predefinido é Nenhum.

cls
callable

Um tipo ou função personalizado que será transmitido a resposta direta

Devoluções

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.

Os grupos de recursos podem ser atualizados através de uma operação PATCH simples para um endereço de grupo. O formato do pedido é o mesmo para criar um grupo de recursos. Se um campo não for especificado, o valor atual será mantido.

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

Parâmetros

resource_group_name
str
Necessário

O nome do grupo de recursos a atualizar. O nome não é sensível a maiúsculas e minúsculas. Obrigatório.

parameters
ResourceGroupPatchable ou IO
Necessário

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

content_type
str

Tipo de conteúdo do Parâmetro do Corpo. Os valores conhecidos são: "application/json". O valor predefinido é Nenhum.

cls
callable

Um tipo ou função personalizado que será transmitido a resposta direta

Devoluções

ResourceGroup ou o resultado de cls(response)

Tipo de retorno

ResourceGroup

Exceções

HttpResponseError

Atributos

models 

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