Partager via

Namespaces - List Keys

Service:
Notification Hubs
Version d'API:
2023-09-01

Obtient les chaînes de connexion primaire et secondaire à 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

minLength: 1
maxLength: 256
pattern: ^[a-zA-Z0-9!()*-._]+$

Nom de la règle d’autorisation
namespaceName
 path True

string

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

Nom de l’espace de noms
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

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

minLength: 1

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
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

Namespaces_ListKeys

Exemple de requête

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

Exemple de réponse

Code d’état:
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 de la requête POST qui retourne les clés d’accès Espace de noms ou NotificationHub (chaînes de connexion).

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.

ResourceListKeys

Object

Réponse de la requête POST qui retourne les 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’autorisation créée
primaryConnectionString

string

Obtient ou définit primaryConnectionString de l’authorizationRule.
primaryKey

string

Obtient ou définit primaryKey de l’autorisation créée.
secondaryConnectionString

string

Obtient ou définit secondaryConnectionString de l’autorisation créée
secondaryKey

string

Obtient ou définit secondaryKey de l’autorisation créée