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

PhoneNumberAdministrationClient class

包:
@azure/communication-administration

Client 类，用于与 Azure 通信服务 PhoneNumber 管理交互。

构造函数

PhoneNumberAdministrationClient(string, KeyCredential, PhoneNumberAdministrationClientOptions)

使用 Azure KeyCredential 初始化 PhoneNumberAdministrationClient 类的新实例。
PhoneNumberAdministrationClient(string, PhoneNumberAdministrationClientOptions)

初始化 PhoneNumberAdministrationClient 类的新实例。
PhoneNumberAdministrationClient(string, TokenCredential, PhoneNumberAdministrationClientOptions)

使用 TokenCredential 初始化 PhoneNumberAdministrationClient 类的新实例。

方法

beginPurchaseReservation(string, BeginPurchaseReservationOptions)

开始购买与给定 ID 关联的预留中的电话号码。

此函数返回一个长时间运行的作轮询器，该轮询程序允许无限期等待作完成。

示例用法：

const client = new PhoneNumberAdministrationClient(CONNECTION_STRING);
const purchasePoller = await client.beginPurchaseReservation(RESERVATION_ID);

// Serializing the poller
const serialized = purchasePoller.toString();

// Waiting until it's done
const results = await purchasePoller.pollUntilDone();
console.log(results);
beginReleasePhoneNumbers(string[], BeginReleasePhoneNumbersOptions)

开始发布已获取的电话号码列表。

此函数返回一个长时间运行的作轮询器，该轮询程序允许无限期等待作完成。

示例用法：

const client = new PhoneNumberAdministrationClient(CONNECTION_STRING);
const releasePoller = await client.beginReleasePhoneNumbers(PHONE_NUMBERS);

// Serializing the poller
const serialized = releasePoller.toString();

// Waiting until it's done
const results = await releasePoller.pollUntilDone();
console.log(results);
beginReservePhoneNumbers(CreateReservationRequest, BeginReservePhoneNumbersOptions)

根据某些约束（如姓名或区号）开始搜索电话号码。 找到的电话号码在取消、购买或预留到期之前保留。

此函数返回一个长时间运行的作轮询器，该轮询程序允许无限期等待作完成。

示例用法：

const client = new PhoneNumberAdministrationClient(CONNECTION_STRING);
const reservePoller = await client.beginReservePhoneNumbers(RESERVATION_REQUEST);

// Serializing the poller
const serialized = reservePoller.toString();

// Waiting until it's done
const results = await reservePoller.pollUntilDone();
console.log(results);
cancelReservation(string, OperationOptions)

取消与给定 ID 关联的预留。
configurePhoneNumber(ConfigurePhoneNumberRequest, ConfigurePhoneNumberOptions)

配置电话号码，例如分配 callbackUrl。
getAreaCodes(GetAreaCodesRequest, OperationOptions)

获取基于位置的受支持区号列表。
getCapabilitiesUpdate(string, OperationOptions)

获取与给定 ID 关联的更新功能请求。
getPhoneNumberConfiguration(string, OperationOptions)

获取给定电话号码的配置。
getPhonePlanLocationOptions(GetPhonePlanLocationOptionsRequest, PageableLocalizationOptions)

获取给定电话计划的位置选项。
getReservation(string, OperationOptions)

获取与给定 ID 关联的预留。使用该功能查询电话号码预留状态。
listPhoneNumbers(PageableLocalizationOptions)

迭代获取的电话号码。

示例用法：

let client = new PhoneNumberAdministrationClient(credentials);
for await (const acquired of client.listPhoneNumbers()) {
  console.log("phone number: ", acquired.phoneNumber);
}
listPhonePlanGroups(string, ListPhonePlanGroupsOptions)

迭代某个国家/地区的可用电话套餐组。

示例用法：

let client = new PhoneNumberAdministrationClient(credentials);
for await (const phonePlanGroup of client.listPhonePlanGroups("CA")) {
  console.log("plan group id: ", phonePlanGroup.phonePlanGroupId);
}
listPhonePlans(ListPhonePlansRequest, PageableLocalizationOptions)

迭代计划组的可用电话计划。

示例用法：

let client = new PhoneNumberAdministrationClient(credentials);
for await (const phonePlan of client.listPhonePlanGroups(PLAN_GROUP_INFO)) {
  console.log("plan id: ", phonePlan.phonePlanId);
}

Gets all available phone plans for a given plan group.
@param planGroupInfo Information need to search for plans.
@param options Additional request options.
listReleases(PageableOptions)

迭代 Azure 资源创建的版本。

示例用法：

let client = new PhoneNumberAdministrationClient(credentials);
for await (const entity of client.listReleases()) {
  console.log("id: ", entity.id);
}

获取 Azure 资源创建的所有版本。
listSearches(PageableOptions)

迭代 Azure 资源创建的搜索。

示例用法：

let client = new PhoneNumberAdministrationClient(credentials);
for await (const entity of client.listSearches()) {
  console.log("id: ", entity.id);
}

获取 Azure 资源创建的所有搜索。
listSupportedCountries(PageableLocalizationOptions)

迭代支持的国家/地区。

示例用法：

let client = new PhoneNumberAdministrationClient(credentials);
for await (const country of client.listSupportedCountries()) {
  console.log("country name: ", country.localizedName);
}
unconfigurePhoneNumber(string, OperationOptions)

取消配置电话号码，重置其配置。
updatePhoneNumbersCapabilities(PhoneNumberCapabilitiesUpdates, UpdateCapabilitiesOptions)

更新了电话号码列表的功能。 响应包括创建的更新功能请求的 ID，请记住该 ID 以便对 getCapabilitiesUpdate 进行后续调用。

构造函数详细信息

PhoneNumberAdministrationClient(string, KeyCredential, PhoneNumberAdministrationClientOptions)

使用 Azure KeyCredential 初始化 PhoneNumberAdministrationClient 类的新实例。

new PhoneNumberAdministrationClient(url: string, credential: KeyCredential, options?: PhoneNumberAdministrationClientOptions)

参数

url

string

服务的终结点（例如：https://contoso.eastus.communications.azure.net）。

credential
KeyCredential

用于对服务的请求进行身份验证的对象。 使用 Azure KeyCredential 或 @azure/identity 创建凭据。

options
PhoneNumberAdministrationClientOptions

可选。 用于配置 HTTP 管道的选项。

PhoneNumberAdministrationClient(string, PhoneNumberAdministrationClientOptions)

初始化 PhoneNumberAdministrationClient 类的新实例。

new PhoneNumberAdministrationClient(connectionString: string, options?: PhoneNumberAdministrationClientOptions)

参数

connectionString

string

用于连接到 Azure 通信服务资源的连接字符串。 示例：“endpoint=https://contoso.eastus.communications.azure.net/;accesskey=secret“;

options
PhoneNumberAdministrationClientOptions

可选。 用于配置 HTTP 管道的选项。

PhoneNumberAdministrationClient(string, TokenCredential, PhoneNumberAdministrationClientOptions)

使用 TokenCredential 初始化 PhoneNumberAdministrationClient 类的新实例。

new PhoneNumberAdministrationClient(url: string, credential: TokenCredential, options?: PhoneNumberAdministrationClientOptions)

参数

url

string

服务的终结点（例如：https://contoso.eastus.communications.azure.net）。

credential
TokenCredential

用于对服务的请求进行身份验证的 TokenCredential。

options
PhoneNumberAdministrationClientOptions

可选。 用于配置 HTTP 管道的选项。

方法详细信息

beginPurchaseReservation(string, BeginPurchaseReservationOptions)

开始购买与给定 ID 关联的预留中的电话号码。

此函数返回一个长时间运行的作轮询器，该轮询程序允许无限期等待作完成。

示例用法：

const client = new PhoneNumberAdministrationClient(CONNECTION_STRING);
const purchasePoller = await client.beginPurchaseReservation(RESERVATION_ID);

// Serializing the poller
const serialized = purchasePoller.toString();

// Waiting until it's done
const results = await purchasePoller.pollUntilDone();
console.log(results);

function beginPurchaseReservation(reservationId: string, options?: BeginPurchaseReservationOptions): Promise<PollerLike<PollOperationState<void>, void>>

参数

reservationId

string

要购买的预留的 ID。

options
BeginPurchaseReservationOptions

其他请求选项。

返回

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginReleasePhoneNumbers(string[], BeginReleasePhoneNumbersOptions)

开始发布已获取的电话号码列表。

此函数返回一个长时间运行的作轮询器，该轮询程序允许无限期等待作完成。

示例用法：

const client = new PhoneNumberAdministrationClient(CONNECTION_STRING);
const releasePoller = await client.beginReleasePhoneNumbers(PHONE_NUMBERS);

// Serializing the poller
const serialized = releasePoller.toString();

// Waiting until it's done
const results = await releasePoller.pollUntilDone();
console.log(results);

function beginReleasePhoneNumbers(phoneNumbers: string[], options?: BeginReleasePhoneNumbersOptions): Promise<PollerLike<PollOperationState<PhoneNumberRelease>, PhoneNumberRelease>>

参数

phoneNumbers

string[]

要发布的电话号码。

options
BeginReleasePhoneNumbersOptions

其他请求选项。

返回

Promise<PollerLike<@azure/core-lro.PollOperationState<PhoneNumberRelease>, PhoneNumberRelease>>

beginReservePhoneNumbers(CreateReservationRequest, BeginReservePhoneNumbersOptions)

根据某些约束（如姓名或区号）开始搜索电话号码。 找到的电话号码在取消、购买或预留到期之前保留。

此函数返回一个长时间运行的作轮询器，该轮询程序允许无限期等待作完成。

示例用法：

const client = new PhoneNumberAdministrationClient(CONNECTION_STRING);
const reservePoller = await client.beginReservePhoneNumbers(RESERVATION_REQUEST);

// Serializing the poller
const serialized = reservePoller.toString();

// Waiting until it's done
const results = await reservePoller.pollUntilDone();
console.log(results);

function beginReservePhoneNumbers(reservationRequest: CreateReservationRequest, options?: BeginReservePhoneNumbersOptions): Promise<PollerLike<PollOperationState<PhoneNumberReservation>, PhoneNumberReservation>>

参数

reservationRequest
CreateReservationRequest

请求属性以约束搜索范围。

options
BeginReservePhoneNumbersOptions

其他请求选项。

返回

Promise<PollerLike<@azure/core-lro.PollOperationState<PhoneNumberReservation>, PhoneNumberReservation>>

cancelReservation(string, OperationOptions)

取消与给定 ID 关联的预留。

function cancelReservation(reservationId: string, options?: OperationOptions): Promise<{ _response: HttpResponse }>

参数

reservationId

string

createReservation 返回的预留的 ID。

options
OperationOptions

其他请求选项。

返回

Promise<{ _response: HttpResponse }>

configurePhoneNumber(ConfigurePhoneNumberRequest, ConfigurePhoneNumberOptions)

配置电话号码，例如分配 callbackUrl。

function configurePhoneNumber(config: ConfigurePhoneNumberRequest, options?: ConfigurePhoneNumberOptions): Promise<{ _response: HttpResponse }>

参数

config
ConfigurePhoneNumberRequest

配置详细信息

options
ConfigurePhoneNumberOptions

其他请求选项。

返回

Promise<{ _response: HttpResponse }>

getAreaCodes(GetAreaCodesRequest, OperationOptions)

获取基于位置的受支持区号列表。

function getAreaCodes(request: GetAreaCodesRequest, options?: OperationOptions): Promise<GetAreaCodesResponse>

参数

request
GetAreaCodesRequest

请求属性以约束搜索范围。

options
OperationOptions

其他请求选项。

返回

Promise<GetAreaCodesResponse>

getCapabilitiesUpdate(string, OperationOptions)

获取与给定 ID 关联的更新功能请求。

function getCapabilitiesUpdate(capabilitiesUpdateId: string, options?: OperationOptions): Promise<GetCapabilitiesUpdateResponse>

参数

capabilitiesUpdateId

string

与请求关联的 ID。

options
OperationOptions

其他请求选项。

返回

Promise<GetCapabilitiesUpdateResponse>

getPhoneNumberConfiguration(string, OperationOptions)

获取给定电话号码的配置。

function getPhoneNumberConfiguration(phoneNumber: string, options?: OperationOptions): Promise<GetPhoneNumberConfigurationResponse>

参数

phoneNumber

string

请求其配置的电话号码的 E.164 表示形式。

options
OperationOptions

其他请求选项。

返回

Promise<GetPhoneNumberConfigurationResponse>

getPhonePlanLocationOptions(GetPhonePlanLocationOptionsRequest, PageableLocalizationOptions)

获取给定电话计划的位置选项。

function getPhonePlanLocationOptions(request: GetPhonePlanLocationOptionsRequest, options?: PageableLocalizationOptions): Promise<GetPhonePlanLocationOptionsResponse>

参数

request
GetPhonePlanLocationOptionsRequest

请求属性以约束搜索范围。

options
PageableLocalizationOptions

其他请求选项。

返回

Promise<GetPhonePlanLocationOptionsResponse>

getReservation(string, OperationOptions)

获取与给定 ID 关联的预留。使用该功能查询电话号码预留状态。

function getReservation(reservationId: string, options?: OperationOptions): Promise<GetReservationResponse>

参数

reservationId

string

createReservation 返回的预留的 ID。

options
OperationOptions

其他请求选项。

返回

Promise<GetReservationResponse>

listPhoneNumbers(PageableLocalizationOptions)

迭代获取的电话号码。

示例用法：

let client = new PhoneNumberAdministrationClient(credentials);
for await (const acquired of client.listPhoneNumbers()) {
  console.log("phone number: ", acquired.phoneNumber);
}

function listPhoneNumbers(options?: PageableLocalizationOptions): PagedAsyncIterableIterator<AcquiredPhoneNumber, AcquiredPhoneNumber[], PageSettings>

参数

options
PageableLocalizationOptions

可选参数。

返回

PagedAsyncIterableIterator<AcquiredPhoneNumber, AcquiredPhoneNumber[], PageSettings>

listPhonePlanGroups(string, ListPhonePlanGroupsOptions)

迭代某个国家/地区的可用电话套餐组。

示例用法：

let client = new PhoneNumberAdministrationClient(credentials);
for await (const phonePlanGroup of client.listPhonePlanGroups("CA")) {
  console.log("plan group id: ", phonePlanGroup.phonePlanGroupId);
}

function listPhonePlanGroups(countryCode: string, options?: ListPhonePlanGroupsOptions): PagedAsyncIterableIterator<PhonePlanGroup, PhonePlanGroup[], PageSettings>

参数

countryCode

string

options
ListPhonePlanGroupsOptions

可选参数。

返回

PagedAsyncIterableIterator<PhonePlanGroup, PhonePlanGroup[], PageSettings>

listPhonePlans(ListPhonePlansRequest, PageableLocalizationOptions)

迭代计划组的可用电话计划。

示例用法：

let client = new PhoneNumberAdministrationClient(credentials);
for await (const phonePlan of client.listPhonePlanGroups(PLAN_GROUP_INFO)) {
  console.log("plan id: ", phonePlan.phonePlanId);
}

Gets all available phone plans for a given plan group.
@param planGroupInfo Information need to search for plans.
@param options Additional request options.

function listPhonePlans(planGroupInfo: ListPhonePlansRequest, options?: PageableLocalizationOptions): PagedAsyncIterableIterator<PhonePlan, PhonePlan[], PageSettings>

参数

planGroupInfo
ListPhonePlansRequest
options
PageableLocalizationOptions

返回

PagedAsyncIterableIterator<PhonePlan, PhonePlan[], PageSettings>

listReleases(PageableOptions)

迭代 Azure 资源创建的版本。

示例用法：

let client = new PhoneNumberAdministrationClient(credentials);
for await (const entity of client.listReleases()) {
  console.log("id: ", entity.id);
}

获取 Azure 资源创建的所有版本。

function listReleases(options?: PageableOptions): PagedAsyncIterableIterator<PhoneNumberEntity, PhoneNumberEntity[], PageSettings>

参数

options
PageableOptions

底层 HTTP 请求的可选参数。

返回

PagedAsyncIterableIterator<PhoneNumberEntity, PhoneNumberEntity[], PageSettings>

listSearches(PageableOptions)

迭代 Azure 资源创建的搜索。

示例用法：

let client = new PhoneNumberAdministrationClient(credentials);
for await (const entity of client.listSearches()) {
  console.log("id: ", entity.id);
}

获取 Azure 资源创建的所有搜索。

function listSearches(options?: PageableOptions): PagedAsyncIterableIterator<PhoneNumberEntity, PhoneNumberEntity[], PageSettings>

参数

options
PageableOptions

底层 HTTP 请求的可选参数。

返回

PagedAsyncIterableIterator<PhoneNumberEntity, PhoneNumberEntity[], PageSettings>

listSupportedCountries(PageableLocalizationOptions)

迭代支持的国家/地区。

示例用法：

let client = new PhoneNumberAdministrationClient(credentials);
for await (const country of client.listSupportedCountries()) {
  console.log("country name: ", country.localizedName);
}

function listSupportedCountries(options?: PageableLocalizationOptions): PagedAsyncIterableIterator<PhoneNumberCountry, PhoneNumberCountry[], PageSettings>

参数

options
PageableLocalizationOptions

可选参数。

返回

PagedAsyncIterableIterator<PhoneNumberCountry, PhoneNumberCountry[], PageSettings>

unconfigurePhoneNumber(string, OperationOptions)

取消配置电话号码，重置其配置。

function unconfigurePhoneNumber(phoneNumber: string, options?: OperationOptions): Promise<{ _response: HttpResponse }>

参数

phoneNumber

string

要取消配置的 Phone Number。

options
OperationOptions

其他请求选项。

返回

Promise<{ _response: HttpResponse }>

updatePhoneNumbersCapabilities(PhoneNumberCapabilitiesUpdates, UpdateCapabilitiesOptions)

更新了电话号码列表的功能。 响应包括创建的更新功能请求的 ID，请记住该 ID 以便对 getCapabilitiesUpdate 进行后续调用。

function updatePhoneNumbersCapabilities(phoneNumberCapabilitiesUpdates: PhoneNumberCapabilitiesUpdates, options?: UpdateCapabilitiesOptions): Promise<UpdateNumbersCapabilitiesResponse>

参数

phoneNumberCapabilitiesUpdates
PhoneNumberCapabilitiesUpdates

包含电话号码列表及其功能更新的字典。

options
UpdateCapabilitiesOptions

其他请求选项。

返回

Promise<UpdateNumbersCapabilitiesResponse>