azure.mgmt.maps.models module¶
-
exception
azure.mgmt.maps.models.
ErrorException
(deserialize, response, *args)[source]¶ Bases:
msrest.exceptions.HttpOperationError
Server responsed with exception of type: ‘Error’.
- Parameters
deserialize – A deserializer
response – Server response to be deserialized.
-
class
azure.mgmt.maps.models.
Error
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
This object is returned when an error occurs in the Maps API.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
code (str) – Error code.
message (str) – If available, a human readable description of the error.
target (str) – If available, the component generating the error.
details (list[ErrorDetailsItem]) – If available, a list of additional details about the error.
-
class
azure.mgmt.maps.models.
ErrorDetailsItem
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
ErrorDetailsItem.
Variables are only populated by the server, and will be ignored when sending a request.
-
class
azure.mgmt.maps.models.
KeyType
(value)[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
primary
= 'primary'¶
-
secondary
= 'secondary'¶
-
-
class
azure.mgmt.maps.models.
MapsAccount
(**kwargs)[source]¶ Bases:
azure.mgmt.maps.models.resource.Resource
An Azure resource which represents access to a suite of Maps REST APIs.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
id (str) – The fully qualified Maps Account resource identifier.
name (str) – The name of the Maps Account, which is unique within a Resource Group.
type (str) – Azure resource type.
location (str) – The location of the resource.
tags (dict[str, str]) – Gets 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.
-
class
azure.mgmt.maps.models.
MapsAccountCreateParameters
(*, location: str, sku, tags=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Parameters used to create a new Maps Account.
All required parameters must be populated in order to send to Azure.
- Parameters
location (str) – Required. The location of the resource.
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) – Required. The SKU of this account.
-
class
azure.mgmt.maps.models.
MapsAccountKeys
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
The set of keys which can be used to access the Maps REST APIs. Two keys are provided for key rotation without interruption.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
id (str) – The full Azure resource identifier of the Maps Account.
primary_key (str) – The primary key for accessing the Maps REST APIs.
secondary_key (str) – The secondary key for accessing the Maps REST APIs.
-
class
azure.mgmt.maps.models.
MapsAccountPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
MapsAccount
objectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
class
azure.mgmt.maps.models.
MapsAccountUpdateParameters
(*, tags=None, sku=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Parameters used to update an existing Maps Account.
- Parameters
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.
-
class
azure.mgmt.maps.models.
MapsAccountsMoveRequest
(*, target_resource_group: str, resource_ids, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The description of what resources to move between resource groups.
All required parameters must be populated in order to send to Azure.
- Parameters
target_resource_group (str) – Required. The name of the destination resource group.
resource_ids (list[str]) – Required. A list of resource names to move from the source resource group.
-
class
azure.mgmt.maps.models.
MapsKeySpecification
(*, key_type, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Whether the operation refers to the primary or secondary key.
All required parameters must be populated in order to send to Azure.
- Parameters
key_type (str or KeyType) – Required. Whether the operation refers to the primary or secondary key. Possible values include: ‘primary’, ‘secondary’
-
class
azure.mgmt.maps.models.
MapsOperationsValueItem
(*, display=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
MapsOperationsValueItem.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
name (str) – Operation name: {provider}/{resource}/{operation}.
origin (str) – The origin of the operation.
- Parameters
display (MapsOperationsValueItemDisplay) – The human-readable description of the operation.
-
class
azure.mgmt.maps.models.
MapsOperationsValueItemDisplay
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
The human-readable description of the operation.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
provider (str) – Service provider: Microsoft Maps.
resource (str) – Resource on which the operation is performed.
operation (str) – The action that users can perform, based on their permission level.
description (str) – The description of the operation.
-
class
azure.mgmt.maps.models.
MapsOperationsValueItemPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
MapsOperationsValueItem
objectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
class
azure.mgmt.maps.models.
Resource
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
An Azure resource.
Variables are only populated by the server, and will be ignored when sending a request.
-
class
azure.mgmt.maps.models.
Sku
(*, name: str, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The SKU of the Maps Account.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Parameters
name (str) – Required. The name of the SKU, in standard format (such as S0).
- Variables
tier (str) – Gets the sku tier. This is based on the SKU name.