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

BatchAccountOperations interface

表示 BatchAccountOperations 的接口。

方法

beginCreate(string, string, BatchAccountCreateParameters, BatchAccountCreateOptionalParams)

使用指定的参数创建新的 Batch 帐户。 现有帐户不能使用此 API 进行更新,应改为使用更新 Batch 帐户 API 进行更新。

beginCreateAndWait(string, string, BatchAccountCreateParameters, BatchAccountCreateOptionalParams)

使用指定的参数创建新的 Batch 帐户。 现有帐户不能使用此 API 进行更新,应改为使用更新 Batch 帐户 API 进行更新。

beginDelete(string, string, BatchAccountDeleteOptionalParams)

删除指定的 Batch 帐户。

beginDeleteAndWait(string, string, BatchAccountDeleteOptionalParams)

删除指定的 Batch 帐户。

get(string, string, BatchAccountGetOptionalParams)

获取有关指定 Batch 帐户的信息。

getDetector(string, string, string, BatchAccountGetDetectorOptionalParams)

获取有关给定 Batch 帐户的给定检测器的信息。

getKeys(string, string, BatchAccountGetKeysOptionalParams)

此作仅适用于包含“SharedKey”的 allowedAuthenticationModes 的 Batch 帐户。 如果 Batch 帐户在其 allowedAuthenticationMode 中不包含“SharedKey”,则客户端无法使用共享密钥进行身份验证,并且必须改用另一个 allowedAuthenticationModes。 在这种情况下,获取密钥将失败。

list(BatchAccountListOptionalParams)

获取与订阅关联的 Batch 帐户的相关信息。

listByResourceGroup(string, BatchAccountListByResourceGroupOptionalParams)

获取与指定资源组关联的 Batch 帐户的相关信息。

listDetectors(string, string, BatchAccountListDetectorsOptionalParams)

获取有关给定 Batch 帐户可用的检测器的信息。

listOutboundNetworkDependenciesEndpoints(string, string, BatchAccountListOutboundNetworkDependenciesEndpointsOptionalParams)

列出此 Batch 帐户下 Batch 计算节点可以调用的终结点,作为 Batch 服务管理的一部分。 如果要在指定的虚拟网络内部署池,必须确保网络允许对这些终结点进行出站访问。 未能允许访问这些终结点可能会导致 Batch 将受影响的节点标记为不可用。 有关在虚拟网络中创建池的详细信息,请参阅 https://docs.microsoft.com/azure/batch/batch-virtual-network

regenerateKey(string, string, BatchAccountRegenerateKeyParameters, BatchAccountRegenerateKeyOptionalParams)

此作仅适用于包含“SharedKey”的 allowedAuthenticationModes 的 Batch 帐户。 如果 Batch 帐户在其 allowedAuthenticationMode 中不包含“SharedKey”,则客户端无法使用共享密钥进行身份验证,并且必须改用另一个 allowedAuthenticationModes。 在这种情况下,重新生成密钥将失败。

synchronizeAutoStorageKeys(string, string, BatchAccountSynchronizeAutoStorageKeysOptionalParams)

仅当使用存储密钥身份验证时,才会同步为指定的 Batch 帐户配置的自动存储帐户的访问密钥。

update(string, string, BatchAccountUpdateParameters, BatchAccountUpdateOptionalParams)

更新现有 Batch 帐户的属性。

方法详细信息

beginCreate(string, string, BatchAccountCreateParameters, BatchAccountCreateOptionalParams)

使用指定的参数创建新的 Batch 帐户。 现有帐户不能使用此 API 进行更新,应改为使用更新 Batch 帐户 API 进行更新。

function beginCreate(resourceGroupName: string, accountName: string, parameters: BatchAccountCreateParameters, options?: BatchAccountCreateOptionalParams): Promise<SimplePollerLike<OperationState<BatchAccount>, BatchAccount>>

参数

resourceGroupName

string

包含 Batch 帐户的资源组的名称。

accountName

string

Batch 帐户的名称,该帐户在区域中必须唯一。 Batch 帐户名称长度必须介于 3 到 24 个字符之间,并且只能使用数字和小写字母。 此名称用作 DNS 名称的一部分,用于访问在其中创建帐户的区域中的 Batch 服务。 例如:http://accountname.region.batch.azure.com/

parameters
BatchAccountCreateParameters

用于创建帐户的其他参数。

options
BatchAccountCreateOptionalParams

选项参数。

返回

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

beginCreateAndWait(string, string, BatchAccountCreateParameters, BatchAccountCreateOptionalParams)

使用指定的参数创建新的 Batch 帐户。 现有帐户不能使用此 API 进行更新,应改为使用更新 Batch 帐户 API 进行更新。

function beginCreateAndWait(resourceGroupName: string, accountName: string, parameters: BatchAccountCreateParameters, options?: BatchAccountCreateOptionalParams): Promise<BatchAccount>

参数

resourceGroupName

string

包含 Batch 帐户的资源组的名称。

accountName

string

Batch 帐户的名称,该帐户在区域中必须唯一。 Batch 帐户名称长度必须介于 3 到 24 个字符之间,并且只能使用数字和小写字母。 此名称用作 DNS 名称的一部分,用于访问在其中创建帐户的区域中的 Batch 服务。 例如:http://accountname.region.batch.azure.com/

parameters
BatchAccountCreateParameters

用于创建帐户的其他参数。

options
BatchAccountCreateOptionalParams

选项参数。

返回

Promise<BatchAccount>

beginDelete(string, string, BatchAccountDeleteOptionalParams)

删除指定的 Batch 帐户。

function beginDelete(resourceGroupName: string, accountName: string, options?: BatchAccountDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

参数

resourceGroupName

string

包含 Batch 帐户的资源组的名称。

accountName

string

Batch 帐户的名称。

options
BatchAccountDeleteOptionalParams

选项参数。

返回

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

beginDeleteAndWait(string, string, BatchAccountDeleteOptionalParams)

删除指定的 Batch 帐户。

function beginDeleteAndWait(resourceGroupName: string, accountName: string, options?: BatchAccountDeleteOptionalParams): Promise<void>

参数

resourceGroupName

string

包含 Batch 帐户的资源组的名称。

accountName

string

Batch 帐户的名称。

options
BatchAccountDeleteOptionalParams

选项参数。

返回

Promise<void>

get(string, string, BatchAccountGetOptionalParams)

获取有关指定 Batch 帐户的信息。

function get(resourceGroupName: string, accountName: string, options?: BatchAccountGetOptionalParams): Promise<BatchAccount>

参数

resourceGroupName

string

包含 Batch 帐户的资源组的名称。

accountName

string

Batch 帐户的名称。

options
BatchAccountGetOptionalParams

选项参数。

返回

Promise<BatchAccount>

getDetector(string, string, string, BatchAccountGetDetectorOptionalParams)

获取有关给定 Batch 帐户的给定检测器的信息。

function getDetector(resourceGroupName: string, accountName: string, detectorId: string, options?: BatchAccountGetDetectorOptionalParams): Promise<DetectorResponse>

参数

resourceGroupName

string

包含 Batch 帐户的资源组的名称。

accountName

string

Batch 帐户的名称。

detectorId

string

检测器的名称。

options
BatchAccountGetDetectorOptionalParams

选项参数。

返回

Promise<DetectorResponse>

getKeys(string, string, BatchAccountGetKeysOptionalParams)

此作仅适用于包含“SharedKey”的 allowedAuthenticationModes 的 Batch 帐户。 如果 Batch 帐户在其 allowedAuthenticationMode 中不包含“SharedKey”,则客户端无法使用共享密钥进行身份验证,并且必须改用另一个 allowedAuthenticationModes。 在这种情况下,获取密钥将失败。

function getKeys(resourceGroupName: string, accountName: string, options?: BatchAccountGetKeysOptionalParams): Promise<BatchAccountKeys>

参数

resourceGroupName

string

包含 Batch 帐户的资源组的名称。

accountName

string

Batch 帐户的名称。

options
BatchAccountGetKeysOptionalParams

选项参数。

返回

Promise<BatchAccountKeys>

list(BatchAccountListOptionalParams)

获取与订阅关联的 Batch 帐户的相关信息。

function list(options?: BatchAccountListOptionalParams): PagedAsyncIterableIterator<BatchAccount, BatchAccount[], PageSettings>

参数

options
BatchAccountListOptionalParams

选项参数。

返回

listByResourceGroup(string, BatchAccountListByResourceGroupOptionalParams)

获取与指定资源组关联的 Batch 帐户的相关信息。

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

参数

resourceGroupName

string

包含 Batch 帐户的资源组的名称。

返回

listDetectors(string, string, BatchAccountListDetectorsOptionalParams)

获取有关给定 Batch 帐户可用的检测器的信息。

function listDetectors(resourceGroupName: string, accountName: string, options?: BatchAccountListDetectorsOptionalParams): PagedAsyncIterableIterator<DetectorResponse, DetectorResponse[], PageSettings>

参数

resourceGroupName

string

包含 Batch 帐户的资源组的名称。

accountName

string

Batch 帐户的名称。

options
BatchAccountListDetectorsOptionalParams

选项参数。

返回

listOutboundNetworkDependenciesEndpoints(string, string, BatchAccountListOutboundNetworkDependenciesEndpointsOptionalParams)

列出此 Batch 帐户下 Batch 计算节点可以调用的终结点,作为 Batch 服务管理的一部分。 如果要在指定的虚拟网络内部署池,必须确保网络允许对这些终结点进行出站访问。 未能允许访问这些终结点可能会导致 Batch 将受影响的节点标记为不可用。 有关在虚拟网络中创建池的详细信息,请参阅 https://docs.microsoft.com/azure/batch/batch-virtual-network

function listOutboundNetworkDependenciesEndpoints(resourceGroupName: string, accountName: string, options?: BatchAccountListOutboundNetworkDependenciesEndpointsOptionalParams): PagedAsyncIterableIterator<OutboundEnvironmentEndpoint, OutboundEnvironmentEndpoint[], PageSettings>

参数

resourceGroupName

string

包含 Batch 帐户的资源组的名称。

accountName

string

Batch 帐户的名称。

返回

regenerateKey(string, string, BatchAccountRegenerateKeyParameters, BatchAccountRegenerateKeyOptionalParams)

此作仅适用于包含“SharedKey”的 allowedAuthenticationModes 的 Batch 帐户。 如果 Batch 帐户在其 allowedAuthenticationMode 中不包含“SharedKey”,则客户端无法使用共享密钥进行身份验证,并且必须改用另一个 allowedAuthenticationModes。 在这种情况下,重新生成密钥将失败。

function regenerateKey(resourceGroupName: string, accountName: string, parameters: BatchAccountRegenerateKeyParameters, options?: BatchAccountRegenerateKeyOptionalParams): Promise<BatchAccountKeys>

参数

resourceGroupName

string

包含 Batch 帐户的资源组的名称。

accountName

string

Batch 帐户的名称。

parameters
BatchAccountRegenerateKeyParameters

要重新生成的密钥的类型。

options
BatchAccountRegenerateKeyOptionalParams

选项参数。

返回

Promise<BatchAccountKeys>

synchronizeAutoStorageKeys(string, string, BatchAccountSynchronizeAutoStorageKeysOptionalParams)

仅当使用存储密钥身份验证时,才会同步为指定的 Batch 帐户配置的自动存储帐户的访问密钥。

function synchronizeAutoStorageKeys(resourceGroupName: string, accountName: string, options?: BatchAccountSynchronizeAutoStorageKeysOptionalParams): Promise<void>

参数

resourceGroupName

string

包含 Batch 帐户的资源组的名称。

accountName

string

Batch 帐户的名称。

返回

Promise<void>

update(string, string, BatchAccountUpdateParameters, BatchAccountUpdateOptionalParams)

更新现有 Batch 帐户的属性。

function update(resourceGroupName: string, accountName: string, parameters: BatchAccountUpdateParameters, options?: BatchAccountUpdateOptionalParams): Promise<BatchAccount>

参数

resourceGroupName

string

包含 Batch 帐户的资源组的名称。

accountName

string

Batch 帐户的名称。

parameters
BatchAccountUpdateParameters

帐户更新的其他参数。

options
BatchAccountUpdateOptionalParams

选项参数。

返回

Promise<BatchAccount>