Configuration Stores - List Keys

Başvuru

Service:: App Configuration

API Version:: 2023-03-01

Belirtilen yapılandırma deposu için erişim anahtarını listeler.

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 Parametreleri

Name	İçinde	Gerekli	Tür	Description
configStoreName	path	True	string	Yapılandırma deposunun adı. Regex pattern: `^[a-zA-Z0-9_-]*$`
resourceGroupName	path	True	string	Kapsayıcı kayıt defterinin ait olduğu kaynak grubunun adı.
subscriptionId	path	True	string	Microsoft Azure abonelik kimliği.
api-version	query	True	string	İstemci API sürümü.
$skipToken	query		string	Bir işlem kısmi sonuç döndürdüğünde öğeleri almaya devam etmek için atlama belirteci kullanılır. Önceki yanıt bir nextLink öğesi içeriyorsa nextLink öğesinin değeri, sonraki çağrılar için kullanılacak bir başlangıç noktasını belirten bir skipToken parametresi içerir.

Yanıtlar

Name	Tür	Description
200 OK	ApiKeyListResult	İstek başarılı oldu; istek düzgün biçimlendirilmiş ve düzgün bir şekilde alınmıştı.
Other Status Codes	ErrorResponse	İşlemin neden başarısız olduğunu açıklayan hata yanıtı

Güvenlik

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	kullanıcı hesabınızın kimliğine bürünme

Örnekler

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

Status code:: 200

{
  "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
    }
  ]
}

Tanımlar

Name	Description
ApiKey	Yapılandırma deposu uç noktasıyla kimlik doğrulaması için kullanılan API anahtarı.
ApiKeyListResult	API anahtarlarını listeleme isteğinin sonucu.
ErrorAdditionalInfo	Kaynak yönetimi hatası ek bilgileri.
ErrorDetails	Hatanın ayrıntıları.
ErrorResponse	Hata yanıtı, hizmetin gelen isteği işleyemediğini gösterir. Nedeni hata iletisinde verilmiştir.

ApiKey

Yapılandırma deposu uç noktasıyla kimlik doğrulaması için kullanılan API anahtarı.

Name	Tür	Description
connectionString	string	Kimlik doğrulaması için destekleyici istemciler tarafından kullanılabilecek bir bağlantı dizesi.
id	string	Anahtar kimliği.
lastModified	string	Anahtarın özelliklerinden herhangi birinin son değiştirildiği zaman.
name	string	Anahtarın kullanımını açıklayan bir ad.
readOnly	boolean	Bu anahtarın yalnızca okuma işlemleri için kullanılıp kullanılamayacağı.
value	string	Kimlik doğrulaması amacıyla kullanılan anahtarın değeri.

ApiKeyListResult

API anahtarlarını listeleme isteğinin sonucu.

Name	Tür	Description
nextLink	string	Sonraki sayfalanmış sonuç kümesini istemek için kullanılabilecek URI.
value	ApiKey[]	Koleksiyon değeri.

ErrorAdditionalInfo

Kaynak yönetimi hatası ek bilgileri.

Name	Tür	Description
info	object	Ek bilgiler.
type	string	Ek bilgi türü.

ErrorDetails

Hatanın ayrıntıları.

Name	Tür	Description
additionalInfo	ErrorAdditionalInfo[]	Hata ek bilgileri.
code	string	Hata kodu.
message	string	İşlemin neden başarısız olduğunu belirten hata iletisi.

ErrorResponse

Hata yanıtı, hizmetin gelen isteği işleyemediğini gösterir. Nedeni hata iletisinde verilmiştir.

Name	Tür	Description
error	ErrorDetails	Hatanın ayrıntıları.