SystemTopicsOperations Classe

  • Referência

Operações assíncronas systemTopicsOperations.

Você não deve instanciar essa classe diretamente. Em vez disso, você deve criar uma instância do Cliente que a instancie para você e a anexa como um atributo.

Herança
builtins.object
SystemTopicsOperations

Construtor

SystemTopicsOperations(client, config, serializer, deserializer)

Parâmetros

client
Obrigatório

Cliente para solicitações de serviço.

config
Obrigatório

Configuração do cliente de serviço.

serializer
Obrigatório

Um serializador de modelo de objeto.

deserializer
Obrigatório

Um desserializador de modelo de objeto.

Variáveis

models

Alias para classes de modelo usadas neste grupo de operações.

Métodos

begin_create_or_update

Criar um tópico do sistema.

Cria de forma assíncrona um novo tópico do sistema com os parâmetros especificados.
begin_delete

Exclua um tópico do sistema.

Exclua o tópico do sistema existente.
begin_update

Atualizar um tópico do sistema.

Atualiza de forma assíncrona um tópico do sistema com os parâmetros especificados.
get

Obter um tópico do sistema.

Obter propriedades de um tópico do sistema.
list_by_resource_group

Listar tópicos do sistema em um grupo de recursos.

Liste todos os tópicos do sistema em um grupo de recursos.
list_by_subscription

Listar tópicos do sistema em uma assinatura do Azure.

Liste todos os tópicos do sistema em uma assinatura do Azure.

begin_create_or_update

Criar um tópico do sistema.

Cria de forma assíncrona um novo tópico do sistema com os parâmetros especificados.

async begin_create_or_update(resource_group_name: str, system_topic_name: str, system_topic_info: SystemTopic, **kwargs: Any) -> AsyncLROPoller[SystemTopic]

Parâmetros

resource_group_name
str
Obrigatório

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

system_topic_name
str
Obrigatório

Nome do tópico do sistema.

system_topic_info
SystemTopic
Obrigatório

Informações do Tópico do Sistema.

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 SystemTopic ou o resultado de cls(response)

Tipo de retorno

AsyncLROPoller[SystemTopic]

Exceções

HttpResponseError

begin_delete

Exclua um tópico do sistema.

Exclua o tópico do sistema existente.

async begin_delete(resource_group_name: str, system_topic_name: str, **kwargs: Any) -> AsyncLROPoller[None]

Parâmetros

resource_group_name
str
Obrigatório

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

system_topic_name
str
Obrigatório

Nome do tópico do sistema.

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

AsyncLROPoller[None]

Exceções

HttpResponseError

begin_update

Atualizar um tópico do sistema.

Atualiza de forma assíncrona um tópico do sistema com os parâmetros especificados.

async begin_update(resource_group_name: str, system_topic_name: str, system_topic_update_parameters: SystemTopicUpdateParameters, **kwargs: Any) -> AsyncLROPoller[SystemTopic]

Parâmetros

resource_group_name
str
Obrigatório

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

system_topic_name
str
Obrigatório

Nome do tópico do sistema.

system_topic_update_parameters
SystemTopicUpdateParameters
Obrigatório

Informações de atualização do SystemTopic.

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 SystemTopic ou o resultado de cls(response)

Tipo de retorno

AsyncLROPoller[SystemTopic]

Exceções

HttpResponseError

get

Obter um tópico do sistema.

Obter propriedades de um tópico do sistema.

async get(resource_group_name: str, system_topic_name: str, **kwargs: Any) -> SystemTopic

Parâmetros

resource_group_name
str
Obrigatório

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

system_topic_name
str
Obrigatório

Nome do tópico do sistema.

cls
callable

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

Retornos

SystemTopic ou o resultado de cls(response)

Tipo de retorno

SystemTopic

Exceções

HttpResponseError

list_by_resource_group

Listar tópicos do sistema em um grupo de recursos.

Liste todos os tópicos do sistema em um grupo de recursos.

list_by_resource_group(resource_group_name: str, filter: str | None = None, top: int | None = None, **kwargs: Any) -> AsyncIterable[SystemTopicsListResult]

Parâmetros

resource_group_name
str
Obrigatório

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

filter
str
Obrigatório

A consulta usada para filtrar os resultados da pesquisa usando a sintaxe OData. A filtragem é permitida somente 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 SystemTopicsListResult ou o resultado de cls(response)

Tipo de retorno

AsyncItemPaged[SystemTopicsListResult]

Exceções

HttpResponseError

list_by_subscription

Listar tópicos do sistema em uma assinatura do Azure.

Liste todos os tópicos do sistema em uma assinatura do Azure.

list_by_subscription(filter: str | None = None, top: int | None = None, **kwargs: Any) -> AsyncIterable[SystemTopicsListResult]

Parâmetros

filter
str
Obrigatório

A consulta usada para filtrar os resultados da pesquisa usando a sintaxe OData. A filtragem é permitida somente 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 SystemTopicsListResult ou o resultado de cls(response)

Tipo de retorno

AsyncItemPaged[SystemTopicsListResult]

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