Partilhar via


ResourceGroupsOperations Classe

Aviso

NÃO instanciar 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

Eliminar 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

Obter um grupo de recursos.

list

Obtém uma coleção de grupos de recursos.

list_resources

Obtenha todos os recursos numa subscrição.

patch

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 é igual ao da criação de grupos de recursos. No entanto, se um campo não for especificado, o valor atual será transitado.

begin_delete

Eliminar grupo de recursos.

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 à 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 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 estiver presente nenhum cabeçalho de Retry-After.

Devoluções

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

Tipo de retorno

Exceções

check_existence

Verifica se o grupo de recursos existe.

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 à resposta direta

Devoluções

bool ou o resultado de cls(response)

Tipo de retorno

Exceções

create_or_update

Crie 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 ser criado ou atualizado. Obrigatório.

parameters
ResourceGroup ou IO
Necessário

Parâmetros fornecidos para criar ou atualizar a operação de serviço do 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 à resposta direta

Devoluções

ResourceGroup ou o resultado de cls(response)

Tipo de retorno

Exceções

export_template

Captura o grupo de recursos especificado como um modelo.

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

Parâmetros

resource_group_name
str
Necessário

O nome do grupo de recursos a ser criado ou atualizado. Obrigatório.

parameters
ExportTemplateRequest ou IO
Necessário

Parâmetros fornecidos para a operação de grupo de recursos do modelo de exportação. É um tipo ExportTemplateRequest ou 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 à resposta direta

Devoluções

ResourceGroupExportResult ou o resultado de cls(response)

Tipo de retorno

Exceções

get

Obter 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 à resposta direta

Devoluções

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) -> Iterable[ResourceGroup]

Parâmetros

filter
str
Necessário

O filtro a aplicar na operação. O valor predefinido é Nenhum.

top
int
Necessário

Parâmetros de consulta. Se for transmitido um valor nulo, todos os grupos de recursos serão devolvidos. O valor predefinido é Nenhum.

cls
callable

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

Devoluções

Um iterador como a instância de ResourceGroup ou o resultado de cls(response)

Tipo de retorno

Exceções

list_resources

Obtenha todos os recursos numa subscrição.

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

Parâmetros de consulta. Se for transmitido um valor nulo, todos os grupos de recursos serão devolvidos. Obrigatório.

filter
str
Necessário

O filtro a aplicar na operação. O valor predefinido é Nenhum.

expand
str
Necessário

Lista separada por vírgulas de propriedades adicionais a incluir na resposta. Os valores válidos incluem createdTime, changedTime e provisioningState. Por exemplo, $expand=createdTime,changedTime. O valor predefinido é Nenhum.

top
int
Necessário

Parâmetros de consulta. Se for transmitido um valor nulo, todos os grupos de recursos serão devolvidos. O valor predefinido é Nenhum.

cls
callable

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

Devoluções

Um iterador como a instância de GenericResourceExpanded ou o resultado de cls(response)

Tipo de retorno

Exceções

patch

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 é igual ao da criação de grupos de recursos. No entanto, se um campo não for especificado, o valor atual será transitado.

patch(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 ser criado ou atualizado. O nome não é sensível a maiúsculas e minúsculas. Obrigatório.

parameters
ResourceGroup ou IO
Necessário

Parâmetros fornecidos para a operação de serviço do grupo de recursos de estado de atualização. É 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 à resposta direta

Devoluções

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