Freigeben über


TopicsOperations Klasse

Warnung

Instanziieren Sie diese Klasse NICHT direkt.

Stattdessen sollten Sie auf die folgenden Vorgänge zugreifen:

EventGridManagementClient's

<xref:topics> -Attribut.

Vererbung
builtins.object
TopicsOperations

Konstruktor

TopicsOperations(*args, **kwargs)

Methoden

begin_create_or_update

Erstellen Sie ein Thema.

Erstellt asynchron ein neues Thema mit den angegebenen Parametern.

begin_delete

Löschen sie ein Thema.

Löschen Sie vorhandenes Thema.

begin_regenerate_key

Generieren Sie den Schlüssel für ein Thema neu.

Generieren Sie einen freigegebenen Zugriffsschlüssel für ein Thema.

begin_update

Aktualisieren sie ein Thema.

Aktualisiert asynchron ein Thema mit den angegebenen Parametern.

get

Rufen Sie ein Thema ab.

Ruft Eigenschaften eines Themas ab.

list_by_resource_group

Listen Sie Themen unter einer Ressourcengruppe auf.

Listet alle Themen unter einer Ressourcengruppe auf.

list_by_subscription

Listen Sie Themen unter einem Azure-Abonnement auf.

Listet alle Themen unter einem Azure-Abonnement auf.

list_event_types

Auflisten von Ereignistypen für Themen.

Auflisten von Ereignistypen für ein Thema.

list_shared_access_keys

Auflisten von Schlüsseln für ein Thema.

Listen Sie die beiden Schlüssel auf, die zum Veröffentlichen in einem Thema verwendet werden.

begin_create_or_update

Erstellen Sie ein Thema.

Erstellt asynchron ein neues Thema mit den angegebenen Parametern.

begin_create_or_update(resource_group_name: str, topic_name: str, topic_info: _models.Topic, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.Topic]

Parameter

resource_group_name
str
Erforderlich

Der Name der Ressourcengruppe im Abonnement des Benutzers. Erforderlich.

topic_name
str
Erforderlich

Name des Themas. Erforderlich.

topic_info
Topic oder IO
Erforderlich

Themeninformationen. Ist entweder ein Topic-Typ oder ein E/A-Typ. Erforderlich.

content_type
str

Textparameter-Inhaltstyp. Bekannte Werte sind : "application/json". Der Standardwert ist Keine.

cls
callable

Ein benutzerdefinierter Typ oder eine benutzerdefinierte Funktion, die die direkte Antwort übergeben wird

continuation_token
str

Ein Fortsetzungstoken zum Neustarten eines Pollers aus einem gespeicherten Zustand.

polling
bool oder PollingMethod

Standardmäßig lautet die Abfragemethode ARMPolling. Übergeben Sie False, damit dieser Vorgang nicht abruft, oder übergeben Sie Ihr eigenes initialisiertes Abfrageobjekt für eine persönliche Abfragestrategie.

polling_interval
int

Standardwartezeit zwischen zwei Abfragen für LRO-Vorgänge, wenn kein Retry-After-Header vorhanden ist.

Gibt zurück

Eine instance von LROPoller, die entweder Topic oder das Ergebnis von cls(response) zurückgibt.

Rückgabetyp

Ausnahmen

begin_delete

Löschen sie ein Thema.

Löschen Sie vorhandenes Thema.

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

Parameter

resource_group_name
str
Erforderlich

Der Name der Ressourcengruppe im Abonnement des Benutzers. Erforderlich.

topic_name
str
Erforderlich

Name des Themas. Erforderlich.

cls
callable

Ein benutzerdefinierter Typ oder eine benutzerdefinierte Funktion, die die direkte Antwort übergeben wird

continuation_token
str

Ein Fortsetzungstoken zum Neustarten eines Pollers aus einem gespeicherten Zustand.

polling
bool oder PollingMethod

Standardmäßig lautet die Abfragemethode ARMPolling. Übergeben Sie False, damit dieser Vorgang nicht abruft, oder übergeben Sie Ihr eigenes initialisiertes Abfrageobjekt für eine persönliche Abfragestrategie.

polling_interval
int

Standardwartezeit zwischen zwei Abfragen für LRO-Vorgänge, wenn kein Retry-After-Header vorhanden ist.

Gibt zurück

Ein instance von LROPoller, der entweder None oder das Ergebnis von cls(response) zurückgibt.

Rückgabetyp

Ausnahmen

begin_regenerate_key

Generieren Sie den Schlüssel für ein Thema neu.

Generieren Sie einen freigegebenen Zugriffsschlüssel für ein Thema.

begin_regenerate_key(resource_group_name: str, topic_name: str, regenerate_key_request: _models.TopicRegenerateKeyRequest, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.TopicSharedAccessKeys]

Parameter

resource_group_name
str
Erforderlich

Der Name der Ressourcengruppe im Abonnement des Benutzers. Erforderlich.

topic_name
str
Erforderlich

Name des Themas. Erforderlich.

regenerate_key_request
TopicRegenerateKeyRequest oder IO
Erforderlich

Anforderungstext zum Generieren des Schlüssels. Ist entweder ein TopicRegenerateKeyRequest-Typ oder ein E/A-Typ. Erforderlich.

content_type
str

Textparameter-Inhaltstyp. Bekannte Werte sind : "application/json". Der Standardwert ist Keine.

cls
callable

Ein benutzerdefinierter Typ oder eine benutzerdefinierte Funktion, die die direkte Antwort übergeben wird

continuation_token
str

Ein Fortsetzungstoken zum Neustarten eines Pollers aus einem gespeicherten Zustand.

polling
bool oder PollingMethod

Standardmäßig lautet die Abfragemethode ARMPolling. Übergeben Sie False, damit dieser Vorgang nicht abruft, oder übergeben Sie Ihr eigenes initialisiertes Abfrageobjekt für eine persönliche Abfragestrategie.

polling_interval
int

Standardwartezeit zwischen zwei Abfragen für LRO-Vorgänge, wenn kein Retry-After-Header vorhanden ist.

Gibt zurück

Ein instance von LROPoller, der entweder TopicSharedAccessKeys oder das Ergebnis von cls(response) zurückgibt.

Rückgabetyp

Ausnahmen

begin_update

Aktualisieren sie ein Thema.

Aktualisiert asynchron ein Thema mit den angegebenen Parametern.

begin_update(resource_group_name: str, topic_name: str, topic_update_parameters: _models.TopicUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.Topic]

Parameter

resource_group_name
str
Erforderlich

Der Name der Ressourcengruppe im Abonnement des Benutzers. Erforderlich.

topic_name
str
Erforderlich

Name des Themas. Erforderlich.

topic_update_parameters
TopicUpdateParameters oder IO
Erforderlich

Informationen zu Themenaktualisierungen. Ist entweder ein TopicUpdateParameters-Typ oder ein E/A-Typ. Erforderlich.

content_type
str

Textparameter-Inhaltstyp. Bekannte Werte sind : "application/json". Der Standardwert ist Keine.

cls
callable

Ein benutzerdefinierter Typ oder eine benutzerdefinierte Funktion, die die direkte Antwort übergeben wird

continuation_token
str

Ein Fortsetzungstoken zum Neustarten eines Pollers aus einem gespeicherten Zustand.

polling
bool oder PollingMethod

Standardmäßig lautet die Abfragemethode ARMPolling. Übergeben Sie False, damit dieser Vorgang nicht abruft, oder übergeben Sie Ihr eigenes initialisiertes Abfrageobjekt für eine persönliche Abfragestrategie.

polling_interval
int

Standardwartezeit zwischen zwei Abfragen für LRO-Vorgänge, wenn kein Retry-After-Header vorhanden ist.

Gibt zurück

Eine instance von LROPoller, die entweder Topic oder das Ergebnis von cls(response) zurückgibt.

Rückgabetyp

Ausnahmen

get

Rufen Sie ein Thema ab.

Ruft Eigenschaften eines Themas ab.

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

Parameter

resource_group_name
str
Erforderlich

Der Name der Ressourcengruppe im Abonnement des Benutzers. Erforderlich.

topic_name
str
Erforderlich

Name des Themas. Erforderlich.

cls
callable

Ein benutzerdefinierter Typ oder eine benutzerdefinierte Funktion, die die direkte Antwort übergeben wird

Gibt zurück

Thema oder das Ergebnis von cls(response)

Rückgabetyp

Ausnahmen

list_by_resource_group

Listen Sie Themen unter einer Ressourcengruppe auf.

Listet alle Themen unter einer Ressourcengruppe auf.

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

Parameter

resource_group_name
str
Erforderlich

Der Name der Ressourcengruppe im Abonnement des Benutzers. Erforderlich.

filter
str
Erforderlich

Die Abfrage, die zum Filtern der Suchergebnisse mithilfe der OData-Syntax verwendet wird. Das Filtern ist nur für die Eigenschaft "name" und mit einer begrenzten Anzahl von OData-Vorgängen zulässig. Diese Vorgänge sind: die "contains"-Funktion sowie die folgenden logischen Vorgänge: not, and, or, eq (for equal), and ne (for not equal). Es werden keine arithmetischen Vorgänge unterstützt. Es folgt ein gültiges Filterbeispiel: $filter=contains(namE, 'PATTERN') und name ne 'PATTERN-1'. Das Folgende ist kein gültiges Filterbeispiel: $filter=location eq 'westus'. Der Standardwert ist Keine.

top
int
Erforderlich

Die Anzahl der Ergebnisse, die pro Seite für den Listenvorgang zurückgegeben werden sollen. Der gültige Bereich für den obersten Parameter ist 1 bis 100. Falls nicht angegeben, beträgt die Standardanzahl der zurückgegebenen Ergebnisse 20 Elemente pro Seite. Der Standardwert ist Keine.

cls
callable

Ein benutzerdefinierter Typ oder eine benutzerdefinierte Funktion, die die direkte Antwort übergeben wird

Gibt zurück

Ein Iterator wie instance eines Themas oder des Ergebnisses von cls(response)

Rückgabetyp

Ausnahmen

list_by_subscription

Listen Sie Themen unter einem Azure-Abonnement auf.

Listet alle Themen unter einem Azure-Abonnement auf.

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

Parameter

filter
str
Erforderlich

Die Abfrage, die zum Filtern der Suchergebnisse mithilfe der OData-Syntax verwendet wird. Das Filtern ist nur für die Eigenschaft "name" und mit einer begrenzten Anzahl von OData-Vorgängen zulässig. Diese Vorgänge sind: die "contains"-Funktion sowie die folgenden logischen Vorgänge: not, and, or, eq (for equal), and ne (for not equal). Es werden keine arithmetischen Vorgänge unterstützt. Es folgt ein gültiges Filterbeispiel: $filter=contains(namE, 'PATTERN') und name ne 'PATTERN-1'. Das Folgende ist kein gültiges Filterbeispiel: $filter=location eq 'westus'. Der Standardwert ist Keine.

top
int
Erforderlich

Die Anzahl der Ergebnisse, die pro Seite für den Listenvorgang zurückgegeben werden sollen. Der gültige Bereich für den obersten Parameter ist 1 bis 100. Falls nicht angegeben, beträgt die Standardanzahl der zurückgegebenen Ergebnisse 20 Elemente pro Seite. Der Standardwert ist Keine.

cls
callable

Ein benutzerdefinierter Typ oder eine benutzerdefinierte Funktion, die die direkte Antwort übergeben wird

Gibt zurück

Ein Iterator wie instance eines Themas oder des Ergebnisses von cls(response)

Rückgabetyp

Ausnahmen

list_event_types

Auflisten von Ereignistypen für Themen.

Auflisten von Ereignistypen für ein Thema.

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

Parameter

resource_group_name
str
Erforderlich

Der Name der Ressourcengruppe im Abonnement des Benutzers. Erforderlich.

provider_namespace
str
Erforderlich

Namespace des Anbieters des Themas. Erforderlich.

resource_type_name
str
Erforderlich

Name des Thementyps. Erforderlich.

resource_name
str
Erforderlich

Name des Themas. Erforderlich.

cls
callable

Ein benutzerdefinierter Typ oder eine benutzerdefinierte Funktion, die die direkte Antwort übergeben wird

Gibt zurück

Ein Iterator wie instance von EventType oder das Ergebnis von cls(response)

Rückgabetyp

Ausnahmen

list_shared_access_keys

Auflisten von Schlüsseln für ein Thema.

Listen Sie die beiden Schlüssel auf, die zum Veröffentlichen in einem Thema verwendet werden.

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

Parameter

resource_group_name
str
Erforderlich

Der Name der Ressourcengruppe im Abonnement des Benutzers. Erforderlich.

topic_name
str
Erforderlich

Name des Themas. Erforderlich.

cls
callable

Ein benutzerdefinierter Typ oder eine benutzerdefinierte Funktion, die die direkte Antwort übergeben wird

Gibt zurück

TopicSharedAccessKeys oder das Ergebnis von cls(response)

Rückgabetyp

Ausnahmen

Attribute

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