azure-docs-sdk-java/docs-ref-autogen/com.azure.resourcemanager.m...

320 строки
21 KiB
YAML

### YamlMime:JavaType
uid: "com.azure.resourcemanager.maps.models.MapsAccount"
fullName: "com.azure.resourcemanager.maps.models.MapsAccount"
name: "MapsAccount"
nameWithType: "MapsAccount"
summary: "An immutable client-side representation of Maps<wbr>Account."
syntax: "public interface **MapsAccount**"
methods:
- uid: "com.azure.resourcemanager.maps.models.MapsAccount.id()"
fullName: "com.azure.resourcemanager.maps.models.MapsAccount.id()"
name: "id()"
nameWithType: "MapsAccount.id()"
summary: "Gets the id property: Fully qualified resource Id for the resource."
modifiers:
- "abstract"
syntax: "public abstract String id()"
desc: "Gets the id property: Fully qualified resource Id for the resource."
returns:
description: "the id value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.maps.models.MapsAccount.identity()"
fullName: "com.azure.resourcemanager.maps.models.MapsAccount.identity()"
name: "identity()"
nameWithType: "MapsAccount.identity()"
summary: "Gets the identity property: Managed service identity (system assigned and/or user assigned identities)."
modifiers:
- "abstract"
syntax: "public abstract ManagedServiceIdentity identity()"
desc: "Gets the identity property: Managed service identity (system assigned and/or user assigned identities)."
returns:
description: "the identity value."
type: "<xref href=\"com.azure.resourcemanager.maps.models.ManagedServiceIdentity?alt=com.azure.resourcemanager.maps.models.ManagedServiceIdentity&text=ManagedServiceIdentity\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.maps.models.MapsAccount.innerModel()"
fullName: "com.azure.resourcemanager.maps.models.MapsAccount.innerModel()"
name: "innerModel()"
nameWithType: "MapsAccount.innerModel()"
summary: "Gets the inner com.<wbr>azure.<wbr>resourcemanager.<wbr>maps.<wbr>fluent.<wbr>models.<wbr>Maps<wbr>Account<wbr>Inner object."
modifiers:
- "abstract"
syntax: "public abstract MapsAccountInner innerModel()"
desc: "Gets the inner com.azure.resourcemanager.maps.fluent.models.MapsAccountInner object."
returns:
description: "the inner object."
type: "<xref href=\"com.azure.resourcemanager.maps.fluent.models.MapsAccountInner?alt=com.azure.resourcemanager.maps.fluent.models.MapsAccountInner&text=MapsAccountInner\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.maps.models.MapsAccount.kind()"
fullName: "com.azure.resourcemanager.maps.models.MapsAccount.kind()"
name: "kind()"
nameWithType: "MapsAccount.kind()"
summary: "Gets the kind property: Get or Set Kind property."
modifiers:
- "abstract"
syntax: "public abstract Kind kind()"
desc: "Gets the kind property: Get or Set Kind property."
returns:
description: "the kind value."
type: "<xref href=\"com.azure.resourcemanager.maps.models.Kind?alt=com.azure.resourcemanager.maps.models.Kind&text=Kind\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.maps.models.MapsAccount.listKeys()"
fullName: "com.azure.resourcemanager.maps.models.MapsAccount.listKeys()"
name: "listKeys()"
nameWithType: "MapsAccount.listKeys()"
summary: "Get the keys to use with the Maps APIs."
modifiers:
- "abstract"
syntax: "public abstract MapsAccountKeys listKeys()"
desc: "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:
description: "the keys to use with the Maps APIs."
type: "<xref href=\"com.azure.resourcemanager.maps.models.MapsAccountKeys?alt=com.azure.resourcemanager.maps.models.MapsAccountKeys&text=MapsAccountKeys\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.maps.models.MapsAccount.listKeysWithResponse(com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.maps.models.MapsAccount.listKeysWithResponse(Context context)"
name: "listKeysWithResponse(Context context)"
nameWithType: "MapsAccount.listKeysWithResponse(Context context)"
summary: "Get the keys to use with the Maps APIs."
modifiers:
- "abstract"
parameters:
- description: "The context to associate with this operation."
name: "context"
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
syntax: "public abstract Response<MapsAccountKeys> listKeysWithResponse(Context context)"
desc: "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:
description: "the keys to use with the Maps APIs along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.maps.models.MapsAccountKeys?alt=com.azure.resourcemanager.maps.models.MapsAccountKeys&text=MapsAccountKeys\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.maps.models.MapsAccount.listSas(com.azure.resourcemanager.maps.models.AccountSasParameters)"
fullName: "com.azure.resourcemanager.maps.models.MapsAccount.listSas(AccountSasParameters mapsAccountSasParameters)"
name: "listSas(AccountSasParameters mapsAccountSasParameters)"
nameWithType: "MapsAccount.listSas(AccountSasParameters mapsAccountSasParameters)"
summary: "Create and list an account shared access signature token."
modifiers:
- "abstract"
parameters:
- description: "The updated parameters for the Maps Account."
name: "mapsAccountSasParameters"
type: "<xref href=\"com.azure.resourcemanager.maps.models.AccountSasParameters?alt=com.azure.resourcemanager.maps.models.AccountSasParameters&text=AccountSasParameters\" data-throw-if-not-resolved=\"False\" />"
syntax: "public abstract MapsAccountSasToken listSas(AccountSasParameters mapsAccountSasParameters)"
desc: "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.\n\nPrerequisites: 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."
returns:
description: "a new Sas token which can be used to access the Maps REST APIs and is controlled by the specified Managed\n identity permissions on Azure (IAM) Role Based Access Control."
type: "<xref href=\"com.azure.resourcemanager.maps.models.MapsAccountSasToken?alt=com.azure.resourcemanager.maps.models.MapsAccountSasToken&text=MapsAccountSasToken\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.maps.models.MapsAccount.listSasWithResponse(com.azure.resourcemanager.maps.models.AccountSasParameters,com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.maps.models.MapsAccount.listSasWithResponse(AccountSasParameters mapsAccountSasParameters, Context context)"
name: "listSasWithResponse(AccountSasParameters mapsAccountSasParameters, Context context)"
nameWithType: "MapsAccount.listSasWithResponse(AccountSasParameters mapsAccountSasParameters, Context context)"
summary: "Create and list an account shared access signature token."
modifiers:
- "abstract"
parameters:
- description: "The updated parameters for the Maps Account."
name: "mapsAccountSasParameters"
type: "<xref href=\"com.azure.resourcemanager.maps.models.AccountSasParameters?alt=com.azure.resourcemanager.maps.models.AccountSasParameters&text=AccountSasParameters\" data-throw-if-not-resolved=\"False\" />"
- description: "The context to associate with this operation."
name: "context"
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
syntax: "public abstract Response<MapsAccountSasToken> listSasWithResponse(AccountSasParameters mapsAccountSasParameters, Context context)"
desc: "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.\n\nPrerequisites: 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."
returns:
description: "a new Sas token which can be used to access the Maps REST APIs and is controlled by the specified Managed\n identity permissions on Azure (IAM) Role Based Access Control along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.maps.models.MapsAccountSasToken?alt=com.azure.resourcemanager.maps.models.MapsAccountSasToken&text=MapsAccountSasToken\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.maps.models.MapsAccount.location()"
fullName: "com.azure.resourcemanager.maps.models.MapsAccount.location()"
name: "location()"
nameWithType: "MapsAccount.location()"
summary: "Gets the location property: The geo-location where the resource lives."
modifiers:
- "abstract"
syntax: "public abstract String location()"
desc: "Gets the location property: The geo-location where the resource lives."
returns:
description: "the location value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.maps.models.MapsAccount.name()"
fullName: "com.azure.resourcemanager.maps.models.MapsAccount.name()"
name: "name()"
nameWithType: "MapsAccount.name()"
summary: "Gets the name property: The name of the resource."
modifiers:
- "abstract"
syntax: "public abstract String name()"
desc: "Gets the name property: The name of the resource."
returns:
description: "the name value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.maps.models.MapsAccount.properties()"
fullName: "com.azure.resourcemanager.maps.models.MapsAccount.properties()"
name: "properties()"
nameWithType: "MapsAccount.properties()"
summary: "Gets the properties property: The map account properties."
modifiers:
- "abstract"
syntax: "public abstract MapsAccountProperties properties()"
desc: "Gets the properties property: The map account properties."
returns:
description: "the properties value."
type: "<xref href=\"com.azure.resourcemanager.maps.fluent.models.MapsAccountProperties?alt=com.azure.resourcemanager.maps.fluent.models.MapsAccountProperties&text=MapsAccountProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.maps.models.MapsAccount.refresh()"
fullName: "com.azure.resourcemanager.maps.models.MapsAccount.refresh()"
name: "refresh()"
nameWithType: "MapsAccount.refresh()"
summary: "Refreshes the resource to sync with Azure."
modifiers:
- "abstract"
syntax: "public abstract MapsAccount refresh()"
desc: "Refreshes the resource to sync with Azure."
returns:
description: "the refreshed resource."
type: "<xref href=\"com.azure.resourcemanager.maps.models.MapsAccount?alt=com.azure.resourcemanager.maps.models.MapsAccount&text=MapsAccount\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.maps.models.MapsAccount.refresh(com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.maps.models.MapsAccount.refresh(Context context)"
name: "refresh(Context context)"
nameWithType: "MapsAccount.refresh(Context context)"
summary: "Refreshes the resource to sync with Azure."
modifiers:
- "abstract"
parameters:
- description: "The context to associate with this operation."
name: "context"
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
syntax: "public abstract MapsAccount refresh(Context context)"
desc: "Refreshes the resource to sync with Azure."
returns:
description: "the refreshed resource."
type: "<xref href=\"com.azure.resourcemanager.maps.models.MapsAccount?alt=com.azure.resourcemanager.maps.models.MapsAccount&text=MapsAccount\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.maps.models.MapsAccount.regenerateKeys(com.azure.resourcemanager.maps.models.MapsKeySpecification)"
fullName: "com.azure.resourcemanager.maps.models.MapsAccount.regenerateKeys(MapsKeySpecification keySpecification)"
name: "regenerateKeys(MapsKeySpecification keySpecification)"
nameWithType: "MapsAccount.regenerateKeys(MapsKeySpecification keySpecification)"
summary: "Regenerate either the primary or secondary key for use with the Maps APIs."
modifiers:
- "abstract"
parameters:
- description: "Which key to regenerate: primary or secondary."
name: "keySpecification"
type: "<xref href=\"com.azure.resourcemanager.maps.models.MapsKeySpecification?alt=com.azure.resourcemanager.maps.models.MapsKeySpecification&text=MapsKeySpecification\" data-throw-if-not-resolved=\"False\" />"
syntax: "public abstract MapsAccountKeys regenerateKeys(MapsKeySpecification keySpecification)"
desc: "Regenerate either the primary or secondary key for use with the Maps APIs. The old key will stop working immediately."
returns:
description: "the set of keys which can be used to access the Maps REST APIs."
type: "<xref href=\"com.azure.resourcemanager.maps.models.MapsAccountKeys?alt=com.azure.resourcemanager.maps.models.MapsAccountKeys&text=MapsAccountKeys\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.maps.models.MapsAccount.regenerateKeysWithResponse(com.azure.resourcemanager.maps.models.MapsKeySpecification,com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.maps.models.MapsAccount.regenerateKeysWithResponse(MapsKeySpecification keySpecification, Context context)"
name: "regenerateKeysWithResponse(MapsKeySpecification keySpecification, Context context)"
nameWithType: "MapsAccount.regenerateKeysWithResponse(MapsKeySpecification keySpecification, Context context)"
summary: "Regenerate either the primary or secondary key for use with the Maps APIs."
modifiers:
- "abstract"
parameters:
- description: "Which key to regenerate: primary or secondary."
name: "keySpecification"
type: "<xref href=\"com.azure.resourcemanager.maps.models.MapsKeySpecification?alt=com.azure.resourcemanager.maps.models.MapsKeySpecification&text=MapsKeySpecification\" data-throw-if-not-resolved=\"False\" />"
- description: "The context to associate with this operation."
name: "context"
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
syntax: "public abstract Response<MapsAccountKeys> regenerateKeysWithResponse(MapsKeySpecification keySpecification, Context context)"
desc: "Regenerate either the primary or secondary key for use with the Maps APIs. The old key will stop working immediately."
returns:
description: "the set of keys which can be used to access the Maps REST APIs along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.maps.models.MapsAccountKeys?alt=com.azure.resourcemanager.maps.models.MapsAccountKeys&text=MapsAccountKeys\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.maps.models.MapsAccount.region()"
fullName: "com.azure.resourcemanager.maps.models.MapsAccount.region()"
name: "region()"
nameWithType: "MapsAccount.region()"
summary: "Gets the region of the resource."
modifiers:
- "abstract"
syntax: "public abstract Region region()"
desc: "Gets the region of the resource."
returns:
description: "the region of the resource."
type: "<xref href=\"com.azure.core.management.Region?alt=com.azure.core.management.Region&text=Region\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.maps.models.MapsAccount.regionName()"
fullName: "com.azure.resourcemanager.maps.models.MapsAccount.regionName()"
name: "regionName()"
nameWithType: "MapsAccount.regionName()"
summary: "Gets the name of the resource region."
modifiers:
- "abstract"
syntax: "public abstract String regionName()"
desc: "Gets the name of the resource region."
returns:
description: "the name of the resource region."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.maps.models.MapsAccount.resourceGroupName()"
fullName: "com.azure.resourcemanager.maps.models.MapsAccount.resourceGroupName()"
name: "resourceGroupName()"
nameWithType: "MapsAccount.resourceGroupName()"
summary: "Gets the name of the resource group."
modifiers:
- "abstract"
syntax: "public abstract String resourceGroupName()"
desc: "Gets the name of the resource group."
returns:
description: "the name of the resource group."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.maps.models.MapsAccount.sku()"
fullName: "com.azure.resourcemanager.maps.models.MapsAccount.sku()"
name: "sku()"
nameWithType: "MapsAccount.sku()"
summary: "Gets the sku property: The SKU of this account."
modifiers:
- "abstract"
syntax: "public abstract Sku sku()"
desc: "Gets the sku property: The SKU of this account."
returns:
description: "the sku value."
type: "<xref href=\"com.azure.resourcemanager.maps.models.Sku?alt=com.azure.resourcemanager.maps.models.Sku&text=Sku\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.maps.models.MapsAccount.systemData()"
fullName: "com.azure.resourcemanager.maps.models.MapsAccount.systemData()"
name: "systemData()"
nameWithType: "MapsAccount.systemData()"
summary: "Gets the system<wbr>Data property: Metadata pertaining to creation and last modification of the resource."
modifiers:
- "abstract"
syntax: "public abstract SystemData systemData()"
desc: "Gets the systemData property: Metadata pertaining to creation and last modification of the resource."
returns:
description: "the systemData value."
type: "<xref href=\"com.azure.core.management.SystemData?alt=com.azure.core.management.SystemData&text=SystemData\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.maps.models.MapsAccount.tags()"
fullName: "com.azure.resourcemanager.maps.models.MapsAccount.tags()"
name: "tags()"
nameWithType: "MapsAccount.tags()"
summary: "Gets the tags property: Resource tags."
modifiers:
- "abstract"
syntax: "public abstract Map<String,String> tags()"
desc: "Gets the tags property: Resource tags."
returns:
description: "the tags value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>&gt;"
- uid: "com.azure.resourcemanager.maps.models.MapsAccount.type()"
fullName: "com.azure.resourcemanager.maps.models.MapsAccount.type()"
name: "type()"
nameWithType: "MapsAccount.type()"
summary: "Gets the type property: The type of the resource."
modifiers:
- "abstract"
syntax: "public abstract String type()"
desc: "Gets the type property: The type of the resource."
returns:
description: "the type value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.maps.models.MapsAccount.update()"
fullName: "com.azure.resourcemanager.maps.models.MapsAccount.update()"
name: "update()"
nameWithType: "MapsAccount.update()"
summary: "Begins update for the Maps<wbr>Account resource."
modifiers:
- "abstract"
syntax: "public abstract MapsAccount.Update update()"
desc: "Begins update for the MapsAccount resource."
returns:
description: "the stage of resource update."
type: "<xref href=\"com.azure.resourcemanager.maps.models.MapsAccount.Update?alt=com.azure.resourcemanager.maps.models.MapsAccount.Update&text=Update\" data-throw-if-not-resolved=\"False\" />"
type: "interface"
desc: "An immutable client-side representation of MapsAccount."
metadata: {}
package: "com.azure.resourcemanager.maps.models"
artifact: com.azure.resourcemanager:azure-resourcemanager-maps:1.0.0