你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
Domains interface
Interface representing a Domains.
Methods
Method Details
beginCreateOrUpdate(string, string, Domain, DomainsCreateOrUpdateOptionalParams)
Asynchronously creates or updates a new domain with the specified parameters.
function beginCreateOrUpdate(resourceGroupName: string, domainName: string, domainInfo: Domain, options?: DomainsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<Domain>, Domain>>Parameters
- resourceGroupName
-
string
The name of the resource group within the user's subscription.
- domainName
-
string
Name of the domain.
- domainInfo
- Domain
Domain information.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<Domain>, Domain>>
beginCreateOrUpdateAndWait(string, string, Domain, DomainsCreateOrUpdateOptionalParams)
Asynchronously creates or updates a new domain with the specified parameters.
function beginCreateOrUpdateAndWait(resourceGroupName: string, domainName: string, domainInfo: Domain, options?: DomainsCreateOrUpdateOptionalParams): Promise<Domain>Parameters
- resourceGroupName
-
string
The name of the resource group within the user's subscription.
- domainName
-
string
Name of the domain.
- domainInfo
- Domain
Domain information.
The options parameters.
Returns
Promise<Domain>
beginDelete(string, string, DomainsDeleteOptionalParams)
Delete existing domain.
function beginDelete(resourceGroupName: string, domainName: string, options?: DomainsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group within the user's subscription.
- domainName
-
string
Name of the domain.
- options
- DomainsDeleteOptionalParams
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginDeleteAndWait(string, string, DomainsDeleteOptionalParams)
Delete existing domain.
function beginDeleteAndWait(resourceGroupName: string, domainName: string, options?: DomainsDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group within the user's subscription.
- domainName
-
string
Name of the domain.
- options
- DomainsDeleteOptionalParams
The options parameters.
Returns
Promise<void>
beginUpdate(string, string, DomainUpdateParameters, DomainsUpdateOptionalParams)
Asynchronously updates a domain with the specified parameters.
function beginUpdate(resourceGroupName: string, domainName: string, domainUpdateParameters: DomainUpdateParameters, options?: DomainsUpdateOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group within the user's subscription.
- domainName
-
string
Name of the domain.
- domainUpdateParameters
- DomainUpdateParameters
Domain update information.
- options
- DomainsUpdateOptionalParams
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginUpdateAndWait(string, string, DomainUpdateParameters, DomainsUpdateOptionalParams)
Asynchronously updates a domain with the specified parameters.
function beginUpdateAndWait(resourceGroupName: string, domainName: string, domainUpdateParameters: DomainUpdateParameters, options?: DomainsUpdateOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group within the user's subscription.
- domainName
-
string
Name of the domain.
- domainUpdateParameters
- DomainUpdateParameters
Domain update information.
- options
- DomainsUpdateOptionalParams
The options parameters.
Returns
Promise<void>
get(string, string, DomainsGetOptionalParams)
Get properties of a domain.
function get(resourceGroupName: string, domainName: string, options?: DomainsGetOptionalParams): Promise<Domain>Parameters
- resourceGroupName
-
string
The name of the resource group within the user's subscription.
- domainName
-
string
Name of the domain.
- options
- DomainsGetOptionalParams
The options parameters.
Returns
Promise<Domain>
listByResourceGroup(string, DomainsListByResourceGroupOptionalParams)
List all the domains under a resource group.
function listByResourceGroup(resourceGroupName: string, options?: DomainsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Domain, Domain[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group within the user's subscription.
The options parameters.
Returns
listBySubscription(DomainsListBySubscriptionOptionalParams)
List all the domains under an Azure subscription.
function listBySubscription(options?: DomainsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<Domain, Domain[], PageSettings>Parameters
The options parameters.
Returns
listSharedAccessKeys(string, string, DomainsListSharedAccessKeysOptionalParams)
List the two keys used to publish to a domain.
function listSharedAccessKeys(resourceGroupName: string, domainName: string, options?: DomainsListSharedAccessKeysOptionalParams): Promise<DomainSharedAccessKeys>Parameters
- resourceGroupName
-
string
The name of the resource group within the user's subscription.
- domainName
-
string
Name of the domain.
The options parameters.
Returns
Promise<DomainSharedAccessKeys>
regenerateKey(string, string, DomainRegenerateKeyRequest, DomainsRegenerateKeyOptionalParams)
Regenerate a shared access key for a domain.
function regenerateKey(resourceGroupName: string, domainName: string, regenerateKeyRequest: DomainRegenerateKeyRequest, options?: DomainsRegenerateKeyOptionalParams): Promise<DomainSharedAccessKeys>Parameters
- resourceGroupName
-
string
The name of the resource group within the user's subscription.
- domainName
-
string
Name of the domain.
- regenerateKeyRequest
- DomainRegenerateKeyRequest
Request body to regenerate key.
The options parameters.
Returns
Promise<DomainSharedAccessKeys>