@datafire/azure_maps_maps_management v3.0.0
@datafire/azure_maps_maps_management
Client library for Azure Maps Resource Provider
Installation and Usage
npm install --save @datafire/azure_maps_maps_management
let azure_maps_maps_management = require('@datafire/azure_maps_maps_management').create({
access_token: "",
refresh_token: "",
client_id: "",
client_secret: "",
redirect_uri: ""
});
.then(data => {
console.log(data);
});
Description
Resource Provider
Actions
Accounts_ListOperations
List operations available for the Maps Resource Provider
azure_maps_maps_management.Accounts_ListOperations({
"api-version": ""
}, context)
Input
- input
object
- api-version required
string
: Client Api Version.
- api-version required
Output
- output MapsOperations
Accounts_ListBySubscription
Get all Maps Accounts in a Subscription
azure_maps_maps_management.Accounts_ListBySubscription({
"api-version": "",
"subscriptionId": ""
}, context)
Input
- input
object
- api-version required
string
: Client Api Version. - subscriptionId required
string
: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- api-version required
Output
- output MapsAccounts
Accounts_Move
Moves Maps Accounts from one ResourceGroup (or Subscription) to another
azure_maps_maps_management.Accounts_Move({
"api-version": "",
"subscriptionId": "",
"resourceGroupName": "",
"moveRequest": {
"targetResourceGroup": "",
"resourceIds": []
}
}, context)
Input
- input
object
- api-version required
string
: Client Api Version. - subscriptionId required
string
: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. - resourceGroupName required
string
: The name of the resource group that contains Maps Account to move. - moveRequest required MapsAccountsMoveRequest
- api-version required
Output
Output schema unknown
Accounts_ListByResourceGroup
Get all Maps Accounts in a Resource Group
azure_maps_maps_management.Accounts_ListByResourceGroup({
"api-version": "",
"subscriptionId": "",
"resourceGroupName": ""
}, context)
Input
- input
object
- api-version required
string
: Client Api Version. - subscriptionId required
string
: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. - resourceGroupName required
string
: The name of the Azure Resource Group.
- api-version required
Output
- output MapsAccounts
Accounts_Delete
Delete a Maps Account.
azure_maps_maps_management.Accounts_Delete({
"api-version": "",
"subscriptionId": "",
"resourceGroupName": "",
"accountName": ""
}, context)
Input
- input
object
- api-version required
string
: Client Api Version. - subscriptionId required
string
: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. - resourceGroupName required
string
: The name of the Azure Resource Group. - accountName required
string
: The name of the Maps Account.
- api-version required
Output
Output schema unknown
Accounts_Get
Get a Maps Account.
azure_maps_maps_management.Accounts_Get({
"api-version": "",
"subscriptionId": "",
"resourceGroupName": "",
"accountName": ""
}, context)
Input
- input
object
- api-version required
string
: Client Api Version. - subscriptionId required
string
: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. - resourceGroupName required
string
: The name of the Azure Resource Group. - accountName required
string
: The name of the Maps Account.
- api-version required
Output
- output MapsAccount
Accounts_Update
Updates a Maps Account. Only a subset of the parameters may be updated after creation, such as Sku and Tags.
azure_maps_maps_management.Accounts_Update({
"api-version": "",
"subscriptionId": "",
"resourceGroupName": "",
"accountName": "",
"MapsAccountUpdateParameters": {}
}, context)
Input
- input
object
- api-version required
string
: Client Api Version. - subscriptionId required
string
: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. - resourceGroupName required
string
: The name of the Azure Resource Group. - accountName required
string
: The name of the Maps Account. - MapsAccountUpdateParameters required MapsAccountUpdateParameters
- api-version required
Output
- output MapsAccount
Accounts_CreateOrUpdate
Create or update a Maps Account. A Maps Account holds the keys which allow access to the Maps REST APIs.
azure_maps_maps_management.Accounts_CreateOrUpdate({
"api-version": "",
"subscriptionId": "",
"resourceGroupName": "",
"accountName": "",
"MapsAccountCreateParameters": {
"location": "",
"sku": null
}
}, context)
Input
- input
object
- api-version required
string
: Client Api Version. - subscriptionId required
string
: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. - resourceGroupName required
string
: The name of the Azure Resource Group. - accountName required
string
: The name of the Maps Account. - MapsAccountCreateParameters required MapsAccountCreateParameters
- api-version required
Output
- output MapsAccount
Accounts_ListKeys
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.
azure_maps_maps_management.Accounts_ListKeys({
"api-version": "",
"subscriptionId": "",
"resourceGroupName": "",
"accountName": ""
}, context)
Input
- input
object
- api-version required
string
: Client Api Version. - subscriptionId required
string
: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. - resourceGroupName required
string
: The name of the Azure Resource Group. - accountName required
string
: The name of the Maps Account.
- api-version required
Output
- output MapsAccountKeys
Accounts_RegenerateKeys
Regenerate either the primary or secondary key for use with the Maps APIs. The old key will stop working immediately.
azure_maps_maps_management.Accounts_RegenerateKeys({
"api-version": "",
"subscriptionId": "",
"resourceGroupName": "",
"accountName": "",
"keySpecification": {
"keyType": ""
}
}, context)
Input
- input
object
- api-version required
string
: Client Api Version. - subscriptionId required
string
: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. - resourceGroupName required
string
: The name of the Azure Resource Group. - accountName required
string
: The name of the Maps Account. - keySpecification required MapsKeySpecification
- api-version required
Output
- output MapsAccountKeys
Definitions
Error
- Error
object
: This object is returned when an error occurs in the Maps API- code
string
: Error code. - details
array
: If available, a list of additional details about the error.- items
object
- code
string
: Error code. - message
string
: If available, a human readable description of the error. - target
string
: If available, the component generating the error.
- code
- items
- message
string
: If available, a human readable description of the error. - target
string
: If available, the component generating the error.
- code
MapsAccount
- MapsAccount
object
: An Azure resource which represents access to a suite of Maps REST APIs.- location
string
: The location of the resource. - properties MapsAccountProperties
- sku Sku
- tags
object
: 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. - id
string
: The fully qualified Maps Account resource identifier. - name
string
: The name of the Maps Account, which is unique within a Resource Group. - type
string
: Azure resource type.
- location
MapsAccountCreateParameters
- MapsAccountCreateParameters
object
: Parameters used to create a new Maps Account.- location required
string
: The location of the resource. - sku required Sku
- tags
object
: 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.
- location required
MapsAccountKeys
- MapsAccountKeys
object
: The set of keys which can be used to access the Maps REST APIs. Two keys are provided for key rotation without interruption.- id
string
: The full Azure resource identifier of the Maps Account. - primaryKey
string
: The primary key for accessing the Maps REST APIs. - secondaryKey
string
: The secondary key for accessing the Maps REST APIs.
- id
MapsAccountProperties
- MapsAccountProperties
object
: Additional Map account properties- x-ms-client-id
string
: A unique identifier for the maps account
- x-ms-client-id
MapsAccountUpdateParameters
- MapsAccountUpdateParameters
object
: Parameters used to update an existing Maps Account.- sku Sku
- tags
object
: 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.
MapsAccounts
- MapsAccounts
object
: A list of Maps Accounts.- value
array
: a Maps Account.- items MapsAccount
- value
MapsAccountsMoveRequest
- MapsAccountsMoveRequest
object
: The description of what resources to move between resource groups.- resourceIds required
array
: A list of resource names to move from the source resource group.- items
string
- items
- targetResourceGroup required
string
: The name of the destination resource group.
- resourceIds required
MapsKeySpecification
- MapsKeySpecification
object
: Whether the operation refers to the primary or secondary key.- keyType required
string
(values: primary, secondary): Whether the operation refers to the primary or secondary key.
- keyType required
MapsOperations
- MapsOperations
object
: The set of operations available for Maps.- value
array
: An operation available for Maps.- items
object
- display
object
: The human-readable description of the operation.- description
string
: The description of the operation. - operation
string
: The action that users can perform, based on their permission level. - provider
string
: Service provider: Microsoft Maps. - resource
string
: Resource on which the operation is performed.
- description
- name
string
: Operation name: {provider}/{resource}/{operation}. - origin
string
: The origin of the operation.
- display
- items
- value
Resource
- Resource
object
: An Azure resource- id
string
: The fully qualified Maps Account resource identifier. - name
string
: The name of the Maps Account, which is unique within a Resource Group. - type
string
: Azure resource type.
- id
Sku
- Sku
object
: The SKU of the Maps Account.- name required
string
: The name of the SKU, in standard format (such as S0). - tier
string
: Gets the sku tier. This is based on the SKU name.
- name required
5 years ago