Lista a chave de acesso para o repositório de configuração especificado.
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}
Parâmetros de URI
Nome |
Em |
Obrigatório |
Tipo |
Description |
configStoreName
|
path |
True
|
string
|
O nome do repositório de configuração.
Regex pattern: ^[a-zA-Z0-9_-]*$
|
resourceGroupName
|
path |
True
|
string
|
O nome do grupo de recursos ao qual o registro de contêiner pertence.
|
subscriptionId
|
path |
True
|
string
|
A ID da assinatura do Microsoft Azure.
|
api-version
|
query |
True
|
string
|
A versão da API do cliente.
|
$skipToken
|
query |
|
string
|
Um token de ignorar é usado para continuar recuperando itens depois que uma operação retorna um resultado parcial. Se uma resposta anterior contiver um elemento nextLink, o valor do elemento nextLink incluirá um parâmetro skipToken que especifica um ponto de partida a ser usado para chamadas subsequentes.
|
Respostas
Nome |
Tipo |
Description |
200 OK
|
ApiKeyListResult
|
A solicitação foi bem-sucedida; a solicitação foi bem formada e recebida corretamente.
|
Other Status Codes
|
ErrorResponse
|
Resposta de erro que descreve por que a operação falhou
|
Segurança
azure_auth
Fluxo do OAuth2 do Azure Active Directory
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nome |
Description |
user_impersonation
|
representar sua conta de usuário
|
Exemplos
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
}
]
}
Definições
Nome |
Description |
ApiKey
|
Uma chave de API usada para autenticação com um ponto de extremidade do repositório de configuração.
|
ApiKeyListResult
|
O resultado de uma solicitação para listar chaves de API.
|
ErrorAdditionalInfo
|
As informações adicionais do erro de gerenciamento de recursos.
|
ErrorDetails
|
Os detalhes do erro.
|
ErrorResponse
|
A resposta de erro indica que o serviço não é capaz de processar a solicitação de entrada. O motivo é fornecido na mensagem de erro.
|
ApiKey
Uma chave de API usada para autenticação com um ponto de extremidade do repositório de configuração.
Nome |
Tipo |
Description |
connectionString
|
string
|
Um cadeia de conexão que pode ser usado dando suporte a clientes para autenticação.
|
id
|
string
|
A ID da chave.
|
lastModified
|
string
|
A última vez que qualquer uma das propriedades da chave foi modificada.
|
name
|
string
|
Um nome para a chave que descreve seu uso.
|
readOnly
|
boolean
|
Se essa chave só pode ser usada para operações de leitura.
|
value
|
string
|
O valor da chave usada para fins de autenticação.
|
ApiKeyListResult
O resultado de uma solicitação para listar chaves de API.
Nome |
Tipo |
Description |
nextLink
|
string
|
O URI que pode ser usado para solicitar o próximo conjunto de resultados paginado.
|
value
|
ApiKey[]
|
O valor da coleção.
|
ErrorAdditionalInfo
As informações adicionais do erro de gerenciamento de recursos.
Nome |
Tipo |
Description |
info
|
object
|
As informações adicionais.
|
type
|
string
|
O tipo de informação adicional.
|
ErrorDetails
Os detalhes do erro.
Nome |
Tipo |
Description |
additionalInfo
|
ErrorAdditionalInfo[]
|
As informações adicionais do erro.
|
code
|
string
|
Código do erro.
|
message
|
string
|
Mensagem de erro indicando por que a operação falhou.
|
ErrorResponse
A resposta de erro indica que o serviço não é capaz de processar a solicitação de entrada. O motivo é fornecido na mensagem de erro.
Nome |
Tipo |
Description |
error
|
ErrorDetails
|
Os detalhes do erro.
|