DomainsOperations 類別

DomainsOperations 非同步作業。

您不應該直接具現化此類別。 相反地，您應該建立用戶端實例來為您具現化它，並將它附加為屬性。

繼承

builtins.object

DomainsOperations

建構函式

DomainsOperations(client, config, serializer, deserializer)

參數

client

必要

服務要求的用戶端。

config

必要

服務用戶端的設定。

serializer

必要

物件模型序列化程式。

deserializer

必要

物件模型還原序列化程式。

變數

models

此作業群組中使用的模型類別別名。

方法

begin_create_or_update	建立或更新網域。 以非同步方式建立或更新具有指定參數的新網域。
begin_delete	刪除網域。 刪除現有的網域。
begin_update	更新網域。 以非同步方式更新具有指定參數的網域。
get	取得網域。 取得網域的屬性。
list_by_resource_group	列出資源群組下的網域。 列出資源群組下的所有網域。
list_by_subscription	列出 Azure 訂用帳戶下的網域。 列出 Azure 訂用帳戶下的所有網域。
list_shared_access_keys	列出網域的索引鍵。 列出用來發佈至網域的兩個金鑰。
regenerate_key	重新產生網域的金鑰。 重新產生網域的共用存取金鑰。

begin_create_or_update

建立或更新網域。

以非同步方式建立或更新具有指定參數的新網域。

async begin_create_or_update(resource_group_name: str, domain_name: str, domain_info: Domain, **kwargs: Any) -> AsyncLROPoller[Domain]

參數

resource_group_name

str

必要

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

domain_name

str

必要

功能變數名稱。

domain_info

Domain

必要

網域資訊。

cls

callable

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

continuation_token

str

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

polling

bool 或 AsyncPollingMethod

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

polling_interval

int

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

傳回

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

傳回類型

AsyncLROPoller[Domain]

例外狀況

HttpResponseError

begin_delete

刪除網域。

刪除現有的網域。

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

參數

resource_group_name

str

必要

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

domain_name

str

必要

功能變數名稱。

cls

callable

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

continuation_token

str

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

polling

bool 或 AsyncPollingMethod

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

polling_interval

int

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

傳回

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

傳回類型

AsyncLROPoller[None]

例外狀況

HttpResponseError

begin_update

更新網域。

以非同步方式更新具有指定參數的網域。

async begin_update(resource_group_name: str, domain_name: str, domain_update_parameters: DomainUpdateParameters, **kwargs: Any) -> AsyncLROPoller[Domain]

參數

resource_group_name

str

必要

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

domain_name

str

必要

功能變數名稱。

domain_update_parameters

DomainUpdateParameters

必要

網域更新資訊。

cls

callable

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

continuation_token

str

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

polling

bool 或 AsyncPollingMethod

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

polling_interval

int

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

傳回

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

傳回類型

AsyncLROPoller[Domain]

例外狀況

HttpResponseError

get

取得網域。

取得網域的屬性。

async get(resource_group_name: str, domain_name: str, **kwargs: Any) -> Domain

參數

resource_group_name

str

必要

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

domain_name

str

必要

功能變數名稱。

cls

callable

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

傳回

網域或 cls (回應的結果)

傳回類型

Domain

例外狀況

HttpResponseError

list_by_resource_group

列出資源群組下的網域。

列出資源群組下的所有網域。

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

參數

resource_group_name

str

必要

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

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'。 預設值為 [無]。

top

int

必要

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

cls

callable

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

傳回

像是 DomainsListResult 實例或 cls (回應結果的反覆運算器)

傳回類型

AsyncItemPaged[DomainsListResult]

例外狀況

HttpResponseError

list_by_subscription

列出 Azure 訂用帳戶下的網域。

列出 Azure 訂用帳戶下的所有網域。

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

參數

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'。 預設值為 [無]。

top

int

必要

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

cls

callable

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

傳回

像是 DomainsListResult 實例或 cls (回應結果的反覆運算器)

傳回類型

AsyncItemPaged[DomainsListResult]

例外狀況

HttpResponseError

list_shared_access_keys

列出網域的索引鍵。

列出用來發佈至網域的兩個金鑰。

async list_shared_access_keys(resource_group_name: str, domain_name: str, **kwargs: Any) -> DomainSharedAccessKeys

參數

resource_group_name

str

必要

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

domain_name

str

必要

功能變數名稱。

cls

callable

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

傳回

DomainSharedAccessKeys 或 cls (回應的結果)

傳回類型

DomainSharedAccessKeys

例外狀況

HttpResponseError

regenerate_key

重新產生網域的金鑰。

重新產生網域的共用存取金鑰。

async regenerate_key(resource_group_name: str, domain_name: str, regenerate_key_request: DomainRegenerateKeyRequest, **kwargs: Any) -> DomainSharedAccessKeys

參數

resource_group_name

str

必要

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

domain_name

str

必要

功能變數名稱。

regenerate_key_request

DomainRegenerateKeyRequest

必要

要求本文以重新產生金鑰。

cls

callable

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

傳回

DomainSharedAccessKeys 或 cls (回應的結果)

傳回類型

DomainSharedAccessKeys

例外狀況

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