Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Accounts

Package version

Class representing a Accounts.

Hierarchy

  • Accounts

Index

Constructors

Methods

Constructors

constructor

Methods

createOrUpdate

  • createOrUpdate(resourceGroupName: string, accountName: string, mapsAccountCreateParameters: MapsAccountCreateParameters, options?: msRest.RequestOptionsBase): Promise<Models.AccountsCreateOrUpdateResponse>
  • createOrUpdate(resourceGroupName: string, accountName: string, mapsAccountCreateParameters: MapsAccountCreateParameters, callback: msRest.ServiceCallback<MapsAccount>): void
  • createOrUpdate(resourceGroupName: string, accountName: string, mapsAccountCreateParameters: MapsAccountCreateParameters, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<MapsAccount>): void

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

    Parameters

    • resourceGroupName: string

      The name of the Azure Resource Group.

    • accountName: string

      The name of the Maps Account.

    • mapsAccountCreateParameters: MapsAccountCreateParameters

      The new or updated parameters for the Maps Account.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.AccountsCreateOrUpdateResponse>

    Promise<Models.AccountsCreateOrUpdateResponse>

  • Parameters

    • resourceGroupName: string

      The name of the Azure Resource Group.

    • accountName: string

      The name of the Maps Account.

    • mapsAccountCreateParameters: MapsAccountCreateParameters

      The new or updated parameters for the Maps Account.

    • callback: msRest.ServiceCallback<MapsAccount>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the Azure Resource Group.

    • accountName: string

      The name of the Maps Account.

    • mapsAccountCreateParameters: MapsAccountCreateParameters

      The new or updated parameters for the Maps Account.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<MapsAccount>

      The callback

    Returns void

deleteMethod

  • deleteMethod(resourceGroupName: string, accountName: string, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>
  • deleteMethod(resourceGroupName: string, accountName: string, callback: msRest.ServiceCallback<void>): void
  • deleteMethod(resourceGroupName: string, accountName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<void>): void

  • Delete a Maps Account.

    Parameters

    • resourceGroupName: string

      The name of the Azure Resource Group.

    • accountName: string

      The name of the Maps Account.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRest.RestResponse>

    Promise<msRest.RestResponse>

  • Parameters

    • resourceGroupName: string

      The name of the Azure Resource Group.

    • accountName: string

      The name of the Maps Account.

    • callback: msRest.ServiceCallback<void>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the Azure Resource Group.

    • accountName: string

      The name of the Maps Account.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<void>

      The callback

    Returns void

get

  • get(resourceGroupName: string, accountName: string, options?: msRest.RequestOptionsBase): Promise<Models.AccountsGetResponse>
  • get(resourceGroupName: string, accountName: string, callback: msRest.ServiceCallback<MapsAccount>): void
  • get(resourceGroupName: string, accountName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<MapsAccount>): void

  • Get a Maps Account.

    Parameters

    • resourceGroupName: string

      The name of the Azure Resource Group.

    • accountName: string

      The name of the Maps Account.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.AccountsGetResponse>

    Promise<Models.AccountsGetResponse>

  • Parameters

    • resourceGroupName: string

      The name of the Azure Resource Group.

    • accountName: string

      The name of the Maps Account.

    • callback: msRest.ServiceCallback<MapsAccount>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the Azure Resource Group.

    • accountName: string

      The name of the Maps Account.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<MapsAccount>

      The callback

    Returns void

listByResourceGroup

  • listByResourceGroup(resourceGroupName: string, options?: msRest.RequestOptionsBase): Promise<Models.AccountsListByResourceGroupResponse>
  • listByResourceGroup(resourceGroupName: string, callback: msRest.ServiceCallback<MapsAccounts>): void
  • listByResourceGroup(resourceGroupName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<MapsAccounts>): void

  • Get all Maps Accounts in a Resource Group

    Parameters

    • resourceGroupName: string

      The name of the Azure Resource Group.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.AccountsListByResourceGroupResponse>

    Promise<Models.AccountsListByResourceGroupResponse>

  • Parameters

    • resourceGroupName: string

      The name of the Azure Resource Group.

    • callback: msRest.ServiceCallback<MapsAccounts>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the Azure Resource Group.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<MapsAccounts>

      The callback

    Returns void

listBySubscription

  • listBySubscription(options?: msRest.RequestOptionsBase): Promise<Models.AccountsListBySubscriptionResponse>
  • listBySubscription(callback: msRest.ServiceCallback<MapsAccounts>): void
  • listBySubscription(options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<MapsAccounts>): void

  • Get all Maps Accounts in a Subscription

    Parameters

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.AccountsListBySubscriptionResponse>

    Promise<Models.AccountsListBySubscriptionResponse>

  • Parameters

    • callback: msRest.ServiceCallback<MapsAccounts>

      The callback

    Returns void

  • Parameters

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<MapsAccounts>

      The callback

    Returns void

listKeys

  • listKeys(resourceGroupName: string, accountName: string, options?: msRest.RequestOptionsBase): Promise<Models.AccountsListKeysResponse>
  • listKeys(resourceGroupName: string, accountName: string, callback: msRest.ServiceCallback<MapsAccountKeys>): void
  • listKeys(resourceGroupName: string, accountName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<MapsAccountKeys>): void

  • 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

    • resourceGroupName: string

      The name of the Azure Resource Group.

    • accountName: string

      The name of the Maps Account.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.AccountsListKeysResponse>

    Promise<Models.AccountsListKeysResponse>

  • Parameters

    • resourceGroupName: string

      The name of the Azure Resource Group.

    • accountName: string

      The name of the Maps Account.

    • callback: msRest.ServiceCallback<MapsAccountKeys>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the Azure Resource Group.

    • accountName: string

      The name of the Maps Account.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<MapsAccountKeys>

      The callback

    Returns void

listOperations

  • listOperations(options?: msRest.RequestOptionsBase): Promise<Models.AccountsListOperationsResponse>
  • listOperations(callback: msRest.ServiceCallback<MapsOperations>): void
  • listOperations(options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<MapsOperations>): void

  • List operations available for the Maps Resource Provider

    Parameters

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.AccountsListOperationsResponse>

    Promise<Models.AccountsListOperationsResponse>

  • Parameters

    Returns void

  • Parameters

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<MapsOperations>

      The callback

    Returns void

move

  • move(resourceGroupName: string, moveRequest: MapsAccountsMoveRequest, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>
  • move(resourceGroupName: string, moveRequest: MapsAccountsMoveRequest, callback: msRest.ServiceCallback<void>): void
  • move(resourceGroupName: string, moveRequest: MapsAccountsMoveRequest, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<void>): void

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

    Parameters

    • resourceGroupName: string

      The name of the resource group that contains Maps Account to move.

    • moveRequest: MapsAccountsMoveRequest

      The details of the Maps Account move.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRest.RestResponse>

    Promise<msRest.RestResponse>

  • Parameters

    • resourceGroupName: string

      The name of the resource group that contains Maps Account to move.

    • moveRequest: MapsAccountsMoveRequest

      The details of the Maps Account move.

    • callback: msRest.ServiceCallback<void>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the resource group that contains Maps Account to move.

    • moveRequest: MapsAccountsMoveRequest

      The details of the Maps Account move.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<void>

      The callback

    Returns void

regenerateKeys

  • regenerateKeys(resourceGroupName: string, accountName: string, keySpecification: MapsKeySpecification, options?: msRest.RequestOptionsBase): Promise<Models.AccountsRegenerateKeysResponse>
  • regenerateKeys(resourceGroupName: string, accountName: string, keySpecification: MapsKeySpecification, callback: msRest.ServiceCallback<MapsAccountKeys>): void
  • regenerateKeys(resourceGroupName: string, accountName: string, keySpecification: MapsKeySpecification, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<MapsAccountKeys>): void

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

    Parameters

    • resourceGroupName: string

      The name of the Azure Resource Group.

    • accountName: string

      The name of the Maps Account.

    • keySpecification: MapsKeySpecification

      Which key to regenerate: primary or secondary.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.AccountsRegenerateKeysResponse>

    Promise<Models.AccountsRegenerateKeysResponse>

  • Parameters

    • resourceGroupName: string

      The name of the Azure Resource Group.

    • accountName: string

      The name of the Maps Account.

    • keySpecification: MapsKeySpecification

      Which key to regenerate: primary or secondary.

    • callback: msRest.ServiceCallback<MapsAccountKeys>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the Azure Resource Group.

    • accountName: string

      The name of the Maps Account.

    • keySpecification: MapsKeySpecification

      Which key to regenerate: primary or secondary.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<MapsAccountKeys>

      The callback

    Returns void

update

  • update(resourceGroupName: string, accountName: string, mapsAccountUpdateParameters: MapsAccountUpdateParameters, options?: msRest.RequestOptionsBase): Promise<Models.AccountsUpdateResponse>
  • update(resourceGroupName: string, accountName: string, mapsAccountUpdateParameters: MapsAccountUpdateParameters, callback: msRest.ServiceCallback<MapsAccount>): void
  • update(resourceGroupName: string, accountName: string, mapsAccountUpdateParameters: MapsAccountUpdateParameters, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<MapsAccount>): void

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

    Parameters

    • resourceGroupName: string

      The name of the Azure Resource Group.

    • accountName: string

      The name of the Maps Account.

    • mapsAccountUpdateParameters: MapsAccountUpdateParameters

      The updated parameters for the Maps Account.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.AccountsUpdateResponse>

    Promise<Models.AccountsUpdateResponse>

  • Parameters

    • resourceGroupName: string

      The name of the Azure Resource Group.

    • accountName: string

      The name of the Maps Account.

    • mapsAccountUpdateParameters: MapsAccountUpdateParameters

      The updated parameters for the Maps Account.

    • callback: msRest.ServiceCallback<MapsAccount>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the Azure Resource Group.

    • accountName: string

      The name of the Maps Account.

    • mapsAccountUpdateParameters: MapsAccountUpdateParameters

      The updated parameters for the Maps Account.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<MapsAccount>

      The callback

    Returns void

Generated using TypeDoc