TopicsOperations Klass
TopicsOperations asynkrona åtgärder.
Du bör inte instansiera den här klassen direkt. I stället bör du skapa en klientinstans som instansierar den åt dig och bifogar den som ett attribut.
- Arv
-
builtins.objectTopicsOperations
Konstruktor
TopicsOperations(client, config, serializer, deserializer)
Parametrar
- client
Klient för tjänstbegäranden.
- config
Konfiguration av tjänstklient.
- serializer
En objektmodellserialiserare.
- deserializer
En deserialiserare för objektmodell.
Variabler
- models
Alias för modellklasser som används i den här åtgärdsgruppen.
Metoder
begin_create_or_update |
Skapa ett ämne. Asynkront skapar ett nytt ämne med de angivna parametrarna. |
begin_delete |
Ta bort ett ämne. Ta bort befintligt ämne. |
begin_regenerate_key |
Återskapa nyckeln för ett ämne. Återskapa en delad åtkomstnyckel för ett ämne. |
begin_update |
Uppdatera ett ämne. Asynkront uppdaterar ett ämne med de angivna parametrarna. |
get |
Hämta ett ämne. Hämta egenskaper för ett ämne. |
list_by_resource_group |
Lista ämnen under en resursgrupp. Visa en lista över alla ämnen under en resursgrupp. |
list_by_subscription |
Lista ämnen under en Azure-prenumeration. Visa en lista över alla ämnen under en Azure-prenumeration. |
list_event_types |
Lista ämneshändelsetyper. Lista händelsetyper för ett ämne. |
list_shared_access_keys |
Lista nycklar för ett ämne. Visa en lista över de två nycklar som används för att publicera till ett ämne. |
begin_create_or_update
Skapa ett ämne.
Asynkront skapar ett nytt ämne med de angivna parametrarna.
async begin_create_or_update(resource_group_name: str, topic_name: str, topic_info: Topic, **kwargs: Any) -> AsyncLROPoller[Topic]
Parametrar
- cls
- callable
En anpassad typ eller funktion som skickas direktsvaret
- continuation_token
- str
En fortsättningstoken för att starta om en poller från ett sparat tillstånd.
- polling
- bool eller AsyncPollingMethod
Som standard är avsökningsmetoden AsyncARMPolling. Skicka in Falskt för att den här åtgärden inte ska avsöka eller skicka in ditt eget initierade avsökningsobjekt för en personlig avsökningsstrategi.
- polling_interval
- int
Standardväntetid mellan två omröstningar för LRO-åtgärder om det inte finns någon Retry-After sidhuvud.
Returer
En instans av AsyncLROPoller som returnerar antingen Topic eller resultatet av cls(response)
Returtyp
Undantag
begin_delete
Ta bort ett ämne.
Ta bort befintligt ämne.
async begin_delete(resource_group_name: str, topic_name: str, **kwargs: Any) -> AsyncLROPoller[None]
Parametrar
- cls
- callable
En anpassad typ eller funktion som skickas direktsvaret
- continuation_token
- str
En fortsättningstoken för att starta om en poller från ett sparat tillstånd.
- polling
- bool eller AsyncPollingMethod
Som standard är avsökningsmetoden AsyncARMPolling. Skicka in Falskt för att den här åtgärden inte ska avsöka eller skicka in ditt eget initierade avsökningsobjekt för en personlig avsökningsstrategi.
- polling_interval
- int
Standardväntetid mellan två omröstningar för LRO-åtgärder om det inte finns någon Retry-After sidhuvud.
Returer
En instans av AsyncLROPoller som returnerar antingen None eller resultatet av cls(response)
Returtyp
Undantag
begin_regenerate_key
Återskapa nyckeln för ett ämne.
Återskapa en delad åtkomstnyckel för ett ämne.
async begin_regenerate_key(resource_group_name: str, topic_name: str, regenerate_key_request: TopicRegenerateKeyRequest, **kwargs: Any) -> AsyncLROPoller[TopicSharedAccessKeys]
Parametrar
- regenerate_key_request
- TopicRegenerateKeyRequest
Begär brödtext för att återskapa nyckeln.
- cls
- callable
En anpassad typ eller funktion som skickas direktsvaret
- continuation_token
- str
En fortsättningstoken för att starta om en poller från ett sparat tillstånd.
- polling
- bool eller AsyncPollingMethod
Som standard är avsökningsmetoden AsyncARMPolling. Skicka in Falskt för att den här åtgärden inte ska avsöka eller skicka in ditt eget initierade avsökningsobjekt för en personlig avsökningsstrategi.
- polling_interval
- int
Standardväntetid mellan två omröstningar för LRO-åtgärder om det inte finns någon Retry-After sidhuvud.
Returer
En instans av AsyncLROPoller som returnerar antingen TopicSharedAccessKeys eller resultatet av cls(response)
Returtyp
Undantag
begin_update
Uppdatera ett ämne.
Asynkront uppdaterar ett ämne med de angivna parametrarna.
async begin_update(resource_group_name: str, topic_name: str, topic_update_parameters: TopicUpdateParameters, **kwargs: Any) -> AsyncLROPoller[Topic]
Parametrar
- cls
- callable
En anpassad typ eller funktion som skickas direktsvaret
- continuation_token
- str
En fortsättningstoken för att starta om en poller från ett sparat tillstånd.
- polling
- bool eller AsyncPollingMethod
Som standard är avsökningsmetoden AsyncARMPolling. Skicka in Falskt för att den här åtgärden inte ska avsöka eller skicka in ditt eget initierade avsökningsobjekt för en personlig avsökningsstrategi.
- polling_interval
- int
Standardväntetid mellan två omröstningar för LRO-åtgärder om det inte finns någon Retry-After sidhuvud.
Returer
En instans av AsyncLROPoller som returnerar antingen Topic eller resultatet av cls(response)
Returtyp
Undantag
get
Hämta ett ämne.
Hämta egenskaper för ett ämne.
async get(resource_group_name: str, topic_name: str, **kwargs: Any) -> Topic
Parametrar
- cls
- callable
En anpassad typ eller funktion som skickas direktsvaret
Returer
Ämne eller resultatet av cls(svar)
Returtyp
Undantag
list_by_resource_group
Lista ämnen under en resursgrupp.
Visa en lista över alla ämnen under en resursgrupp.
list_by_resource_group(resource_group_name: str, filter: str | None = None, top: int | None = None, **kwargs: Any) -> AsyncIterable[TopicsListResult]
Parametrar
- filter
- str
Frågan som används för att filtrera sökresultaten med OData-syntax. Filtrering tillåts endast för egenskapen "name" och med ett begränsat antal OData-åtgärder. Dessa åtgärder är: funktionen "contains" samt följande logiska åtgärder: inte, och eller eq (för lika med) och ne (för inte lika med). Inga aritmetiska åtgärder stöds. Följande är ett giltigt filterexempel: $filter=contains(namE, 'PATTERN') och name ne 'PATTERN-1'. Följande är inte ett giltigt filterexempel: $filter=location eq 'westus'. Standardvärdet är Ingen.
- top
- int
Antalet resultat som ska returneras per sida för liståtgärden. Giltigt intervall för den översta parametern är 1 till 100. Om det inte anges är standardantalet resultat som ska returneras 20 objekt per sida. Standardvärdet är Ingen.
- cls
- callable
En anpassad typ eller funktion som skickas direktsvaret
Returer
En iterator som en instans av TopicsListResult eller resultatet av cls(response)
Returtyp
Undantag
list_by_subscription
Lista ämnen under en Azure-prenumeration.
Visa en lista över alla ämnen under en Azure-prenumeration.
list_by_subscription(filter: str | None = None, top: int | None = None, **kwargs: Any) -> AsyncIterable[TopicsListResult]
Parametrar
- filter
- str
Frågan som används för att filtrera sökresultaten med OData-syntax. Filtrering tillåts endast för egenskapen "name" och med ett begränsat antal OData-åtgärder. Dessa åtgärder är: funktionen "contains" samt följande logiska åtgärder: inte, och eller eq (för lika med) och ne (för inte lika med). Inga aritmetiska åtgärder stöds. Följande är ett giltigt filterexempel: $filter=contains(namE, 'PATTERN') och name ne 'PATTERN-1'. Följande är inte ett giltigt filterexempel: $filter=location eq 'westus'. Standardvärdet är Ingen.
- top
- int
Antalet resultat som ska returneras per sida för liståtgärden. Giltigt intervall för den översta parametern är 1 till 100. Om det inte anges är standardantalet resultat som ska returneras 20 objekt per sida. Standardvärdet är Ingen.
- cls
- callable
En anpassad typ eller funktion som skickas direktsvaret
Returer
En iterator som en instans av TopicsListResult eller resultatet av cls(response)
Returtyp
Undantag
list_event_types
Lista ämneshändelsetyper.
Lista händelsetyper för ett ämne.
list_event_types(resource_group_name: str, provider_namespace: str, resource_type_name: str, resource_name: str, **kwargs: Any) -> AsyncIterable[EventTypesListResult]
Parametrar
- cls
- callable
En anpassad typ eller funktion som skickas direktsvaret
Returer
En iterator som en instans av antingen EventTypesListResult eller resultatet av cls(response)
Returtyp
Undantag
list_shared_access_keys
Lista nycklar för ett ämne.
Visa en lista över de två nycklar som används för att publicera till ett ämne.
async list_shared_access_keys(resource_group_name: str, topic_name: str, **kwargs: Any) -> TopicSharedAccessKeys
Parametrar
- cls
- callable
En anpassad typ eller funktion som skickas direktsvaret
Returer
TopicSharedAccessKeys eller resultatet av cls(response)
Returtyp
Undantag
Attribut
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'>
Azure SDK for Python