Partager via

Configuration Stores - List Keys

Service:
App Configuration
Version d'API:
2024-06-01

Répertorie la clé d’accès pour le magasin de configuration spécifié.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/listKeys?api-version=2024-06-01
Avec des paramètres facultatifs: 
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/listKeys?api-version=2024-06-01&$skipToken={$skipToken}

Paramètres URI

Nom Dans Obligatoire Type Description
configStoreName
 path True

string

minLength: 5
maxLength: 50
pattern: ^[a-zA-Z0-9_-]*$

Nom du magasin de configuration.
resourceGroupName
 path True

string

Nom du groupe de ressources auquel appartient le registre de conteneurs.
subscriptionId
 path True

string

ID d’abonnement Microsoft Azure.
api-version
 query True

string

Version de l’API cliente.
$skipToken
 query

string

Un jeton skip est utilisé pour continuer à récupérer des éléments après qu’une opération retourne un résultat partiel. Si une réponse précédente contient un élément nextLink, la valeur de l’élément nextLink inclut un paramètre skipToken qui spécifie un point de départ à utiliser pour les appels suivants.

Réponses

Nom Type Description
200 OK

ApiKeyListResult

La demande a réussi ; la demande a été bien formée et reçue correctement.
Other Status Codes

ErrorResponse

Réponse d’erreur décrivant le motif de l’échec de l’opération

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom Description
user_impersonation emprunter l’identité de votre compte d’utilisateur

Exemples

ConfigurationStores_ListKeys

Exemple de requête

POST https://management.azure.com/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.AppConfiguration/configurationStores/contoso/listKeys?api-version=2024-06-01

Exemple de réponse

Code d’état:
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
    }
  ]
}

Définitions

Nom Description
ApiKey

Clé API utilisée pour l’authentification avec un point de terminaison de magasin de configuration.
ApiKeyListResult

Résultat d’une demande de liste des clés API.
ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetails

Détails de l’erreur.
ErrorResponse

La réponse d’erreur indique que le service n’est pas en mesure de traiter la requête entrante. La raison est fournie dans le message d’erreur.

ApiKey

Object

Clé API utilisée pour l’authentification avec un point de terminaison de magasin de configuration.

Nom Type Description
connectionString

string

Chaîne de connexion qui peut être utilisée en prenant en charge les clients pour l’authentification.
id

string

ID de clé.
lastModified

string (date-time)

La dernière fois que les propriétés de la clé ont été modifiées.
name

string

Nom de la clé décrivant son utilisation.
readOnly

boolean

Indique si cette clé ne peut être utilisée que pour les opérations de lecture.
value

string

Valeur de la clé utilisée à des fins d’authentification.

ApiKeyListResult

Object

Résultat d’une demande de liste des clés API.

Nom Type Description
nextLink

string

URI qui peut être utilisé pour demander le jeu de résultats paginé suivant.
value

ApiKey[]

Valeur de la collection.

ErrorAdditionalInfo

Object

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom Type Description
info

object

Informations supplémentaires.
type

string

Type d’informations supplémentaire.

ErrorDetails

Object

Détails de l’erreur.

Nom Type Description
additionalInfo

ErrorAdditionalInfo[]

Informations supplémentaires sur l’erreur.
code

string

Code d’erreur.
message

string

Message d’erreur indiquant pourquoi l’opération a échoué.

ErrorResponse

Object

La réponse d’erreur indique que le service n’est pas en mesure de traiter la requête entrante. La raison est fournie dans le message d’erreur.

Nom Type Description
error

ErrorDetails

Détails de l’erreur.