Rigenerare la chiave primaria o secondaria da usare con le API mappe. La chiave precedente smetterà di funzionare immediatamente.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Maps/accounts/{accountName}/regenerateKey?api-version=2023-06-01
Parametri dell'URI
| Nome |
In |
Necessario |
Tipo |
Descrizione |
|
accountName
|
path |
True
|
string
|
Nome dell'account mappe.
|
|
resourceGroupName
|
path |
True
|
string
|
Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.
|
|
subscriptionId
|
path |
True
|
string
|
ID della sottoscrizione di destinazione.
|
|
api-version
|
query |
True
|
string
|
Versione dell'API da usare per questa operazione.
|
Corpo della richiesta
| Nome |
Necessario |
Tipo |
Descrizione |
|
keyType
|
True
|
KeyType
|
Se l'operazione fa riferimento alla chiave primaria o secondaria.
|
Risposte
| Nome |
Tipo |
Descrizione |
|
200 OK
|
MapsAccountKeys
|
La richiesta è stata completata.
|
|
Other Status Codes
|
ErrorResponse
|
Si è verificato un errore imprevisto.
|
Sicurezza
azure_auth
Flusso OAuth2 di Azure Active Directory
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
| Nome |
Descrizione |
|
user_impersonation
|
rappresentare l'account utente
|
Esempio
Regenerate Key
Sample Request
POST https://management.azure.com/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.Maps/accounts/myMapsAccount/regenerateKey?api-version=2023-06-01
{
"keyType": "primary"
}
import com.azure.resourcemanager.maps.models.KeyType;
import com.azure.resourcemanager.maps.models.MapsKeySpecification;
/** Samples for Accounts RegenerateKeys. */
public final class Main {
/*
* x-ms-original-file: specification/maps/resource-manager/Microsoft.Maps/stable/2023-06-01/examples/RegenerateKey.json
*/
/**
* Sample code: Regenerate Key.
*
* @param manager Entry point to AzureMapsManager.
*/
public static void regenerateKey(com.azure.resourcemanager.maps.AzureMapsManager manager) {
manager
.accounts()
.regenerateKeysWithResponse(
"myResourceGroup",
"myMapsAccount",
new MapsKeySpecification().withKeyType(KeyType.PRIMARY),
com.azure.core.util.Context.NONE);
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
from azure.identity import DefaultAzureCredential
from azure.mgmt.maps import AzureMapsManagementClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-maps
# USAGE
python regenerate_key.py
Before run the sample, please set the values of the client ID, tenant ID and client secret
of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""
def main():
client = AzureMapsManagementClient(
credential=DefaultAzureCredential(),
subscription_id="21a9967a-e8a9-4656-a70b-96ff1c4d05a0",
)
response = client.accounts.regenerate_keys(
resource_group_name="myResourceGroup",
account_name="myMapsAccount",
key_specification={"keyType": "primary"},
)
print(response)
# x-ms-original-file: specification/maps/resource-manager/Microsoft.Maps/stable/2023-06-01/examples/RegenerateKey.json
if __name__ == "__main__":
main()
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
package armmaps_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/maps/armmaps"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/b9403296f0b0e112b0d8222ad05fd1d79ee10e03/specification/maps/resource-manager/Microsoft.Maps/stable/2023-06-01/examples/RegenerateKey.json
func ExampleAccountsClient_RegenerateKeys() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armmaps.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewAccountsClient().RegenerateKeys(ctx, "myResourceGroup", "myMapsAccount", armmaps.KeySpecification{
KeyType: to.Ptr(armmaps.KeyTypePrimary),
}, nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.AccountKeys = armmaps.AccountKeys{
// PrimaryKey: to.Ptr("<primaryKey>"),
// PrimaryKeyLastUpdated: to.Ptr("2021-07-02T01:01:01.1075056Z"),
// SecondaryKey: to.Ptr("<secondaryKey>"),
// SecondaryKeyLastUpdated: to.Ptr("2021-07-02T01:01:01.1075056Z"),
// }
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { AzureMapsManagementClient } = require("@azure/arm-maps");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to Regenerate either the primary or secondary key for use with the Maps APIs. The old key will stop working immediately.
*
* @summary Regenerate either the primary or secondary key for use with the Maps APIs. The old key will stop working immediately.
* x-ms-original-file: specification/maps/resource-manager/Microsoft.Maps/stable/2023-06-01/examples/RegenerateKey.json
*/
async function regenerateKey() {
const subscriptionId =
process.env["MAPS_SUBSCRIPTION_ID"] || "21a9967a-e8a9-4656-a70b-96ff1c4d05a0";
const resourceGroupName = process.env["MAPS_RESOURCE_GROUP"] || "myResourceGroup";
const accountName = "myMapsAccount";
const keySpecification = { keyType: "primary" };
const credential = new DefaultAzureCredential();
const client = new AzureMapsManagementClient(credential, subscriptionId);
const result = await client.accounts.regenerateKeys(
resourceGroupName,
accountName,
keySpecification
);
console.log(result);
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
Sample Response
{
"primaryKey": "<primaryKey>",
"primaryKeyLastUpdated": "2021-07-02T01:01:01.1075056Z",
"secondaryKey": "<secondaryKey>",
"secondaryKeyLastUpdated": "2021-07-02T01:01:01.1075056Z"
}
Definizioni
| Nome |
Descrizione |
|
ErrorAdditionalInfo
|
Informazioni aggiuntive sulla gestione delle risorse.
|
|
ErrorDetail
|
Dettagli dell'errore.
|
|
ErrorResponse
|
Risposta di errore
|
|
KeyType
|
Se l'operazione fa riferimento alla chiave primaria o secondaria.
|
|
MapsAccountKeys
|
Set di chiavi che possono essere usate per accedere alle API REST di Mappe. Vengono fornite due chiavi per la rotazione delle chiavi senza interruzioni.
|
|
MapsKeySpecification
|
Se l'operazione fa riferimento alla chiave primaria o secondaria.
|
ErrorAdditionalInfo
Informazioni aggiuntive sulla gestione delle risorse.
| Nome |
Tipo |
Descrizione |
|
info
|
object
|
Informazioni aggiuntive.
|
|
type
|
string
|
Tipo di informazioni aggiuntive.
|
ErrorDetail
Dettagli dell'errore.
| Nome |
Tipo |
Descrizione |
|
additionalInfo
|
ErrorAdditionalInfo[]
|
Informazioni aggiuntive sull'errore.
|
|
code
|
string
|
Codice di errore.
|
|
details
|
ErrorDetail[]
|
Dettagli dell'errore.
|
|
message
|
string
|
Messaggio di errore.
|
|
target
|
string
|
Destinazione dell'errore.
|
ErrorResponse
Risposta di errore
KeyType
Se l'operazione fa riferimento alla chiave primaria o secondaria.
| Nome |
Tipo |
Descrizione |
|
primary
|
string
|
|
|
secondary
|
string
|
|
MapsAccountKeys
Set di chiavi che possono essere usate per accedere alle API REST di Mappe. Vengono fornite due chiavi per la rotazione delle chiavi senza interruzioni.
| Nome |
Tipo |
Descrizione |
|
primaryKey
|
string
|
Chiave primaria per l'accesso alle API REST di Mappe.
|
|
primaryKeyLastUpdated
|
string
|
Ultima data e ora aggiornate della chiave primaria.
|
|
secondaryKey
|
string
|
Chiave secondaria per l'accesso alle API REST di Mappe.
|
|
secondaryKeyLastUpdated
|
string
|
Ultima data e ora aggiornate della chiave secondaria.
|
MapsKeySpecification
Se l'operazione fa riferimento alla chiave primaria o secondaria.
| Nome |
Tipo |
Descrizione |
|
keyType
|
KeyType
|
Se l'operazione fa riferimento alla chiave primaria o secondaria.
|