EventSubscriptionsOperations 類別
- 繼承
-
builtins.objectEventSubscriptionsOperations
建構函式
EventSubscriptionsOperations(*args, **kwargs)
方法
begin_create_or_update |
建立或更新事件訂閱。 以非同步方式建立新的事件訂閱,或根據指定的範圍更新現有的事件訂閱。 |
begin_delete |
刪除事件訂用帳戶。 刪除現有的事件訂閱。 |
begin_update |
更新事件訂閱。 以非同步方式更新現有的事件訂閱。 |
get |
取得事件訂閱。 取得事件訂閱的屬性。 |
get_delivery_attributes |
取得事件訂閱的傳遞屬性。 取得事件訂閱的所有傳遞屬性。 |
get_full_url |
取得事件訂用帳戶的完整 URL。 取得事件訂用帳戶的完整端點 URL。 |
list_by_domain_topic |
列出特定網域主題的所有事件訂用帳戶。 列出已針對特定網域主題建立的所有事件訂用帳戶。 |
list_by_resource |
列出所有事件訂用帳戶。 列出已針對特定資源建立的所有事件訂用帳戶。 |
list_global_by_resource_group |
列出 Azure 訂用帳戶和資源群組下的所有全域事件訂用帳戶。 列出特定 Azure 訂用帳戶和資源群組下的所有全域事件訂用帳戶。 |
list_global_by_resource_group_for_topic_type |
列出資源群組下的所有全域事件訂用帳戶,以取得主題類型。 列出資源群組下的特定主題類型的所有全域事件訂用帳戶。 |
list_global_by_subscription |
取得 Azure 訂用帳戶下所有全域事件訂用帳戶的匯總清單。 列出特定 Azure 訂用帳戶下的所有匯總全域事件訂用帳戶。 |
list_global_by_subscription_for_topic_type |
列出主題類型的所有全域事件訂閱。 列出 Azure 訂用帳戶下的所有全域事件訂用帳戶,以取得主題類型。 |
list_regional_by_resource_group |
列出 Azure 訂用帳戶和資源群組下的所有區域事件訂用帳戶。 列出特定 Azure 訂用帳戶和資源群組下指定位置的所有事件訂用帳戶。 |
list_regional_by_resource_group_for_topic_type |
列出主題類型之 Azure 訂用帳戶和資源群組下的所有區域事件訂用帳戶。 列出特定 Azure 訂用帳戶和資源群組和主題類型下指定位置的所有事件訂用帳戶。 |
list_regional_by_subscription |
列出 Azure 訂用帳戶下的所有區域事件訂用帳戶。 列出特定 Azure 訂用帳戶下指定位置的所有事件訂用帳戶。 |
list_regional_by_subscription_for_topic_type |
列出 Azure 訂用帳戶下的所有區域事件訂用帳戶,以取得主題類型。 列出特定 Azure 訂用帳戶和主題類型下指定位置的所有事件訂用帳戶。 |
begin_create_or_update
建立或更新事件訂閱。
以非同步方式建立新的事件訂閱,或根據指定的範圍更新現有的事件訂閱。
async begin_create_or_update(scope: str, event_subscription_name: str, event_subscription_info: _models.EventSubscription, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.EventSubscription]
參數
- scope
- str
必須建立或更新事件訂閱的資源識別碼。 範圍可以是訂用帳戶、資源群組或屬於資源提供者命名空間的最上層資源,或是 EventGrid 主題。 例如,針對資源群組使用 '/subscriptions/{subscriptionId}/' 作為訂用帳戶 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' 和 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' 作為資源,而 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' 代表 EventGrid 主題。 必要。
- event_subscription_info
- EventSubscription 或 IO
包含目的地和篩選資訊的事件訂閱屬性。 這是 EventSubscription 類型或 IO 類型。 必要。
- content_type
- str
Body 參數內容類型。 已知值為:'application/json'。 預設值為 [無]。
- cls
- callable
將傳遞直接回應的自訂類型或函式
- continuation_token
- str
從已儲存狀態重新開機輪詢器的接續權杖。
- polling
- bool 或 AsyncPollingMethod
根據預設,您的輪詢方法會是 AsyncARMPolling。 針對此作業傳入 False,以不輪詢,或傳入您自己的初始化輪詢物件,以取得個人輪詢策略。
- polling_interval
- int
如果沒有Retry-After標頭,則為 LRO 作業的兩個輪詢之間的預設等候時間。
傳回
AsyncLROPoller 的實例,會傳回 EventSubscription 或 cls 的結果 (回應)
傳回類型
例外狀況
begin_delete
刪除事件訂用帳戶。
刪除現有的事件訂閱。
async begin_delete(scope: str, event_subscription_name: str, **kwargs: Any) -> AsyncLROPoller[None]
參數
- scope
- str
事件訂閱的範圍。 範圍可以是訂用帳戶、資源群組或屬於資源提供者命名空間的最上層資源,或是 EventGrid 主題。 例如,針對資源群組使用 '/subscriptions/{subscriptionId}/' 作為訂用帳戶 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' 和 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' 作為資源,而 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' 代表 EventGrid 主題。 必要。
- cls
- callable
將傳遞直接回應的自訂類型或函式
- continuation_token
- str
從已儲存狀態重新開機輪詢器的接續權杖。
- polling
- bool 或 AsyncPollingMethod
根據預設,您的輪詢方法會是 AsyncARMPolling。 針對此作業傳入 False,以不輪詢,或傳入您自己的初始化輪詢物件,以取得個人輪詢策略。
- polling_interval
- int
如果沒有Retry-After標頭,則為 LRO 作業的兩個輪詢之間的預設等候時間。
傳回
AsyncLROPoller 的實例,會傳回 None 或 cls (回應的結果)
傳回類型
例外狀況
begin_update
更新事件訂閱。
以非同步方式更新現有的事件訂閱。
async begin_update(scope: str, event_subscription_name: str, event_subscription_update_parameters: _models.EventSubscriptionUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.EventSubscription]
參數
- scope
- str
現有事件訂用帳戶的範圍。 範圍可以是訂用帳戶、資源群組或屬於資源提供者命名空間的最上層資源,或是 EventGrid 主題。 例如,針對資源群組使用 '/subscriptions/{subscriptionId}/' 作為訂用帳戶 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' 和 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' 作為資源,而 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' 代表 EventGrid 主題。 必要。
- event_subscription_update_parameters
- EventSubscriptionUpdateParameters 或 IO
已更新事件訂閱資訊。 這是 EventSubscriptionUpdateParameters 類型或 IO 類型。 必要。
- content_type
- str
Body 參數內容類型。 已知值為:'application/json'。 預設值為 [無]。
- cls
- callable
將傳遞直接回應的自訂類型或函式
- continuation_token
- str
從已儲存狀態重新開機輪詢器的接續權杖。
- polling
- bool 或 AsyncPollingMethod
根據預設,您的輪詢方法會是 AsyncARMPolling。 針對此作業傳入 False,以不輪詢,或傳入您自己的初始化輪詢物件,以取得個人輪詢策略。
- polling_interval
- int
如果沒有Retry-After標頭,則為 LRO 作業的兩個輪詢之間的預設等候時間。
傳回
AsyncLROPoller 的實例,會傳回 EventSubscription 或 cls 的結果 (回應)
傳回類型
例外狀況
get
取得事件訂閱。
取得事件訂閱的屬性。
async get(scope: str, event_subscription_name: str, **kwargs: Any) -> EventSubscription
參數
- scope
- str
事件訂閱的範圍。 範圍可以是訂用帳戶、資源群組或屬於資源提供者命名空間的最上層資源,或是 EventGrid 主題。 例如,針對資源群組使用 '/subscriptions/{subscriptionId}/' 作為訂用帳戶 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' 和 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' 作為資源,而 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' 代表 EventGrid 主題。 必要。
- cls
- callable
將傳遞直接回應的自訂類型或函式
傳回
EventSubscription 或 cls 的結果 (回應)
傳回類型
例外狀況
get_delivery_attributes
取得事件訂閱的傳遞屬性。
取得事件訂閱的所有傳遞屬性。
async get_delivery_attributes(scope: str, event_subscription_name: str, **kwargs: Any) -> DeliveryAttributeListResult
參數
- scope
- str
事件訂閱的範圍。 範圍可以是訂用帳戶、資源群組或屬於資源提供者命名空間的最上層資源,或是 EventGrid 主題。 例如,針對資源群組使用 '/subscriptions/{subscriptionId}/' 作為訂用帳戶 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' 和 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' 作為資源,而 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' 代表 EventGrid 主題。 必要。
- cls
- callable
將傳遞直接回應的自訂類型或函式
傳回
DeliveryAttributeListResult 或 cls 的結果 (回應)
傳回類型
例外狀況
get_full_url
取得事件訂用帳戶的完整 URL。
取得事件訂用帳戶的完整端點 URL。
async get_full_url(scope: str, event_subscription_name: str, **kwargs: Any) -> EventSubscriptionFullUrl
參數
- scope
- str
事件訂閱的範圍。 範圍可以是訂用帳戶、資源群組或屬於資源提供者命名空間的最上層資源,或是 EventGrid 主題。 例如,針對資源群組使用 '/subscriptions/{subscriptionId}/' 作為訂用帳戶 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' 和 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' 作為資源,而 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' 代表 EventGrid 主題。 必要。
- cls
- callable
將傳遞直接回應的自訂類型或函式
傳回
EventSubscriptionFullUrl 或 cls (回應的結果)
傳回類型
例外狀況
list_by_domain_topic
列出特定網域主題的所有事件訂用帳戶。
列出已針對特定網域主題建立的所有事件訂用帳戶。
list_by_domain_topic(resource_group_name: str, domain_name: str, topic_name: str, filter: str | None = None, top: int | None = None, **kwargs: Any) -> AsyncIterable[EventSubscription]
參數
- filter
- str
用來使用 OData 語法篩選搜尋結果的查詢。 只允許篩選 'name' 屬性,且 OData 作業數目有限。 這些作業包括:'contains' 函式以及下列邏輯作業:not、and、或 eq (表示相等) ,而 ne (表示不等於) 。 不支援算數運算。 以下是有效的篩選範例:$filter=contains (namE、'PATTERN') 和 name ne 'PATTERN-1'。 下列不是有效的篩選範例:$filter=location eq 'westus'。 預設值為 [無]。
- cls
- callable
將傳遞直接回應的自訂類型或函式
傳回
EventSubscription 實例或 cls (回應結果等反覆運算器)
傳回類型
例外狀況
list_by_resource
列出所有事件訂用帳戶。
列出已針對特定資源建立的所有事件訂用帳戶。
list_by_resource(resource_group_name: str, provider_namespace: str, resource_type_name: str, resource_name: str, filter: str | None = None, top: int | None = None, **kwargs: Any) -> AsyncIterable[EventSubscription]
參數
- filter
- str
用來使用 OData 語法篩選搜尋結果的查詢。 只允許篩選 'name' 屬性,且 OData 作業數目有限。 這些作業包括:'contains' 函式以及下列邏輯作業:not、and、或 eq (表示相等) ,而 ne (表示不等於) 。 不支援算數運算。 以下是有效的篩選範例:$filter=contains (namE、'PATTERN') 和 name ne 'PATTERN-1'。 下列不是有效的篩選範例:$filter=location eq 'westus'。 預設值為 [無]。
- cls
- callable
將傳遞直接回應的自訂類型或函式
傳回
EventSubscription 實例或 cls (回應結果等反覆運算器)
傳回類型
例外狀況
list_global_by_resource_group
列出 Azure 訂用帳戶和資源群組下的所有全域事件訂用帳戶。
列出特定 Azure 訂用帳戶和資源群組下的所有全域事件訂用帳戶。
list_global_by_resource_group(resource_group_name: str, filter: str | None = None, top: int | None = None, **kwargs: Any) -> AsyncIterable[EventSubscription]
參數
- filter
- str
用來使用 OData 語法篩選搜尋結果的查詢。 只允許篩選 'name' 屬性,且 OData 作業數目有限。 這些作業包括:'contains' 函式以及下列邏輯作業:not、and、或 eq (表示相等) ,而 ne (表示不等於) 。 不支援算數運算。 以下是有效的篩選範例:$filter=contains (namE、'PATTERN') 和 name ne 'PATTERN-1'。 下列不是有效的篩選範例:$filter=location eq 'westus'。 預設值為 [無]。
- cls
- callable
將傳遞直接回應的自訂類型或函式
傳回
EventSubscription 實例或 cls (回應結果等反覆運算器)
傳回類型
例外狀況
list_global_by_resource_group_for_topic_type
列出資源群組下的所有全域事件訂用帳戶,以取得主題類型。
列出資源群組下的特定主題類型的所有全域事件訂用帳戶。
list_global_by_resource_group_for_topic_type(resource_group_name: str, topic_type_name: str, filter: str | None = None, top: int | None = None, **kwargs: Any) -> AsyncIterable[EventSubscription]
參數
- filter
- str
用來使用 OData 語法篩選搜尋結果的查詢。 只允許篩選 'name' 屬性,且 OData 作業數目有限。 這些作業包括:'contains' 函式以及下列邏輯作業:not、and、或 eq (表示相等) ,而 ne (表示不等於) 。 不支援算數運算。 以下是有效的篩選範例:$filter=contains (namE、'PATTERN') 和 name ne 'PATTERN-1'。 下列不是有效的篩選範例:$filter=location eq 'westus'。 預設值為 [無]。
- cls
- callable
將傳遞直接回應的自訂類型或函式
傳回
EventSubscription 實例或 cls (回應結果等反覆運算器)
傳回類型
例外狀況
list_global_by_subscription
取得 Azure 訂用帳戶下所有全域事件訂用帳戶的匯總清單。
列出特定 Azure 訂用帳戶下的所有匯總全域事件訂用帳戶。
list_global_by_subscription(filter: str | None = None, top: int | None = None, **kwargs: Any) -> AsyncIterable[EventSubscription]
參數
- filter
- str
用來使用 OData 語法篩選搜尋結果的查詢。 只允許篩選 'name' 屬性,且 OData 作業數目有限。 這些作業包括:'contains' 函式以及下列邏輯作業:not、and、或 eq (表示相等) ,而 ne (表示不等於) 。 不支援算數運算。 以下是有效的篩選範例:$filter=contains (namE、'PATTERN') 和 name ne 'PATTERN-1'。 下列不是有效的篩選範例:$filter=location eq 'westus'。 預設值為 [無]。
- cls
- callable
將傳遞直接回應的自訂類型或函式
傳回
EventSubscription 實例或 cls (回應結果等反覆運算器)
傳回類型
例外狀況
list_global_by_subscription_for_topic_type
列出主題類型的所有全域事件訂閱。
列出 Azure 訂用帳戶下的所有全域事件訂用帳戶,以取得主題類型。
list_global_by_subscription_for_topic_type(topic_type_name: str, filter: str | None = None, top: int | None = None, **kwargs: Any) -> AsyncIterable[EventSubscription]
參數
- filter
- str
用來使用 OData 語法篩選搜尋結果的查詢。 只允許篩選 'name' 屬性,且 OData 作業數目有限。 這些作業包括:'contains' 函式以及下列邏輯作業:not、and、或 eq (表示相等) ,而 ne (表示不等於) 。 不支援算數運算。 以下是有效的篩選範例:$filter=contains (namE、'PATTERN') 和 name ne 'PATTERN-1'。 下列不是有效的篩選範例:$filter=location eq 'westus'。 預設值為 [無]。
- cls
- callable
將傳遞直接回應的自訂類型或函式
傳回
EventSubscription 實例或 cls (回應結果等反覆運算器)
傳回類型
例外狀況
list_regional_by_resource_group
列出 Azure 訂用帳戶和資源群組下的所有區域事件訂用帳戶。
列出特定 Azure 訂用帳戶和資源群組下指定位置的所有事件訂用帳戶。
list_regional_by_resource_group(resource_group_name: str, location: str, filter: str | None = None, top: int | None = None, **kwargs: Any) -> AsyncIterable[EventSubscription]
參數
- filter
- str
用來使用 OData 語法篩選搜尋結果的查詢。 只允許篩選 'name' 屬性,且 OData 作業數目有限。 這些作業包括:'contains' 函式以及下列邏輯作業:not、and、或 eq (表示相等) ,而 ne (表示不等於) 。 不支援算數運算。 以下是有效的篩選範例:$filter=contains (namE、'PATTERN') 和 name ne 'PATTERN-1'。 下列不是有效的篩選範例:$filter=location eq 'westus'。 預設值為 [無]。
- cls
- callable
將傳遞直接回應的自訂類型或函式
傳回
EventSubscription 實例或 cls (回應結果等反覆運算器)
傳回類型
例外狀況
list_regional_by_resource_group_for_topic_type
列出主題類型之 Azure 訂用帳戶和資源群組下的所有區域事件訂用帳戶。
列出特定 Azure 訂用帳戶和資源群組和主題類型下指定位置的所有事件訂用帳戶。
list_regional_by_resource_group_for_topic_type(resource_group_name: str, location: str, topic_type_name: str, filter: str | None = None, top: int | None = None, **kwargs: Any) -> AsyncIterable[EventSubscription]
參數
- filter
- str
用來使用 OData 語法篩選搜尋結果的查詢。 只允許篩選 'name' 屬性,且 OData 作業數目有限。 這些作業包括:'contains' 函式以及下列邏輯作業:not、and、或 eq (表示相等) ,而 ne (表示不等於) 。 不支援算數運算。 以下是有效的篩選範例:$filter=contains (namE、'PATTERN') 和 name ne 'PATTERN-1'。 下列不是有效的篩選範例:$filter=location eq 'westus'。 預設值為 [無]。
- cls
- callable
將傳遞直接回應的自訂類型或函式
傳回
EventSubscription 實例或 cls (回應結果等反覆運算器)
傳回類型
例外狀況
list_regional_by_subscription
列出 Azure 訂用帳戶下的所有區域事件訂用帳戶。
列出特定 Azure 訂用帳戶下指定位置的所有事件訂用帳戶。
list_regional_by_subscription(location: str, filter: str | None = None, top: int | None = None, **kwargs: Any) -> AsyncIterable[EventSubscription]
參數
- filter
- str
用來使用 OData 語法篩選搜尋結果的查詢。 只允許篩選 'name' 屬性,且 OData 作業數目有限。 這些作業包括:'contains' 函式以及下列邏輯作業:not、and、或 eq (表示相等) ,而 ne (表示不等於) 。 不支援算數運算。 以下是有效的篩選範例:$filter=contains (namE、'PATTERN') 和 name ne 'PATTERN-1'。 下列不是有效的篩選範例:$filter=location eq 'westus'。 預設值為 [無]。
- cls
- callable
將傳遞直接回應的自訂類型或函式
傳回
EventSubscription 實例或 cls (回應結果等反覆運算器)
傳回類型
例外狀況
list_regional_by_subscription_for_topic_type
列出 Azure 訂用帳戶下的所有區域事件訂用帳戶,以取得主題類型。
列出特定 Azure 訂用帳戶和主題類型下指定位置的所有事件訂用帳戶。
list_regional_by_subscription_for_topic_type(location: str, topic_type_name: str, filter: str | None = None, top: int | None = None, **kwargs: Any) -> AsyncIterable[EventSubscription]
參數
- filter
- str
用來使用 OData 語法篩選搜尋結果的查詢。 只允許篩選 'name' 屬性,且 OData 作業數目有限。 這些作業包括:'contains' 函式以及下列邏輯作業:not、and、或 eq (表示相等) ,而 ne (表示不等於) 。 不支援算數運算。 以下是有效的篩選範例:$filter=contains (namE、'PATTERN') 和 name ne 'PATTERN-1'。 下列不是有效的篩選範例:$filter=location eq 'westus'。 預設值為 [無]。
- cls
- callable
將傳遞直接回應的自訂類型或函式
傳回
EventSubscription 實例或 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'>