Compartir a través de


TopicsOperations Clase

TemasOperaciones operaciones asincrónicas.

No debe crear instancias de esta clase directamente. En su lugar, debe crear una instancia de cliente que le cree una instancia y la adjunte como un atributo.

Herencia
builtins.object
TopicsOperations

Constructor

TopicsOperations(client, config, serializer, deserializer)

Parámetros

client
Requerido

Cliente para solicitudes de servicio.

config
Requerido

Configuración del cliente de servicio.

serializer
Requerido

Serializador de modelo de objetos.

deserializer
Requerido

Deserializador de modelo de objetos.

Variables

models

Alias para modelar clases usadas en este grupo de operaciones.

Métodos

begin_create_or_update

Cree un tema.

Crea de forma asincrónica un nuevo tema con los parámetros especificados.

begin_delete

Elimine un tema.

Elimine el tema existente.

begin_regenerate_key

Vuelva a generar la clave de un tema.

Vuelva a generar una clave de acceso compartido para un tema.

begin_update

Actualizar un tema.

Actualiza de forma asincrónica un tema con los parámetros especificados.

get

Obtenga un tema.

Obtiene las propiedades de un tema.

list_by_resource_group

Enumera los temas de un grupo de recursos.

Enumere todos los temas de un grupo de recursos.

list_by_subscription

Enumera los temas de una suscripción de Azure.

Enumere todos los temas de una suscripción de Azure.

list_event_types

Enumerar tipos de eventos de tema.

Enumerar los tipos de eventos de un tema.

list_shared_access_keys

Enumera las claves de un tema.

Enumere las dos claves usadas para publicar en un tema.

begin_create_or_update

Cree un tema.

Crea de forma asincrónica un nuevo tema con los parámetros especificados.

async begin_create_or_update(resource_group_name: str, topic_name: str, topic_info: Topic, **kwargs: Any) -> AsyncLROPoller[Topic]

Parámetros

resource_group_name
str
Requerido

Nombre del grupo de recursos dentro de la suscripción del usuario.

topic_name
str
Requerido

Nombre del tema.

topic_info
Topic
Requerido

Información del tema.

cls
callable

Un tipo o función personalizados que se pasarán a la respuesta directa

continuation_token
str

Token de continuación para reiniciar un sondeo desde un estado guardado.

polling
bool o AsyncPollingMethod

De forma predeterminada, el método de sondeo será AsyncARMPolling. Pase False para que esta operación no sondee o pase su propio objeto de sondeo inicializado para una estrategia de sondeo personal.

polling_interval
int

Tiempo de espera predeterminado entre dos sondeos para las operaciones LRO si no hay ningún encabezado Retry-After presente.

Devoluciones

Instancia de AsyncLROPoller que devuelve Topic o el resultado de cls(response)

Tipo de valor devuelto

Excepciones

begin_delete

Elimine un tema.

Elimine el tema existente.

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

Parámetros

resource_group_name
str
Requerido

Nombre del grupo de recursos dentro de la suscripción del usuario.

topic_name
str
Requerido

Nombre del tema.

cls
callable

Un tipo o función personalizados que se pasarán a la respuesta directa

continuation_token
str

Token de continuación para reiniciar un sondeo desde un estado guardado.

polling
bool o AsyncPollingMethod

De forma predeterminada, el método de sondeo será AsyncARMPolling. Pase False para que esta operación no sondee o pase su propio objeto de sondeo inicializado para una estrategia de sondeo personal.

polling_interval
int

Tiempo de espera predeterminado entre dos sondeos para las operaciones LRO si no hay ningún encabezado Retry-After presente.

Devoluciones

Instancia de AsyncLROPoller que devuelve None o el resultado de cls(response)

Tipo de valor devuelto

Excepciones

begin_regenerate_key

Vuelva a generar la clave de un tema.

Vuelva a generar una clave de acceso compartido para un tema.

async begin_regenerate_key(resource_group_name: str, topic_name: str, regenerate_key_request: TopicRegenerateKeyRequest, **kwargs: Any) -> AsyncLROPoller[TopicSharedAccessKeys]

Parámetros

resource_group_name
str
Requerido

Nombre del grupo de recursos dentro de la suscripción del usuario.

topic_name
str
Requerido

Nombre del tema.

regenerate_key_request
TopicRegenerateKeyRequest
Requerido

Cuerpo de la solicitud para regenerar la clave.

cls
callable

Un tipo o función personalizados que se pasarán a la respuesta directa

continuation_token
str

Token de continuación para reiniciar un sondeo desde un estado guardado.

polling
bool o AsyncPollingMethod

De forma predeterminada, el método de sondeo será AsyncARMPolling. Pase False para que esta operación no sondee o pase su propio objeto de sondeo inicializado para una estrategia de sondeo personal.

polling_interval
int

Tiempo de espera predeterminado entre dos sondeos para las operaciones LRO si no hay ningún encabezado Retry-After presente.

Devoluciones

Instancia de AsyncLROPoller que devuelve TopicSharedAccessKeys o el resultado de cls(response)

Tipo de valor devuelto

Excepciones

begin_update

Actualizar un tema.

Actualiza de forma asincrónica un tema con los parámetros especificados.

async begin_update(resource_group_name: str, topic_name: str, topic_update_parameters: TopicUpdateParameters, **kwargs: Any) -> AsyncLROPoller[Topic]

Parámetros

resource_group_name
str
Requerido

Nombre del grupo de recursos dentro de la suscripción del usuario.

topic_name
str
Requerido

Nombre del tema.

topic_update_parameters
TopicUpdateParameters
Requerido

Información de actualización de temas.

cls
callable

Un tipo o función personalizados que se pasarán a la respuesta directa

continuation_token
str

Token de continuación para reiniciar un sondeo desde un estado guardado.

polling
bool o AsyncPollingMethod

De forma predeterminada, el método de sondeo será AsyncARMPolling. Pase False para que esta operación no sondee o pase su propio objeto de sondeo inicializado para una estrategia de sondeo personal.

polling_interval
int

Tiempo de espera predeterminado entre dos sondeos para las operaciones LRO si no hay ningún encabezado Retry-After presente.

Devoluciones

Instancia de AsyncLROPoller que devuelve Topic o el resultado de cls(response)

Tipo de valor devuelto

Excepciones

get

Obtenga un tema.

Obtiene las propiedades de un tema.

async get(resource_group_name: str, topic_name: str, **kwargs: Any) -> Topic

Parámetros

resource_group_name
str
Requerido

Nombre del grupo de recursos dentro de la suscripción del usuario.

topic_name
str
Requerido

Nombre del tema.

cls
callable

Un tipo o función personalizados que se pasarán a la respuesta directa

Devoluciones

Tema o resultado de cls(response)

Tipo de valor devuelto

Excepciones

list_by_resource_group

Enumera los temas de un grupo de recursos.

Enumere todos los temas de un grupo de recursos.

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

Parámetros

resource_group_name
str
Requerido

Nombre del grupo de recursos dentro de la suscripción del usuario.

filter
str
Requerido

Consulta usada para filtrar los resultados de búsqueda mediante la sintaxis de OData. El filtrado solo se permite en la propiedad "name" y con un número limitado de operaciones de OData. Estas operaciones son: la función 'contains' así como las siguientes operaciones lógicas: no y, o, eq (para igual) y ne (para no igual). No se admiten operaciones aritméticas. A continuación se muestra un ejemplo de filtro válido: $filter=contains(namE, 'PATTERN') y name ne 'PATTERN-1'. A continuación no se muestra un ejemplo de filtro válido: $filter=location eq 'westus'. El valor predeterminado es Ninguno.

top
int
Requerido

Número de resultados que se devolverán por página para la operación de lista. El intervalo válido para el parámetro superior es de 1 a 100. Si no se especifica, el número predeterminado de resultados que se devolverá es de 20 elementos por página. El valor predeterminado es Ninguno.

cls
callable

Un tipo o función personalizados que se pasarán a la respuesta directa

Devoluciones

Iterador como una instancia de TopicsListResult o el resultado de cls(response)

Tipo de valor devuelto

Excepciones

list_by_subscription

Enumera los temas de una suscripción de Azure.

Enumere todos los temas de una suscripción de Azure.

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

Parámetros

filter
str
Requerido

Consulta usada para filtrar los resultados de búsqueda mediante la sintaxis de OData. El filtrado solo se permite en la propiedad "name" y con un número limitado de operaciones de OData. Estas operaciones son: la función 'contains' así como las siguientes operaciones lógicas: no y, o, eq (para igual) y ne (para no igual). No se admiten operaciones aritméticas. A continuación se muestra un ejemplo de filtro válido: $filter=contains(namE, 'PATTERN') y name ne 'PATTERN-1'. A continuación no se muestra un ejemplo de filtro válido: $filter=location eq 'westus'. El valor predeterminado es Ninguno.

top
int
Requerido

Número de resultados que se devolverán por página para la operación de lista. El intervalo válido para el parámetro superior es de 1 a 100. Si no se especifica, el número predeterminado de resultados que se devolverá es de 20 elementos por página. El valor predeterminado es Ninguno.

cls
callable

Un tipo o función personalizados que se pasarán a la respuesta directa

Devoluciones

Iterador como una instancia de TopicsListResult o el resultado de cls(response)

Tipo de valor devuelto

Excepciones

list_event_types

Enumerar tipos de eventos de tema.

Enumerar los tipos de eventos de un tema.

list_event_types(resource_group_name: str, provider_namespace: str, resource_type_name: str, resource_name: str, **kwargs: Any) -> AsyncIterable[EventTypesListResult]

Parámetros

resource_group_name
str
Requerido

Nombre del grupo de recursos dentro de la suscripción del usuario.

provider_namespace
str
Requerido

Espacio de nombres del proveedor del tema.

resource_type_name
str
Requerido

Nombre del tipo de tema.

resource_name
str
Requerido

Nombre del tema.

cls
callable

Un tipo o función personalizados que se pasarán a la respuesta directa

Devoluciones

Iterador como una instancia de EventTypesListResult o el resultado de cls(response)

Tipo de valor devuelto

Excepciones

list_shared_access_keys

Enumera las claves de un tema.

Enumere las dos claves usadas para publicar en un tema.

async list_shared_access_keys(resource_group_name: str, topic_name: str, **kwargs: Any) -> TopicSharedAccessKeys

Parámetros

resource_group_name
str
Requerido

Nombre del grupo de recursos dentro de la suscripción del usuario.

topic_name
str
Requerido

Nombre del tema.

cls
callable

Un tipo o función personalizados que se pasarán a la respuesta directa

Devoluciones

TopicSharedAccessKeys o el resultado de cls(response)

Tipo de valor devuelto

Excepciones

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