Partager via

Subscription - List Secrets

Service:
API Management
Version d'API:
2024-05-01

Obtient les clés d’abonnement spécifiées.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions/{sid}/listSecrets?api-version=2024-05-01

Paramètres URI

Nom Dans Obligatoire Type Description
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

Nom du groupe de ressources. Le nom ne respecte pas la casse.
serviceName
 path True

string

minLength: 1
maxLength: 50
pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

Nom du service Gestion des API.
sid
 path True

string

maxLength: 256
pattern: ^[^*#&+:<>?]+$

Identificateur d’entité d’abonnement. L’entité représente l’association entre un utilisateur et un produit dans Gestion des API.
subscriptionId
 path True

string (uuid)

ID de l’abonnement cible. La valeur doit être un UUID.
api-version
 query True

string

minLength: 1

Version de l’API à utiliser pour cette opération.

Réponses

Nom Type Description
200 OK

SubscriptionKeysContract

Le corps de la réponse contient des clés d’abonnement.

En-têtes

ETag: string
Other Status Codes

ErrorResponse

Réponse d’erreur décrivant pourquoi l’opération a échoué.

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

ApiManagementSubscriptionListSecrets

Exemple de requête

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/5931a769d8d14f0ad8ce13b8/listSecrets?api-version=2024-05-01

Exemple de réponse

Code d’état:
200 
{
  "primaryKey": "<primaryKey>",
  "secondaryKey": "<secondaryKey>"
}

Définitions

Nom Description
ErrorAdditionalInfo

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

Détail de l’erreur.
ErrorResponse

Réponse d’erreur
SubscriptionKeysContract

Clés d’abonnement.

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.

ErrorDetail

Object

Détail de l’erreur.

Nom Type Description
additionalInfo

ErrorAdditionalInfo[]

Informations supplémentaires sur l’erreur.
code

string

Code d’erreur.
details

ErrorDetail[]

Détails de l’erreur.
message

string

Message d’erreur.
target

string

Cible d’erreur.

ErrorResponse

Object

Réponse d’erreur

Nom Type Description
error

ErrorDetail

Objet d’erreur.

SubscriptionKeysContract

Object

Clés d’abonnement.

Nom Type Description
primaryKey

string

minLength: 1
maxLength: 256

Clé primaire d’abonnement.
secondaryKey

string

minLength: 1
maxLength: 256

Clé secondaire d’abonnement.