MapsAccount Interface

Package:

com.azure.resourcemanager.maps.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-maps:1.0.0

public interface MapsAccount

An immutable client-side representation of MapsAccount.

Method Summary

Modifier and Type	Method and Description
abstract String	id() Gets the id property: Fully qualified resource Id for the resource.
abstract ManagedServiceIdentity	identity() Gets the identity property: Managed service identity (system assigned and/or user assigned identities).
abstract MapsAccountInner	innerModel() Gets the inner com.azure.resourcemanager.maps.fluent.models.MapsAccountInner object.
abstract Kind	kind() Gets the kind property: Get or Set Kind property.
abstract MapsAccountKeys	listKeys() Get the keys to use with the Maps APIs.
abstract Response<MapsAccountKeys>	listKeysWithResponse(Context context) Get the keys to use with the Maps APIs.
abstract MapsAccountSasToken	listSas(AccountSasParameters mapsAccountSasParameters) Create and list an account shared access signature token.
abstract Response<MapsAccountSasToken>	listSasWithResponse(AccountSasParameters mapsAccountSasParameters, Context context) Create and list an account shared access signature token.
abstract String	location() Gets the location property: The geo-location where the resource lives.
abstract String	name() Gets the name property: The name of the resource.
abstract MapsAccountProperties	properties() Gets the properties property: The map account properties.
abstract MapsAccount	refresh() Refreshes the resource to sync with Azure.
abstract MapsAccount	refresh(Context context) Refreshes the resource to sync with Azure.
abstract MapsAccountKeys	regenerateKeys(MapsKeySpecification keySpecification) Regenerate either the primary or secondary key for use with the Maps APIs.
abstract Response<MapsAccountKeys>	regenerateKeysWithResponse(MapsKeySpecification keySpecification, Context context) Regenerate either the primary or secondary key for use with the Maps APIs.
abstract Region	region() Gets the region of the resource.
abstract String	regionName() Gets the name of the resource region.
abstract String	resourceGroupName() Gets the name of the resource group.
abstract Sku	sku() Gets the sku property: The SKU of this account.
abstract SystemData	systemData() Gets the systemData property: Metadata pertaining to creation and last modification of the resource.
abstract Map<String,String>	tags() Gets the tags property: Resource tags.
abstract String	type() Gets the type property: The type of the resource.
abstract Update	update() Begins update for the MapsAccount resource.

Method Details

id

public abstract String id()

Gets the id property: Fully qualified resource Id for the resource.

Returns:

the id value.

identity

public abstract ManagedServiceIdentity identity()

Gets the identity property: Managed service identity (system assigned and/or user assigned identities).

Returns:

the identity value.

innerModel

public abstract MapsAccountInner innerModel()

Gets the inner com.azure.resourcemanager.maps.fluent.models.MapsAccountInner object.

Returns:

the inner object.

kind

public abstract Kind kind()

Gets the kind property: Get or Set Kind property.

Returns:

the kind value.

listKeys

public abstract MapsAccountKeys 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.

Returns:

the keys to use with the Maps APIs.

listKeysWithResponse

public abstract Response listKeysWithResponse(Context context)

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:

context - The context to associate with this operation.

Returns:

the keys to use with the Maps APIs along with Response<T>.

listSas

public abstract MapsAccountSasToken listSas(AccountSasParameters mapsAccountSasParameters)

Create and list an account shared access signature token. Use this SAS token for authentication to Azure Maps REST APIs through various Azure Maps SDKs. As prerequisite to create a SAS Token.

Prerequisites: 1. Create or have an existing User Assigned Managed Identity in the same Azure region as the account. 2. Create or update an Azure Map account with the same Azure region as the User Assigned Managed Identity is placed.

Parameters:

mapsAccountSasParameters - The updated parameters for the Maps Account.

Returns:

a new Sas token which can be used to access the Maps REST APIs and is controlled by the specified Managed identity permissions on Azure (IAM) Role Based Access Control.

listSasWithResponse

public abstract Response listSasWithResponse(AccountSasParameters mapsAccountSasParameters, Context context)

Create and list an account shared access signature token. Use this SAS token for authentication to Azure Maps REST APIs through various Azure Maps SDKs. As prerequisite to create a SAS Token.

Prerequisites: 1. Create or have an existing User Assigned Managed Identity in the same Azure region as the account. 2. Create or update an Azure Map account with the same Azure region as the User Assigned Managed Identity is placed.

Parameters:

mapsAccountSasParameters - The updated parameters for the Maps Account.

context - The context to associate with this operation.

Returns:

a new Sas token which can be used to access the Maps REST APIs and is controlled by the specified Managed identity permissions on Azure (IAM) Role Based Access Control along with Response<T>.

location

public abstract String location()

Gets the location property: The geo-location where the resource lives.

Returns:

the location value.

name

public abstract String name()

Gets the name property: The name of the resource.

Returns:

the name value.

properties

public abstract MapsAccountProperties properties()

Gets the properties property: The map account properties.

Returns:

the properties value.

refresh

public abstract MapsAccount refresh()

Refreshes the resource to sync with Azure.

Returns:

the refreshed resource.

refresh

public abstract MapsAccount refresh(Context context)

Refreshes the resource to sync with Azure.

Parameters:

context - The context to associate with this operation.

Returns:

the refreshed resource.

regenerateKeys

public abstract MapsAccountKeys regenerateKeys(MapsKeySpecification keySpecification)

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

Parameters:

keySpecification - Which key to regenerate: primary or secondary.

Returns:

the set of keys which can be used to access the Maps REST APIs.

regenerateKeysWithResponse

public abstract Response regenerateKeysWithResponse(MapsKeySpecification keySpecification, Context context)

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

Parameters:

keySpecification - Which key to regenerate: primary or secondary.

context - The context to associate with this operation.

Returns:

the set of keys which can be used to access the Maps REST APIs along with Response<T>.

region

public abstract Region region()

Gets the region of the resource.

Returns:

the region of the resource.

regionName

public abstract String regionName()

Gets the name of the resource region.

Returns:

the name of the resource region.

resourceGroupName

public abstract String resourceGroupName()

Gets the name of the resource group.

Returns:

the name of the resource group.

sku

public abstract Sku sku()

Gets the sku property: The SKU of this account.

Returns:

the sku value.

systemData

public abstract SystemData systemData()

Gets the systemData property: Metadata pertaining to creation and last modification of the resource.

Returns:

the systemData value.

tags

public abstract Map tags()

Gets the tags property: Resource tags.

Returns:

the tags value.

type

public abstract String type()

Gets the type property: The type of the resource.

Returns:

the type value.

update

public abstract MapsAccount.Update update()

Begins update for the MapsAccount resource.

Returns:

the stage of resource update.