Namespaces - List Keys

Service:

Notification Hubs

API Version:

2023-09-01

Obtient les chaînes de connexion primaires et secondaires de l’espace de noms.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/authorizationRules/{authorizationRuleName}/listKeys?api-version=2023-09-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
authorizationRuleName	path	True	string	Nom de la règle d’autorisation Regex pattern: ^[a-zA-Z0-9!()*-._]+$
namespaceName	path	True	string	Nom de l’espace de noms Regex pattern: ^[a-zA-Z][a-zA-Z0-9-]*$
resourceGroupName	path	True	string	Nom du groupe de ressources. Le nom ne respecte pas la casse.
subscriptionId	path	True	string uuid	ID de l’abonnement cible. La valeur doit être un UUID.
api-version	query	True	string	Version de l’API à utiliser pour cette opération.

Réponses

Nom	Type	Description
200 OK	ResourceListKeys	Succès
Other Status Codes	ErrorResponse	Code d’erreur avec raison.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

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

Scopes

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

Exemples

Namespaces_ListKeys

Sample Request

HTTP

POST https://management.azure.com/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/5ktrial/providers/Microsoft.NotificationHubs/namespaces/nh-sdk-ns/authorizationRules/RootManageSharedAccessKey/listKeys?api-version=2023-09-01

Sample Response

Status code:

200

{
  "primaryConnectionString": "Endpoint=sb://nh-sdk-ns.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=############################################",
  "secondaryConnectionString": "Endpoint=sb://nh-sdk-ns.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=############################################",
  "primaryKey": "############################################",
  "secondaryKey": "############################################",
  "keyName": "RootManageSharedAccessKey"
}

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
ResourceListKeys	Réponse pour la requête POST qui renvoie des clés d’accès Espace de noms ou NotificationHub (chaînes de connexion).

ErrorAdditionalInfo

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

Nom	Type	Description
info	object	Informations supplémentaires
type	string	Type d’informations supplémentaires.

ErrorDetail

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

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet error.

ResourceListKeys

Réponse pour la requête POST qui renvoie des clés d’accès Espace de noms ou NotificationHub (chaînes de connexion).

Nom	Type	Description
keyName	string	Obtient ou définit keyName de l’objet AuthorizationRule créé
primaryConnectionString	string	Obtient ou définit primaryConnectionString de l’objet AuthorizationRule.
primaryKey	string	Obtient ou définit primaryKey de l’objet AuthorizationRule créé.
secondaryConnectionString	string	Obtient ou définit secondaryConnectionString de l’objet AuthorizationRule créé
secondaryKey	string	Obtient ou définit secondaryKey de l’objet AuthorizationRule créé