Maps API で使用するために、プライマリ キーまたはセカンダリ キーを再生成します。 古いキーはすぐに動作しなくなります。
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Maps/accounts/{accountName}/regenerateKey?api-version=2023-06-01
URI パラメーター
名前 |
/ |
必須 |
型 |
説明 |
accountName
|
path |
True
|
string
|
マップ アカウントの名前。
|
resourceGroupName
|
path |
True
|
string
|
リソース グループの名前。 名前の大文字と小文字は区別されます。
|
subscriptionId
|
path |
True
|
string
|
ターゲット サブスクリプションの ID。
|
api-version
|
query |
True
|
string
|
この操作に使用する API バージョン。
|
要求本文
名前 |
必須 |
型 |
説明 |
keyType
|
True
|
KeyType
|
操作がプライマリ キーとセカンダリ キーのどちらを参照しているか。
|
応答
セキュリティ
azure_auth
Azure Active Directory OAuth2 フロー
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
名前 |
説明 |
user_impersonation
|
ユーザー アカウントの借用
|
例
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"
}
定義
ErrorAdditionalInfo
リソース管理エラーの追加情報。
名前 |
型 |
説明 |
info
|
object
|
追加情報。
|
type
|
string
|
追加情報の種類。
|
ErrorDetail
エラーの詳細。
名前 |
型 |
説明 |
additionalInfo
|
ErrorAdditionalInfo[]
|
エラーの追加情報。
|
code
|
string
|
エラー コード。
|
details
|
ErrorDetail[]
|
エラーの詳細です。
|
message
|
string
|
エラー メッセージ。
|
target
|
string
|
エラーのターゲット。
|
ErrorResponse
エラー応答
KeyType
操作がプライマリ キーとセカンダリ キーのどちらを参照しているか。
名前 |
型 |
説明 |
primary
|
string
|
|
secondary
|
string
|
|
MapsAccountKeys
Maps REST API へのアクセスに使用できるキーのセット。 2 つのキーが割り込みなしでキーのローテーション用に提供されます。
名前 |
型 |
説明 |
primaryKey
|
string
|
Maps REST API にアクセスするための主キー。
|
primaryKeyLastUpdated
|
string
|
主キーの最後に更新された日付と時刻。
|
secondaryKey
|
string
|
Maps REST API にアクセスするためのセカンダリ キー。
|
secondaryKeyLastUpdated
|
string
|
セカンダリ キーの最後に更新された日付と時刻。
|
MapsKeySpecification
操作がプライマリ キーとセカンダリ キーのどちらを参照しているか。
名前 |
型 |
説明 |
keyType
|
KeyType
|
操作がプライマリ キーとセカンダリ キーのどちらを参照しているか。
|