ClientGroupsOperations 類別

警告

請勿直接具現化此類別。

您應該改為透過 存取下列作業

EventGridManagementClient's

<xref:client_groups> 屬性。

繼承

builtins.object

ClientGroupsOperations

建構函式

ClientGroupsOperations(*args, **kwargs)

方法

begin_create_or_update	建立或更新用戶端群組。 使用指定的參數建立或更新用戶端群組。
begin_delete	刪除用戶端群組。 刪除現有的用戶端群組。
get	取得用戶端群組。 取得用戶端群組的屬性。
list_by_namespace	列出命名空間下的所有用戶端群組。 取得命名空間下的所有用戶端群組。

begin_create_or_update

建立或更新用戶端群組。

使用指定的參數建立或更新用戶端群組。

async begin_create_or_update(resource_group_name: str, namespace_name: str, client_group_name: str, client_group_info: _models.ClientGroup, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.ClientGroup]

參數

resource_group_name

str

必要

使用者訂用帳戶內的資源組名。 必要。

namespace_name

str

必要

命名空間的名稱。 必要。

client_group_name

str

必要

用戶端組名。 必要。

client_group_info

ClientGroup 或 IO

必要

用戶端群組資訊。 這是 ClientGroup 類型或 IO 類型。 必要。

content_type

str

本文參數內容類型。 已知值為：'application/json'。 預設值為 [無]。

cls

callable

將傳遞直接回應的自訂類型或函式

continuation_token

str

從已儲存狀態重新開機輪詢器的接續權杖。

polling

bool 或 AsyncPollingMethod

根據預設，您的輪詢方法會是 AsyncARMPolling。 傳入 False 表示此作業無法輪詢，或傳入您自己的已初始化輪詢物件，以取得個人輪詢策略。

polling_interval

int

如果沒有Retry-After標頭，則兩次輪詢 LRO 作業之間的預設等候時間。

傳回

AsyncLROPoller 的實例，會傳回 ClientGroup 或 cls (回應的結果)

傳回類型

AsyncLROPoller[ClientGroup]

例外狀況

HttpResponseError

begin_delete

刪除用戶端群組。

刪除現有的用戶端群組。

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

參數

resource_group_name

str

必要

使用者訂用帳戶內的資源組名。 必要。

namespace_name

str

必要

命名空間的名稱。 必要。

client_group_name

str

必要

用戶端群組的名稱。 必要。

cls

callable

將傳遞直接回應的自訂類型或函式

continuation_token

str

從已儲存狀態重新開機輪詢器的接續權杖。

polling

bool 或 AsyncPollingMethod

根據預設，您的輪詢方法會是 AsyncARMPolling。 傳入 False 表示此作業無法輪詢，或傳入您自己的已初始化輪詢物件，以取得個人輪詢策略。

polling_interval

int

如果沒有Retry-After標頭，則兩次輪詢 LRO 作業之間的預設等候時間。

傳回

AsyncLROPoller 的實例，會傳回 None 或 cls (回應的結果)

傳回類型

AsyncLROPoller[None]

例外狀況

HttpResponseError

get

取得用戶端群組。

取得用戶端群組的屬性。

async get(resource_group_name: str, namespace_name: str, client_group_name: str, **kwargs: Any) -> ClientGroup

參數

resource_group_name

str

必要

使用者訂用帳戶內的資源組名。 必要。

namespace_name

str

必要

命名空間的名稱。 必要。

client_group_name

str

必要

用戶端群組的名稱。 必要。

cls

callable

將傳遞直接回應的自訂類型或函式

傳回

ClientGroup 或 cls 的結果 (回應)

傳回類型

ClientGroup

例外狀況

HttpResponseError

list_by_namespace

列出命名空間下的所有用戶端群組。

取得命名空間下的所有用戶端群組。

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

參數

resource_group_name

str

必要

使用者訂用帳戶內的資源組名。 必要。

namespace_name

str

必要

命名空間的名稱。 必要。

filter

str

必要

用來使用 OData 語法篩選搜尋結果的查詢。 只允許篩選 'name' 屬性，且 OData 作業數目有限。 這些作業包括：'contains' 函式以及下列邏輯作業：not、and、或 eq (表示相等) ，而 ne (表示不等於) 。 不支援算數運算。 以下是有效的篩選範例：$filter=contains (namE、'PATTERN') 和 name ne 'PATTERN-1'。 下列不是有效的篩選範例：$filter=location eq 'westus'。 預設值為 [無]。

top

int

必要

要針對清單作業傳回每頁的結果數目。 top 參數的有效範圍是 1 到 100。 如果未指定，則傳回的預設結果數目為每頁 20 個專案。 預設值為 [無]。

cls

callable

將傳遞直接回應的自訂類型或函式

傳回

用戶端群組的實例或 cls (回應結果之類的反覆運算器)

傳回類型

AsyncItemPaged[ClientGroup]

例外狀況

HttpResponseError

屬性

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