TopicsOperations 類別
- 繼承
-
builtins.objectTopicsOperations
建構函式
TopicsOperations(*args, **kwargs)
方法
begin_create_or_update |
建立主題。 以非同步方式建立具有指定參數的新主題。 |
begin_delete |
刪除主題。 刪除現有的主題。 |
begin_regenerate_key |
重新產生主題的金鑰。 重新產生主題的共用存取金鑰。 |
begin_update |
更新主題。 以非同步方式更新具有指定參數的主題。 |
get |
取得主題。 取得主題的屬性。 |
list_by_resource_group |
列出資源群組下的主題。 列出資源群組下的所有主題。 |
list_by_subscription |
列出 Azure 訂用帳戶下的主題。 列出 Azure 訂用帳戶下的所有主題。 |
list_event_types |
列出主題事件種類。 列出主題的事件種類。 |
list_shared_access_keys |
列出主題的索引鍵。 列出用來發佈至主題的兩個索引鍵。 |
begin_create_or_update
建立主題。
以非同步方式建立具有指定參數的新主題。
async begin_create_or_update(resource_group_name: str, topic_name: str, topic_info: _models.Topic, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.Topic]
參數
- content_type
- str
Body 參數內容類型。 已知值為:'application/json'。 預設值為 [無]。
- cls
- callable
將傳遞直接回應的自訂類型或函式
- continuation_token
- str
從已儲存狀態重新開機輪詢器的接續權杖。
- polling
- bool 或 AsyncPollingMethod
根據預設,您的輪詢方法會是 AsyncARMPolling。 針對此作業傳入 False,以不輪詢,或傳入您自己的初始化輪詢物件,以取得個人輪詢策略。
- polling_interval
- int
如果沒有Retry-After標頭,則為 LRO 作業的兩個輪詢之間的預設等候時間。
傳回
AsyncLROPoller 的實例,會傳回 topic 或 cls (回應的結果)
傳回類型
例外狀況
begin_delete
刪除主題。
刪除現有的主題。
async begin_delete(resource_group_name: str, topic_name: str, **kwargs: Any) -> AsyncLROPoller[None]
參數
- cls
- callable
將傳遞直接回應的自訂類型或函式
- continuation_token
- str
從已儲存狀態重新開機輪詢器的接續權杖。
- polling
- bool 或 AsyncPollingMethod
根據預設,您的輪詢方法會是 AsyncARMPolling。 針對此作業傳入 False,以不輪詢,或傳入您自己的初始化輪詢物件,以取得個人輪詢策略。
- polling_interval
- int
如果沒有Retry-After標頭,則為 LRO 作業的兩個輪詢之間的預設等候時間。
傳回
AsyncLROPoller 的實例,會傳回 None 或 cls (回應的結果)
傳回類型
例外狀況
begin_regenerate_key
重新產生主題的金鑰。
重新產生主題的共用存取金鑰。
async begin_regenerate_key(resource_group_name: str, topic_name: str, regenerate_key_request: _models.TopicRegenerateKeyRequest, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.TopicSharedAccessKeys]
參數
- regenerate_key_request
- TopicRegenerateKeyRequest 或 IO
要求本文以重新產生金鑰。 這是 TopicRegenerateKeyRequest 類型或 IO 類型。 必要。
- content_type
- str
Body 參數內容類型。 已知值為:'application/json'。 預設值為 [無]。
- cls
- callable
將傳遞直接回應的自訂類型或函式
- continuation_token
- str
從已儲存狀態重新開機輪詢器的接續權杖。
- polling
- bool 或 AsyncPollingMethod
根據預設,您的輪詢方法會是 AsyncARMPolling。 針對此作業傳入 False,以不輪詢,或傳入您自己的初始化輪詢物件,以取得個人輪詢策略。
- polling_interval
- int
如果沒有Retry-After標頭,則為 LRO 作業的兩個輪詢之間的預設等候時間。
傳回
AsyncLROPoller 的實例,會傳回 TopicSharedAccessKeys 或 cls (回應的結果)
傳回類型
例外狀況
begin_update
更新主題。
以非同步方式更新具有指定參數的主題。
async begin_update(resource_group_name: str, topic_name: str, topic_update_parameters: _models.TopicUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.Topic]
參數
- topic_update_parameters
- TopicUpdateParameters 或 IO
主題更新資訊。 這是 TopicUpdateParameters 類型或 IO 類型。 必要。
- content_type
- str
Body 參數內容類型。 已知值為:'application/json'。 預設值為 [無]。
- cls
- callable
將傳遞直接回應的自訂類型或函式
- continuation_token
- str
從已儲存狀態重新開機輪詢器的接續權杖。
- polling
- bool 或 AsyncPollingMethod
根據預設,您的輪詢方法會是 AsyncARMPolling。 針對此作業傳入 False,以不輪詢,或傳入您自己的初始化輪詢物件,以取得個人輪詢策略。
- polling_interval
- int
如果沒有Retry-After標頭,則為 LRO 作業的兩個輪詢之間的預設等候時間。
傳回
AsyncLROPoller 的實例,會傳回 topic 或 cls (回應的結果)
傳回類型
例外狀況
get
取得主題。
取得主題的屬性。
async get(resource_group_name: str, topic_name: str, **kwargs: Any) -> Topic
參數
- cls
- callable
將傳遞直接回應的自訂類型或函式
傳回
cls (回應)
傳回類型
例外狀況
list_by_resource_group
列出資源群組下的主題。
列出資源群組下的所有主題。
list_by_resource_group(resource_group_name: str, filter: str | None = None, top: int | None = None, **kwargs: Any) -> AsyncIterable[Topic]
參數
- filter
- str
用來使用 OData 語法篩選搜尋結果的查詢。 僅允許在 'name' 屬性上篩選,且 OData 作業數目有限。 這些作業包括:'contains' 函式以及下列邏輯作業:not、and、 或 eq (for equal) ,而 ne (for not equal) 。 不支援算數運算。 以下是有效的篩選範例:$filter=包含 (namE、'PATTERN') 和名稱 ne 'PATTERN-1'。 下列不是有效的篩選範例:$filter=location eq 'westus'。 預設值為 [無]。
- cls
- callable
將傳遞直接回應的自訂類型或函式
傳回
反覆運算器,例如 Topic 實例或 cls 的結果 (回應)
傳回類型
例外狀況
list_by_subscription
列出 Azure 訂用帳戶下的主題。
列出 Azure 訂用帳戶下的所有主題。
list_by_subscription(filter: str | None = None, top: int | None = None, **kwargs: Any) -> AsyncIterable[Topic]
參數
- filter
- str
用來使用 OData 語法篩選搜尋結果的查詢。 僅允許在 'name' 屬性上篩選,且 OData 作業數目有限。 這些作業包括:'contains' 函式以及下列邏輯作業:not、and、 或 eq (for equal) ,而 ne (for not equal) 。 不支援算數運算。 以下是有效的篩選範例:$filter=包含 (namE、'PATTERN') 和名稱 ne 'PATTERN-1'。 下列不是有效的篩選範例:$filter=location eq 'westus'。 預設值為 [無]。
- cls
- callable
將傳遞直接回應的自訂類型或函式
傳回
反覆運算器,例如 Topic 實例或 cls 的結果 (回應)
傳回類型
例外狀況
list_event_types
列出主題事件種類。
列出主題的事件種類。
list_event_types(resource_group_name: str, provider_namespace: str, resource_type_name: str, resource_name: str, **kwargs: Any) -> AsyncIterable[EventType]
參數
- cls
- callable
將傳遞直接回應的自訂類型或函式
傳回
反覆運算器,例如 EventType 的實例或 cls 的結果 (回應)
傳回類型
例外狀況
list_shared_access_keys
列出主題的索引鍵。
列出用來發佈至主題的兩個索引鍵。
async list_shared_access_keys(resource_group_name: str, topic_name: str, **kwargs: Any) -> TopicSharedAccessKeys
參數
- cls
- callable
將傳遞直接回應的自訂類型或函式
傳回
TopicSharedAccessKeys 或 cls (回應的結果)
傳回類型
例外狀況
屬性
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'>
意見反應
https://aka.ms/ContentUserFeedback。
即將登場:在 2024 年,我們將逐步淘汰 GitHub 問題作為內容的意見反應機制,並將它取代為新的意見反應系統。 如需詳細資訊,請參閱:提交並檢視相關的意見反應