azure.mgmt.maps.operations module

class azure.mgmt.maps.operations.AccountsOperations(client, config, serializer, deserializer)[source]

Bases: object

AccountsOperations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An object model deserializer.
Variables:

api_version – Client Api Version. Constant value: “2018-05-01”.

create_or_update(resource_group_name, account_name, maps_account_create_parameters, custom_headers=None, raw=False, **operation_config)[source]

Create or update a Maps Account. A Maps Account holds the keys which allow access to the Maps REST APIs.

Parameters:
  • resource_group_name (str) – The name of the Azure Resource Group.
  • account_name (str) – The name of the Maps Account.
  • maps_account_create_parameters (MapsAccountCreateParameters) – The new or updated parameters for the Maps Account.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

MapsAccount or ClientRawResponse if raw=true

Return type:

MapsAccount or ClientRawResponse

Raises:

ErrorException

delete(resource_group_name, account_name, custom_headers=None, raw=False, **operation_config)[source]

Delete a Maps Account.

Parameters:
  • resource_group_name (str) – The name of the Azure Resource Group.
  • account_name (str) – The name of the Maps Account.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

None or ClientRawResponse if raw=true

Return type:

None or ClientRawResponse

Raises:

ErrorException

get(resource_group_name, account_name, custom_headers=None, raw=False, **operation_config)[source]

Get a Maps Account.

Parameters:
  • resource_group_name (str) – The name of the Azure Resource Group.
  • account_name (str) – The name of the Maps Account.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

MapsAccount or ClientRawResponse if raw=true

Return type:

MapsAccount or ClientRawResponse

Raises:

ErrorException

list_by_resource_group(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]

Get all Maps Accounts in a Resource Group.

Parameters:
  • resource_group_name (str) – The name of the Azure Resource Group.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

An iterator like instance of MapsAccount

Return type:

MapsAccountPaged[MapsAccount]

Raises:

ErrorException

list_by_subscription(custom_headers=None, raw=False, **operation_config)[source]

Get all Maps Accounts in a Subscription.

Parameters:
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

An iterator like instance of MapsAccount

Return type:

MapsAccountPaged[MapsAccount]

Raises:

ErrorException

list_keys(resource_group_name, account_name, custom_headers=None, raw=False, **operation_config)[source]

Get the keys to use with the Maps APIs. A key is used to authenticate and authorize access to the Maps REST APIs. Only one key is needed at a time; two are given to provide seamless key regeneration.

Parameters:
  • resource_group_name (str) – The name of the Azure Resource Group.
  • account_name (str) – The name of the Maps Account.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

MapsAccountKeys or ClientRawResponse if raw=true

Return type:

MapsAccountKeys or ClientRawResponse

Raises:

ErrorException

list_operations(custom_headers=None, raw=False, **operation_config)[source]

List operations available for the Maps Resource Provider.

Parameters:
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

An iterator like instance of MapsOperationsValueItem

Return type:

MapsOperationsValueItemPaged[MapsOperationsValueItem]

Raises:

ErrorException

move(resource_group_name, target_resource_group, resource_ids, custom_headers=None, raw=False, **operation_config)[source]

Moves Maps Accounts from one ResourceGroup (or Subscription) to another.

Parameters:
  • resource_group_name (str) – The name of the resource group that contains Maps Account to move.
  • target_resource_group (str) – The name of the destination resource group.
  • resource_ids (list[str]) – A list of resource names to move from the source resource group.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

None or ClientRawResponse if raw=true

Return type:

None or ClientRawResponse

Raises:

ErrorException

regenerate_keys(resource_group_name, account_name, key_type, custom_headers=None, raw=False, **operation_config)[source]

Regenerate either the primary or secondary key for use with the Maps APIs. The old key will stop working immediately.

Parameters:
  • resource_group_name (str) – The name of the Azure Resource Group.
  • account_name (str) – The name of the Maps Account.
  • key_type (str or KeyType) – Whether the operation refers to the primary or secondary key. Possible values include: ‘primary’, ‘secondary’
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

MapsAccountKeys or ClientRawResponse if raw=true

Return type:

MapsAccountKeys or ClientRawResponse

Raises:

ErrorException

update(resource_group_name, account_name, tags=None, sku=None, custom_headers=None, raw=False, **operation_config)[source]

Updates a Maps Account. Only a subset of the parameters may be updated after creation, such as Sku and Tags.

Parameters:
  • resource_group_name (str) – The name of the Azure Resource Group.
  • account_name (str) – The name of the Maps Account.
  • tags (dict[str, str]) – Gets or sets a list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters.
  • sku (Sku) – The SKU of this account.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

MapsAccount or ClientRawResponse if raw=true

Return type:

MapsAccount or ClientRawResponse

Raises:

ErrorException

models = <module 'azure.mgmt.maps.models' from '/usr/lib/python3/dist-packages/azure/mgmt/maps/models/__init__.py'>