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

Domains interface

包:

@azure/arm-appservice

表示域的接口。

方法

beginCreateOrUpdate(string, string, Domain, DomainsCreateOrUpdateOptionalParams)	创建或更新域的说明。
beginCreateOrUpdateAndWait(string, string, Domain, DomainsCreateOrUpdateOptionalParams)	创建或更新域的说明。
checkAvailability(NameIdentifier, DomainsCheckAvailabilityOptionalParams)	检查域是否可用于注册的说明。
createOrUpdateOwnershipIdentifier(string, string, string, DomainOwnershipIdentifier, DomainsCreateOrUpdateOwnershipIdentifierOptionalParams)	为域创建所有权标识符或更新现有标识符的标识符详细信息的说明
delete(string, string, DomainsDeleteOptionalParams)	删除域的说明。
deleteOwnershipIdentifier(string, string, string, DomainsDeleteOwnershipIdentifierOptionalParams)	有关删除域所有权标识符的说明
get(string, string, DomainsGetOptionalParams)	获取域的说明。
getControlCenterSsoRequest(DomainsGetControlCenterSsoRequestOptionalParams)	为域管理门户生成单一登录请求的说明。
getOwnershipIdentifier(string, string, string, DomainsGetOwnershipIdentifierOptionalParams)	获取域所有权标识符的说明
list(DomainsListOptionalParams)	获取订阅中的所有域的说明。
listByResourceGroup(string, DomainsListByResourceGroupOptionalParams)	获取资源组中的所有域的说明。
listOwnershipIdentifiers(string, string, DomainsListOwnershipIdentifiersOptionalParams)	列出域所有权标识符的说明。
listRecommendations(DomainRecommendationSearchParameters, DomainsListRecommendationsOptionalParams)	基于关键字获取域名建议的说明。
renew(string, string, DomainsRenewOptionalParams)	续订域的说明。
transferOut(string, string, DomainsTransferOutOptionalParams)	将域传出给另一个注册机构
update(string, string, DomainPatchResource, DomainsUpdateOptionalParams)	创建或更新域的说明。
updateOwnershipIdentifier(string, string, string, DomainOwnershipIdentifier, DomainsUpdateOwnershipIdentifierOptionalParams)	为域创建所有权标识符或更新现有标识符的标识符详细信息的说明

方法详细信息

beginCreateOrUpdate(string, string, Domain, DomainsCreateOrUpdateOptionalParams)

创建或更新域的说明。

function beginCreateOrUpdate(resourceGroupName: string, domainName: string, domain: Domain, options?: DomainsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Domain>, Domain>>

参数

resourceGroupName

string

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

domainName

string

域的名称。

domain

Domain

域注册信息。

options

DomainsCreateOrUpdateOptionalParams

选项参数。

返回

Promise<@azure/core-lro.SimplePollerLike<OperationState<Domain>, Domain>>

beginCreateOrUpdateAndWait(string, string, Domain, DomainsCreateOrUpdateOptionalParams)

创建或更新域的说明。

function beginCreateOrUpdateAndWait(resourceGroupName: string, domainName: string, domain: Domain, options?: DomainsCreateOrUpdateOptionalParams): Promise<Domain>

参数

resourceGroupName

string

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

domainName

string

域的名称。

domain

Domain

域注册信息。

options

DomainsCreateOrUpdateOptionalParams

选项参数。

返回

Promise<Domain>

checkAvailability(NameIdentifier, DomainsCheckAvailabilityOptionalParams)

检查域是否可用于注册的说明。

function checkAvailability(identifier: NameIdentifier, options?: DomainsCheckAvailabilityOptionalParams): Promise<DomainAvailabilityCheckResult>

参数

identifier

NameIdentifier

域的名称。

options

DomainsCheckAvailabilityOptionalParams

选项参数。

返回

Promise<DomainAvailabilityCheckResult>

createOrUpdateOwnershipIdentifier(string, string, string, DomainOwnershipIdentifier, DomainsCreateOrUpdateOwnershipIdentifierOptionalParams)

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

function createOrUpdateOwnershipIdentifier(resourceGroupName: string, domainName: string, name: string, domainOwnershipIdentifier: DomainOwnershipIdentifier, options?: DomainsCreateOrUpdateOwnershipIdentifierOptionalParams): Promise<DomainOwnershipIdentifier>

参数

resourceGroupName

string

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

domainName

string

域名。

name

string

标识符的名称。

domainOwnershipIdentifier

DomainOwnershipIdentifier

域所有权属性的 JSON 表示形式。

options

DomainsCreateOrUpdateOwnershipIdentifierOptionalParams

选项参数。

返回

Promise<DomainOwnershipIdentifier>

delete(string, string, DomainsDeleteOptionalParams)

删除域的说明。

function delete(resourceGroupName: string, domainName: string, options?: DomainsDeleteOptionalParams): Promise<void>

参数

resourceGroupName

string

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

domainName

string

域的名称。

options

DomainsDeleteOptionalParams

选项参数。

返回

Promise<void>

deleteOwnershipIdentifier(string, string, string, DomainsDeleteOwnershipIdentifierOptionalParams)

有关删除域所有权标识符的说明

function deleteOwnershipIdentifier(resourceGroupName: string, domainName: string, name: string, options?: DomainsDeleteOwnershipIdentifierOptionalParams): Promise<void>

参数

resourceGroupName

string

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

domainName

string

域名。

name

string

标识符的名称。

options

DomainsDeleteOwnershipIdentifierOptionalParams

选项参数。

返回

Promise<void>

get(string, string, DomainsGetOptionalParams)

获取域的说明。

function get(resourceGroupName: string, domainName: string, options?: DomainsGetOptionalParams): Promise<Domain>

参数

resourceGroupName

string

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

domainName

string

域的名称。

options

DomainsGetOptionalParams

选项参数。

返回

Promise<Domain>

getControlCenterSsoRequest(DomainsGetControlCenterSsoRequestOptionalParams)

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

function getControlCenterSsoRequest(options?: DomainsGetControlCenterSsoRequestOptionalParams): Promise<DomainControlCenterSsoRequest>

参数

options

DomainsGetControlCenterSsoRequestOptionalParams

选项参数。

返回

Promise<DomainControlCenterSsoRequest>

getOwnershipIdentifier(string, string, string, DomainsGetOwnershipIdentifierOptionalParams)

获取域所有权标识符的说明

function getOwnershipIdentifier(resourceGroupName: string, domainName: string, name: string, options?: DomainsGetOwnershipIdentifierOptionalParams): Promise<DomainOwnershipIdentifier>

参数

resourceGroupName

string

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

domainName

string

域名。

name

string

标识符的名称。

options

DomainsGetOwnershipIdentifierOptionalParams

选项参数。

返回

Promise<DomainOwnershipIdentifier>

list(DomainsListOptionalParams)

获取订阅中的所有域的说明。

function list(options?: DomainsListOptionalParams): PagedAsyncIterableIterator<Domain, Domain[], PageSettings>

参数

options

DomainsListOptionalParams

选项参数。

返回

PagedAsyncIterableIterator<Domain, Domain[], PageSettings>

listByResourceGroup(string, DomainsListByResourceGroupOptionalParams)

获取资源组中的所有域的说明。

function listByResourceGroup(resourceGroupName: string, options?: DomainsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Domain, Domain[], PageSettings>

参数

resourceGroupName

string

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

options

DomainsListByResourceGroupOptionalParams

选项参数。

返回

PagedAsyncIterableIterator<Domain, Domain[], PageSettings>

listOwnershipIdentifiers(string, string, DomainsListOwnershipIdentifiersOptionalParams)

列出域所有权标识符的说明。

function listOwnershipIdentifiers(resourceGroupName: string, domainName: string, options?: DomainsListOwnershipIdentifiersOptionalParams): PagedAsyncIterableIterator<DomainOwnershipIdentifier, DomainOwnershipIdentifier[], PageSettings>

参数

resourceGroupName

string

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

domainName

string

域名。

options

DomainsListOwnershipIdentifiersOptionalParams

选项参数。

返回

PagedAsyncIterableIterator<DomainOwnershipIdentifier, DomainOwnershipIdentifier[], PageSettings>

listRecommendations(DomainRecommendationSearchParameters, DomainsListRecommendationsOptionalParams)

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

function listRecommendations(parameters: DomainRecommendationSearchParameters, options?: DomainsListRecommendationsOptionalParams): PagedAsyncIterableIterator<NameIdentifier, NameIdentifier[], PageSettings>

参数

parameters

DomainRecommendationSearchParameters

搜索域名建议的参数。

options

DomainsListRecommendationsOptionalParams

选项参数。

返回

PagedAsyncIterableIterator<NameIdentifier, NameIdentifier[], PageSettings>

renew(string, string, DomainsRenewOptionalParams)

续订域的说明。

function renew(resourceGroupName: string, domainName: string, options?: DomainsRenewOptionalParams): Promise<void>

参数

resourceGroupName

string

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

domainName

string

域的名称。

options

DomainsRenewOptionalParams

选项参数。

返回

Promise<void>

transferOut(string, string, DomainsTransferOutOptionalParams)

将域传出给另一个注册机构

function transferOut(resourceGroupName: string, domainName: string, options?: DomainsTransferOutOptionalParams): Promise<Domain>

参数

resourceGroupName

string

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

domainName

string

域名。

options

DomainsTransferOutOptionalParams

选项参数。

返回

Promise<Domain>

update(string, string, DomainPatchResource, DomainsUpdateOptionalParams)

创建或更新域的说明。

function update(resourceGroupName: string, domainName: string, domain: DomainPatchResource, options?: DomainsUpdateOptionalParams): Promise<Domain>

参数

resourceGroupName

string

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

domainName

string

域的名称。

domain

DomainPatchResource

域注册信息。

options

DomainsUpdateOptionalParams

选项参数。

返回

Promise<Domain>

updateOwnershipIdentifier(string, string, string, DomainOwnershipIdentifier, DomainsUpdateOwnershipIdentifierOptionalParams)

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

function updateOwnershipIdentifier(resourceGroupName: string, domainName: string, name: string, domainOwnershipIdentifier: DomainOwnershipIdentifier, options?: DomainsUpdateOwnershipIdentifierOptionalParams): Promise<DomainOwnershipIdentifier>

参数

resourceGroupName

string

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

domainName

string

域的名称。

name

string

标识符的名称。

domainOwnershipIdentifier

DomainOwnershipIdentifier

域所有权属性的 JSON 表示形式。

options

DomainsUpdateOwnershipIdentifierOptionalParams

选项参数。

返回

Promise<DomainOwnershipIdentifier>