Een lijst met de toegangssleutel voor het opgegeven configuratiearchief.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/listKeys?api-version=2023-03-01
With optional parameters:
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/listKeys?api-version=2023-03-01&$skipToken={$skipToken}
URI-parameters
Name |
In |
Vereist |
Type |
Description |
configStoreName
|
path |
True
|
string
|
De naam van het configuratiearchief.
Regex pattern: ^[a-zA-Z0-9_-]*$
|
resourceGroupName
|
path |
True
|
string
|
De naam van de resourcegroep waartoe het containerregister behoort.
|
subscriptionId
|
path |
True
|
string
|
De Microsoft Azure-abonnements-id.
|
api-version
|
query |
True
|
string
|
De client-API-versie.
|
$skipToken
|
query |
|
string
|
Een skip-token wordt gebruikt om door te gaan met het ophalen van items nadat een bewerking een gedeeltelijk resultaat retourneert. Als een eerder antwoord een nextLink-element bevat, bevat de waarde van het element nextLink een skipToken-parameter die een beginpunt opgeeft dat moet worden gebruikt voor volgende aanroepen.
|
Antwoorden
Name |
Type |
Description |
200 OK
|
ApiKeyListResult
|
De aanvraag is geslaagd; de aanvraag goed is opgemaakt en correct is ontvangen.
|
Other Status Codes
|
ErrorResponse
|
Foutreactie waarin wordt beschreven waarom de bewerking is mislukt
|
Beveiliging
azure_auth
Azure Active Directory OAuth2-stroom
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name |
Description |
user_impersonation
|
uw gebruikersaccount imiteren
|
Voorbeelden
ConfigurationStores_ListKeys
Sample Request
POST https://management.azure.com/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.AppConfiguration/configurationStores/contoso/listKeys?api-version=2023-03-01
/** Samples for ConfigurationStores ListKeys. */
public final class Main {
/*
* x-ms-original-file: specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2023-03-01/examples/ConfigurationStoresListKeys.json
*/
/**
* Sample code: ConfigurationStores_ListKeys.
*
* @param manager Entry point to AppConfigurationManager.
*/
public static void configurationStoresListKeys(
com.azure.resourcemanager.appconfiguration.AppConfigurationManager manager) {
manager.configurationStores().listKeys("myResourceGroup", "contoso", null, 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.appconfiguration import AppConfigurationManagementClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-appconfiguration
# USAGE
python configuration_stores_list_keys.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 = AppConfigurationManagementClient(
credential=DefaultAzureCredential(),
subscription_id="c80fb759-c965-4c6a-9110-9b2b2d038882",
)
response = client.configuration_stores.list_keys(
resource_group_name="myResourceGroup",
config_store_name="contoso",
)
for item in response:
print(item)
# x-ms-original-file: specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2023-03-01/examples/ConfigurationStoresListKeys.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 armappconfiguration_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appconfiguration/armappconfiguration/v2"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1f22d4dbd99b0fe347ad79e79d4eb1ed44a87291/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2023-03-01/examples/ConfigurationStoresListKeys.json
func ExampleConfigurationStoresClient_NewListKeysPager() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappconfiguration.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewConfigurationStoresClient().NewListKeysPager("myResourceGroup", "contoso", &armappconfiguration.ConfigurationStoresClientListKeysOptions{SkipToken: nil})
for pager.More() {
page, err := pager.NextPage(ctx)
if err != nil {
log.Fatalf("failed to advance page: %v", err)
}
for _, v := range page.Value {
// You could use page here. We use blank identifier for just demo purposes.
_ = v
}
// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// page.APIKeyListResult = armappconfiguration.APIKeyListResult{
// Value: []*armappconfiguration.APIKey{
// {
// Name: to.Ptr("Primary"),
// ConnectionString: to.Ptr("xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"),
// ID: to.Ptr("439AD01B4BE67DB1"),
// LastModified: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-04-24T16:30:54.000Z"); return t}()),
// ReadOnly: to.Ptr(false),
// Value: to.Ptr("000000000000000000000000000000000000000000000000000000"),
// },
// {
// Name: to.Ptr("Secondary"),
// ConnectionString: to.Ptr("xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"),
// ID: to.Ptr("CB45E100456857B9"),
// LastModified: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-04-24T16:30:54.000Z"); return t}()),
// ReadOnly: to.Ptr(false),
// Value: to.Ptr("000000000000000000000000000000000000000000000000000000"),
// },
// {
// Name: to.Ptr("Primary Read Only"),
// ConnectionString: to.Ptr("xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"),
// ID: to.Ptr("B3AC55B7E71431A9"),
// LastModified: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-04-24T16:30:54.000Z"); return t}()),
// ReadOnly: to.Ptr(true),
// Value: to.Ptr("000000000000000000000000000000000000000000000000000000"),
// },
// {
// Name: to.Ptr("Secondary Read Only"),
// ConnectionString: to.Ptr("xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"),
// ID: to.Ptr("E2AF6A9A89DCC177"),
// LastModified: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-04-24T16:30:54.000Z"); return t}()),
// ReadOnly: to.Ptr(true),
// Value: to.Ptr("000000000000000000000000000000000000000000000000000000"),
// }},
// }
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { AppConfigurationManagementClient } = require("@azure/arm-appconfiguration");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to Lists the access key for the specified configuration store.
*
* @summary Lists the access key for the specified configuration store.
* x-ms-original-file: specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2023-03-01/examples/ConfigurationStoresListKeys.json
*/
async function configurationStoresListKeys() {
const subscriptionId =
process.env["APPCONFIGURATION_SUBSCRIPTION_ID"] || "c80fb759-c965-4c6a-9110-9b2b2d038882";
const resourceGroupName = process.env["APPCONFIGURATION_RESOURCE_GROUP"] || "myResourceGroup";
const configStoreName = "contoso";
const credential = new DefaultAzureCredential();
const client = new AppConfigurationManagementClient(credential, subscriptionId);
const resArray = new Array();
for await (let item of client.configurationStores.listKeys(resourceGroupName, configStoreName)) {
resArray.push(item);
}
console.log(resArray);
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.AppConfiguration;
using Azure.ResourceManager.AppConfiguration.Models;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Resources;
// Generated from example definition: specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2023-03-01/examples/ConfigurationStoresListKeys.json
// this example is just showing the usage of "ConfigurationStores_ListKeys" operation, for the dependent resources, they will have to be created separately.
// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);
// this example assumes you already have this AppConfigurationStoreResource created on azure
// for more information of creating AppConfigurationStoreResource, please refer to the document of AppConfigurationStoreResource
string subscriptionId = "c80fb759-c965-4c6a-9110-9b2b2d038882";
string resourceGroupName = "myResourceGroup";
string configStoreName = "contoso";
ResourceIdentifier appConfigurationStoreResourceId = AppConfigurationStoreResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, configStoreName);
AppConfigurationStoreResource appConfigurationStore = client.GetAppConfigurationStoreResource(appConfigurationStoreResourceId);
// invoke the operation and iterate over the result
await foreach (AppConfigurationStoreApiKey item in appConfigurationStore.GetKeysAsync())
{
Console.WriteLine($"Succeeded: {item}");
}
Console.WriteLine($"Succeeded");
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
{
"value": [
{
"id": "439AD01B4BE67DB1",
"name": "Primary",
"value": "000000000000000000000000000000000000000000000000000000",
"connectionString": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"lastModified": "2018-04-24T16:30:54+00:00",
"readOnly": false
},
{
"id": "CB45E100456857B9",
"name": "Secondary",
"value": "000000000000000000000000000000000000000000000000000000",
"connectionString": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"lastModified": "2018-04-24T16:30:54+00:00",
"readOnly": false
},
{
"id": "B3AC55B7E71431A9",
"name": "Primary Read Only",
"value": "000000000000000000000000000000000000000000000000000000",
"connectionString": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"lastModified": "2018-04-24T16:30:54+00:00",
"readOnly": true
},
{
"id": "E2AF6A9A89DCC177",
"name": "Secondary Read Only",
"value": "000000000000000000000000000000000000000000000000000000",
"connectionString": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"lastModified": "2018-04-24T16:30:54+00:00",
"readOnly": true
}
]
}
Definities
Name |
Description |
ApiKey
|
Een API-sleutel die wordt gebruikt voor verificatie met een eindpunt van een configuratiearchief.
|
ApiKeyListResult
|
Het resultaat van een aanvraag om API-sleutels weer te geven.
|
ErrorAdditionalInfo
|
Aanvullende informatie over de resourcebeheerfout.
|
ErrorDetails
|
De details van de fout.
|
ErrorResponse
|
Foutreactie geeft aan dat de service de binnenkomende aanvraag niet kan verwerken. De reden wordt opgegeven in het foutbericht.
|
ApiKey
Een API-sleutel die wordt gebruikt voor verificatie met een eindpunt van een configuratiearchief.
Name |
Type |
Description |
connectionString
|
string
|
Een verbindingsreeks die kan worden gebruikt door ondersteuning van clients voor verificatie.
|
id
|
string
|
De sleutel-id.
|
lastModified
|
string
|
De laatste keer dat de eigenschappen van de sleutel zijn gewijzigd.
|
name
|
string
|
Een naam voor de sleutel die het gebruik ervan beschrijft.
|
readOnly
|
boolean
|
Of deze sleutel alleen kan worden gebruikt voor leesbewerkingen.
|
value
|
string
|
De waarde van de sleutel die wordt gebruikt voor verificatiedoeleinden.
|
ApiKeyListResult
Het resultaat van een aanvraag om API-sleutels weer te geven.
Name |
Type |
Description |
nextLink
|
string
|
De URI die kan worden gebruikt om de volgende set paginaresultaten op te vragen.
|
value
|
ApiKey[]
|
De verzamelingswaarde.
|
ErrorAdditionalInfo
Aanvullende informatie over de resourcebeheerfout.
Name |
Type |
Description |
info
|
object
|
De aanvullende informatie.
|
type
|
string
|
Het type aanvullende informatie.
|
ErrorDetails
De details van de fout.
Name |
Type |
Description |
additionalInfo
|
ErrorAdditionalInfo[]
|
Aanvullende informatie over de fout.
|
code
|
string
|
Foutcode.
|
message
|
string
|
Foutbericht waarin wordt aangegeven waarom de bewerking is mislukt.
|
ErrorResponse
Foutreactie geeft aan dat de service de binnenkomende aanvraag niet kan verwerken. De reden wordt opgegeven in het foutbericht.
Name |
Type |
Description |
error
|
ErrorDetails
|
De details van de fout.
|