你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

DomainsOperations 类

参考

警告

请勿直接实例化此类。

相反，应通过以下方式访问以下操作：

WebSiteManagementClient的

<xref:domains> 属性。

继承: builtins.object

DomainsOperations

构造函数

DomainsOperations(*args, **kwargs)

方法

begin_create_or_update	创建或更新域。创建或更新域。
check_availability	检查域是否可用于注册。检查域是否可用于注册。
create_or_update_ownership_identifier	为域创建所有权标识符，或更新现有标识符的标识符详细信息。为域创建所有权标识符，或更新现有标识符的标识符详细信息。
delete	删除域。删除域。
delete_ownership_identifier	删除域的所有权标识符。删除域的所有权标识符。
get	获取域。获取域。
get_control_center_sso_request	为域管理门户生成单一登录请求。为域管理门户生成单一登录请求。
get_ownership_identifier	获取域的所有权标识符。获取域的所有权标识符。
list	获取订阅中的所有域。获取订阅中的所有域。
list_by_resource_group	获取资源组中的所有域。获取资源组中的所有域。
list_ownership_identifiers	列出域所有权标识符。列出域所有权标识符。
list_recommendations	获取基于关键字的域名建议。获取基于关键字的域名建议。
renew	续订域。续订域。
update	创建或更新域。创建或更新域。
update_ownership_identifier	为域创建所有权标识符，或更新现有标识符的标识符详细信息。为域创建所有权标识符，或更新现有标识符的标识符详细信息。

begin_create_or_update

创建或更新域。

begin_create_or_update(resource_group_name: str, domain_name: str, domain: _models.Domain, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.Domain]

参数

resource_group_name: str

必需

资源所属的资源组的名称。必需。

domain_name: str

必需

域的名称。必需。

domain: Domain 或 IO

必需

域注册信息。是域类型或 IO 类型。必需。

content_type: str

Body 参数内容类型。已知值为：“application/json”。默认值为 None。

cls: callable

将传递直接响应的自定义类型或函数

continuation_token: str

用于从保存状态重启轮询的继续标记。

polling: bool 或 PollingMethod

默认情况下，轮询方法将为 ARMPolling。将此操作传入 False 以不进行轮询，或为个人轮询策略传入你自己的初始化轮询对象。

polling_interval: int

如果没有 Retry-After 标头，则 LRO 操作的两次轮询之间的默认等待时间。

LROPoller 的实例，返回域或 cls 的结果 (响应)

返回类型

LROPoller[Domain]

例外

HttpResponseError

check_availability

检查域是否可用于注册。

check_availability(identifier: _models.NameIdentifier, *, content_type: str = 'application/json', **kwargs: Any) -> _models.DomainAvailablilityCheckResult

参数

identifier: NameIdentifier 或 IO

必需

域的名称。是 NameIdentifier 类型或 IO 类型。必需。

content_type: str

Body 参数内容类型。已知值为：“application/json”。默认值为 None。

cls: callable

将传递直接响应的自定义类型或函数

DomainAvailablilityCheckResult 或 cls 的结果 (响应)

返回类型

DomainAvailablilityCheckResult

例外

HttpResponseError

create_or_update_ownership_identifier

为域创建所有权标识符，或更新现有标识符的标识符详细信息。

create_or_update_ownership_identifier(resource_group_name: str, domain_name: str, name: str, domain_ownership_identifier: _models.DomainOwnershipIdentifier, *, content_type: str = 'application/json', **kwargs: Any) -> _models.DomainOwnershipIdentifier

参数

resource_group_name: str

必需

资源所属的资源组的名称。必需。

domain_name: str

必需

域名。必需。

name: str

必需

标识符的名称。必需。

domain_ownership_identifier: DomainOwnershipIdentifier 或 IO

必需

域所有权属性的 JSON 表示形式。是 DomainOwnershipIdentifier 类型或 IO 类型。必需。

content_type: str

Body 参数内容类型。已知值为：“application/json”。默认值为 None。

cls: callable

将传递直接响应的自定义类型或函数

DomainOwnershipIdentifier 或 cls 的结果 (响应)

返回类型

DomainOwnershipIdentifier

例外

HttpResponseError

delete

删除域。

delete(resource_group_name: str, domain_name: str, force_hard_delete_domain: bool | None = None, **kwargs: Any) -> None

参数

resource_group_name: str

必需

资源所属的资源组的名称。必需。

domain_name: str

必需

域的名称。必需。

force_hard_delete_domain: bool

必需

指定 <code>true</code> 以立即删除域。默认值是在 <code>false</code> 24 小时后删除域。默认值为 None。

cls: callable

将传递直接响应的自定义类型或函数

无或 cls 的结果 (响应)

返回类型

None

例外

HttpResponseError

delete_ownership_identifier

删除域的所有权标识符。

delete_ownership_identifier(resource_group_name: str, domain_name: str, name: str, **kwargs: Any) -> None

参数

resource_group_name: str

必需

资源所属的资源组的名称。必需。

domain_name: str

必需

域名。必需。

name: str

必需

标识符的名称。必需。

cls: callable

将传递直接响应的自定义类型或函数

无或 cls 的结果 (响应)

返回类型

None

例外

HttpResponseError

get

获取域。

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

参数

resource_group_name: str

必需

资源所属的资源组的名称。必需。

domain_name: str

必需

域的名称。必需。

cls: callable

将传递直接响应的自定义类型或函数

域或 cls (响应) 的结果

返回类型

Domain

例外

HttpResponseError

get_control_center_sso_request

为域管理门户生成单一登录请求。

get_control_center_sso_request(**kwargs: Any) -> DomainControlCenterSsoRequest

参数

cls: callable

将传递直接响应的自定义类型或函数

DomainControlCenterSsoRequest 或 cls 的结果 (响应)

返回类型

DomainControlCenterSsoRequest

例外

HttpResponseError

get_ownership_identifier

获取域的所有权标识符。

get_ownership_identifier(resource_group_name: str, domain_name: str, name: str, **kwargs: Any) -> DomainOwnershipIdentifier

参数

resource_group_name: str

必需

资源所属的资源组的名称。必需。

domain_name: str

必需

域名。必需。

name: str

必需

标识符的名称。必需。

cls: callable

将传递直接响应的自定义类型或函数

DomainOwnershipIdentifier 或 cls 的结果 (响应)

返回类型

DomainOwnershipIdentifier

例外

HttpResponseError

list

获取订阅中的所有域。

list(**kwargs: Any) -> Iterable[Domain]

参数

cls: callable

将传递直接响应的自定义类型或函数

迭代器，例如域的实例或 cls 的结果 (响应)

返回类型

ItemPaged[Domain]

例外

HttpResponseError

list_by_resource_group

获取资源组中的所有域。

list_by_resource_group(resource_group_name: str, **kwargs: Any) -> Iterable[Domain]

参数

resource_group_name: str

必需

资源所属的资源组的名称。必需。

cls: callable

将传递直接响应的自定义类型或函数

一个迭代器，例如域的实例或 cls 的结果 (响应)

返回类型

ItemPaged[Domain]

例外

HttpResponseError

list_ownership_identifiers

列出域所有权标识符。

list_ownership_identifiers(resource_group_name: str, domain_name: str, **kwargs: Any) -> Iterable[DomainOwnershipIdentifier]

参数

resource_group_name: str

必需

资源所属的资源组的名称。必需。

domain_name: str

必需

域的名称。必需。

cls: callable

将传递直接响应的自定义类型或函数

一个迭代器，例如 DomainOwnershipIdentifier 的实例或 cls 的结果 (响应)

返回类型

ItemPaged[DomainOwnershipIdentifier]

例外

HttpResponseError

list_recommendations

获取基于关键字的域名建议。

list_recommendations(parameters: _models.DomainRecommendationSearchParameters, *, content_type: str = 'application/json', **kwargs: Any) -> Iterable['_models.NameIdentifier']

参数

parameters: DomainRecommendationSearchParameters 或 IO

必需

搜索域名建议的参数。是 DomainRecommendationSearchParameters 类型或 IO 类型。必需。

content_type: str

正文参数内容类型。已知值为：“application/json”。默认值为 None。

cls: callable

将传递直接响应的自定义类型或函数

一个迭代器，如 NameIdentifier 的实例或 cls 的结果 (响应)

返回类型

ItemPaged[NameIdentifier]

例外

HttpResponseError

renew

续订域。

renew(resource_group_name: str, domain_name: str, **kwargs: Any) -> None

参数

resource_group_name: str

必需

资源所属的资源组的名称。必需。

domain_name: str

必需

域的名称。必需。

cls: callable

将传递直接响应的自定义类型或函数

无响应或 cls 的结果 (响应)

返回类型

None

例外

HttpResponseError

update

创建或更新域。

update(resource_group_name: str, domain_name: str, domain: _models.DomainPatchResource, *, content_type: str = 'application/json', **kwargs: Any) -> _models.Domain

参数

resource_group_name: str

必需

资源所属的资源组的名称。必需。

domain_name: str

必需

域的名称。必需。

domain: DomainPatchResource 或 IO

必需

域注册信息。是 DomainPatchResource 类型还是 IO 类型。必需。

content_type: str

正文参数内容类型。已知值为：“application/json”。默认值为 None。

cls: callable

将传递直接响应的自定义类型或函数

域或 cls 的结果 (响应)

返回类型

Domain

例外

HttpResponseError

update_ownership_identifier

为域创建所有权标识符，或更新现有标识符的标识符详细信息。

update_ownership_identifier(resource_group_name: str, domain_name: str, name: str, domain_ownership_identifier: _models.DomainOwnershipIdentifier, *, content_type: str = 'application/json', **kwargs: Any) -> _models.DomainOwnershipIdentifier

参数

resource_group_name: str

必需

资源所属的资源组的名称。必需。

domain_name: str

必需

域的名称。必需。

name: str

必需

标识符的名称。必需。

domain_ownership_identifier: DomainOwnershipIdentifier 或 IO

必需

域所有权属性的 JSON 表示形式。是 DomainOwnershipIdentifier 类型或 IO 类型。必需。

content_type: str

正文参数内容类型。已知值为：“application/json”。默认值为 None。

cls: callable

将传递直接响应的自定义类型或函数

DomainOwnershipIdentifier 或 cls 的结果 (响应)

返回类型

DomainOwnershipIdentifier

例外

HttpResponseError

属性

models

models = <module 'azure.mgmt.web.v2018_02_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\mgmt\\web\\v2018_02_01\\models\\__init__.py'>