Share via

LocationOperations Class

  • Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

BatchManagementClient's

<xref:location> attribute.

Inheritance
builtins.object
LocationOperations

Constructor

LocationOperations(*args, **kwargs)

Methods

check_name_availability

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

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

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

check_name_availability

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

check_name_availability(location_name: str, parameters: _models.CheckNameAvailabilityParameters, *, content_type: str = 'application/json', **kwargs: Any) -> _models.CheckNameAvailabilityResult

Parameters

Name Description
location_name
Required
str

The desired region for the name check. Required.
parameters
Required
CheckNameAvailabilityParameters or IO[bytes]

Properties needed to check the availability of a name. Is either a CheckNameAvailabilityParameters type or a IO[bytes] type. Required.

Returns

Type Description
CheckNameAvailabilityResult

CheckNameAvailabilityResult or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get_quotas

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

get_quotas(location_name: str, **kwargs: Any) -> BatchLocationQuota

Parameters

Name Description
location_name
Required
str

The region for which to retrieve Batch service quotas. Required.

Returns

Type Description
BatchLocationQuota

BatchLocationQuota or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list_supported_virtual_machine_skus

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

list_supported_virtual_machine_skus(location_name: str, maxresults: int | None = None, filter: str | None = None, **kwargs: Any) -> Iterable[SupportedSku]

Parameters

Name Description
location_name
Required
str

The region for which to retrieve Batch service supported SKUs. Required.
maxresults
Required
int

The maximum number of items to return in the response. Default value is None.
filter
Required
str

OData filter expression. Valid properties for filtering are "familyName". Default value is None.

Returns

Type Description
ItemPaged[SupportedSku]

An iterator like instance of either SupportedSku or the result of cls(response)

Exceptions

Type Description
HttpResponseError

Attributes

models 

models = <module 'azure.mgmt.batch.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\batch\\models\\__init__.py'>