Share via

Location interface

  • Reference
Package:
@azure/arm-batch

Interface representing a Location.

Methods

checkNameAvailability(string, CheckNameAvailabilityParameters, LocationCheckNameAvailabilityOptionalParams)

Checks whether the Batch account name is available in the specified region.
getQuotas(string, LocationGetQuotasOptionalParams)

Gets the Batch service quotas for the specified subscription at the given location.
listSupportedCloudServiceSkus(string, LocationListSupportedCloudServiceSkusOptionalParams)

Gets the list of Batch supported Cloud Service VM sizes available at the given location.
listSupportedVirtualMachineSkus(string, LocationListSupportedVirtualMachineSkusOptionalParams)

Gets the list of Batch supported Virtual Machine VM sizes available at the given location.

Method Details

checkNameAvailability(string, CheckNameAvailabilityParameters, LocationCheckNameAvailabilityOptionalParams)

Checks whether the Batch account name is available in the specified region.

function checkNameAvailability(locationName: string, parameters: CheckNameAvailabilityParameters, options?: LocationCheckNameAvailabilityOptionalParams): Promise<CheckNameAvailabilityResult>

Parameters

locationName

string

The desired region for the name check.

parameters
CheckNameAvailabilityParameters

Properties needed to check the availability of a name.

options
LocationCheckNameAvailabilityOptionalParams

The options parameters.

Returns

Promise<CheckNameAvailabilityResult>

getQuotas(string, LocationGetQuotasOptionalParams)

Gets the Batch service quotas for the specified subscription at the given location.

function getQuotas(locationName: string, options?: LocationGetQuotasOptionalParams): Promise<BatchLocationQuota>

Parameters

locationName

string

The region for which to retrieve Batch service quotas.

options
LocationGetQuotasOptionalParams

The options parameters.

Returns

Promise<BatchLocationQuota>

listSupportedCloudServiceSkus(string, LocationListSupportedCloudServiceSkusOptionalParams)

Gets the list of Batch supported Cloud Service VM sizes available at the given location.

function listSupportedCloudServiceSkus(locationName: string, options?: LocationListSupportedCloudServiceSkusOptionalParams): PagedAsyncIterableIterator<SupportedSku, SupportedSku[], PageSettings>

Parameters

locationName

string

The region for which to retrieve Batch service supported SKUs.

options
LocationListSupportedCloudServiceSkusOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<SupportedSku, SupportedSku[], PageSettings>

listSupportedVirtualMachineSkus(string, LocationListSupportedVirtualMachineSkusOptionalParams)

Gets the list of Batch supported Virtual Machine VM sizes available at the given location.

function listSupportedVirtualMachineSkus(locationName: string, options?: LocationListSupportedVirtualMachineSkusOptionalParams): PagedAsyncIterableIterator<SupportedSku, SupportedSku[], PageSettings>

Parameters

locationName

string

The region for which to retrieve Batch service supported SKUs.

options
LocationListSupportedVirtualMachineSkusOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<SupportedSku, SupportedSku[], PageSettings>