ClientGroupsOperations Classe

  • Referência

Aviso

NÃO instancie essa classe diretamente.

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

EventGridManagementClient's

Atributo <xref:client_groups>.

Herança
builtins.object
ClientGroupsOperations

Construtor

ClientGroupsOperations(*args, **kwargs)

Métodos

begin_create_or_update

Criar ou atualizar um grupo de clientes.

Crie ou atualize um grupo de clientes com os parâmetros especificados.
begin_delete

Excluir um grupo de clientes.

Exclua um grupo de clientes existente.
get

Obter um grupo de clientes.

Obter propriedades de um grupo de clientes.
list_by_namespace

Liste todos os grupos de clientes em um namespace.

Obtenha todos os grupos de clientes em um namespace.

begin_create_or_update

Criar ou atualizar um grupo de clientes.

Crie ou atualize um grupo de clientes com os parâmetros especificados.

begin_create_or_update(resource_group_name: str, namespace_name: str, client_group_name: str, client_group_info: _models.ClientGroup, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.ClientGroup]

Parâmetros

resource_group_name
str
Obrigatório

O nome do grupo de recursos na assinatura do usuário. Obrigatórios.

namespace_name
str
Obrigatório

Nome do namespace. Obrigatórios.

client_group_name
str
Obrigatório

O nome do grupo de clientes. Obrigatórios.

client_group_info
ClientGroup ou IO
Obrigatório

Informações do grupo de clientes. É um tipo ClientGroup 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 ClientGroup ou o resultado de cls(response)

Tipo de retorno

LROPoller[ClientGroup]

Exceções

HttpResponseError

begin_delete

Excluir um grupo de clientes.

Exclua um grupo de clientes existente.

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

Parâmetros

resource_group_name
str
Obrigatório

O nome do grupo de recursos na assinatura do usuário. Obrigatórios.

namespace_name
str
Obrigatório

Nome do namespace. Obrigatórios.

client_group_name
str
Obrigatório

Nome do grupo de clientes. 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 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

get

Obter um grupo de clientes.

Obter propriedades de um grupo de clientes.

get(resource_group_name: str, namespace_name: str, client_group_name: str, **kwargs: Any) -> ClientGroup

Parâmetros

resource_group_name
str
Obrigatório

O nome do grupo de recursos na assinatura do usuário. Obrigatórios.

namespace_name
str
Obrigatório

Nome do namespace. Obrigatórios.

client_group_name
str
Obrigatório

Nome do grupo de clientes. Obrigatórios.

cls
callable

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

Retornos

ClientGroup ou o resultado de cls(response)

Tipo de retorno

ClientGroup

Exceções

HttpResponseError

list_by_namespace

Liste todos os grupos de clientes em um namespace.

Obtenha todos os grupos de clientes em um namespace.

list_by_namespace(resource_group_name: str, namespace_name: str, filter: str | None = None, top: int | None = None, **kwargs: Any) -> Iterable[ClientGroup]

Parâmetros

resource_group_name
str
Obrigatório

O nome do grupo de recursos na assinatura do usuário. Obrigatórios.

namespace_name
str
Obrigatório

Nome do namespace. Obrigatórios.

filter
str
Obrigatório

A consulta usada para filtrar os resultados da pesquisa usando a sintaxe OData. A filtragem é permitida apenas na propriedade 'name' e com um número limitado de operações OData. Essas operações são: a função 'contains', bem como as seguintes operações lógicas: not, and, or, eq (for equal) e ne (for not equal). Não há suporte para operações aritméticas. Veja a seguir um exemplo de filtro válido: $filter=contains(namE, 'PATTERN') e name ne 'PATTERN-1'. O seguinte não é um exemplo de filtro válido: $filter=location eq 'westus'. O valor padrão é Nenhum.

top
int
Obrigatório

O número de resultados a serem retornados por página para a operação de lista. O intervalo válido para o parâmetro superior é de 1 a 100. Se não for especificado, o número padrão de resultados a serem retornados será de 20 itens por página. 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 ClientGroup ou o resultado de cls(response)

Tipo de retorno

ItemPaged[ClientGroup]

Exceções

HttpResponseError

Atributos

models 

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