Partager via

Notification Hubs - List

  • Référence
Service:
Notification Hubs
Version d'API:
2023-09-01

Listes les hubs de notification associés à un espace de noms.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs?api-version=2023-09-01
Avec des paramètres facultatifs: 
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs?$skipToken={$skipToken}&$top={$top}&api-version=2023-09-01

Paramètres URI

Nom Dans Obligatoire Type Description
namespaceName
 path True

string

Nom de l’espace de noms

Modèle d’expression régulière: ^[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.
$skipToken
 query

string

Jeton de continuation.
$top
 query

integer

int32

Taille de page.

Réponses

Nom Type Description
200 OK

NotificationHubListResult

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

NotificationHubs_List

Exemple de requête

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

Exemple de réponse

Code d’état:
200 
{
  "value": [
    {
      "location": "East US",
      "properties": {
        "name": "test",
        "registrationTtl": "10675199.02:48:05.4775807",
        "dailyMaxActiveDevices": 0
      },
      "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/5ktrial/providers/Microsoft.NotificationHubs/namespaces/nh-sdk-ns/notificationHubs/test",
      "name": "test",
      "type": "Microsoft.NotificationHubs/namespaces/notificationHubs",
      "tags": {
        "hubTag1": "hubTagValue1",
        "hubTag2": "hubTagValue2"
      }
    }
  ]
}

Définitions

Nom Description
AccessRights

Définit des valeurs pour AccessRights.
AdmCredential

Description d’un AdmCredential NotificationHub.
AdmCredentialProperties

Description d’un AdmCredential NotificationHub.
ApnsCredential

Description d’un Objet NotificationHub ApnsCredential.
ApnsCredentialProperties

Description d’un Objet NotificationHub ApnsCredential.
BaiduCredential

Description d’un NotificationHub BaiduCredential.
BaiduCredentialProperties

Description d’un NotificationHub BaiduCredential.
BrowserCredential

Description d’un objet NotificationHub BrowserCredential.
BrowserCredentialProperties

Description d’un objet NotificationHub BrowserCredential.
createdByType

Type d’identité qui a créé la ressource.
ErrorAdditionalInfo

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

Détail de l’erreur.
ErrorResponse

Réponse d’erreur
GcmCredential

Description d’un NotificationHub GcmCredential.
GcmCredentialProperties

Description d’un NotificationHub GcmCredential.
MpnsCredential

Description d’un Objet NotificationHub MpnsCredential.
MpnsCredentialProperties

Description d’un Objet NotificationHub MpnsCredential.
NotificationHubListResult

Réponse de l’opération List NotificationHub.
NotificationHubProperties

Propriétés notificationHub.
NotificationHubResource

Ressource Notification Hub.
SharedAccessAuthorizationRuleProperties

Propriétés SharedAccessAuthorizationRule.
Sku

Description de la référence SKU pour un espace de noms
SkuName

Nom de la référence SKU de l’espace de noms.
systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.
WnsCredential

Description d’un NotificationHub WnsCredential.
WnsCredentialProperties

Description d’un NotificationHub WnsCredential.
XiaomiCredential

Description d’un NotificationHubHubCredential.
XiaomiCredentialProperties

Description d’un Objet NotificationHub CdcCredentialProperties.

AccessRights

Définit des valeurs pour AccessRights.

Nom Type Description
Listen

string

Manage

string

Send

string

AdmCredential

Description d’un AdmCredential NotificationHub.

Nom Type Description
properties

AdmCredentialProperties

Description d’un AdmCredential NotificationHub.

AdmCredentialProperties

Description d’un AdmCredential NotificationHub.

Nom Type Description
authTokenUrl

string

Obtient ou définit l’URL du jeton d’autorisation.
clientId

string

Obtient ou définit l’identificateur du client.
clientSecret

string

Obtient ou définit la clé d’accès au secret d’informations d’identification.

ApnsCredential

Description d’un Objet NotificationHub ApnsCredential.

Nom Type Description
properties

ApnsCredentialProperties

Description d’un Objet NotificationHub ApnsCredential.

ApnsCredentialProperties

Description d’un Objet NotificationHub ApnsCredential.

Nom Type Description
apnsCertificate

string

Obtient ou définit le certificat APNS.
appId

string

Obtient ou définit la clé de revendication inscrite de l’émetteur (iss), dont la valeur est votre ID d’équipe de 10 caractères, obtenue à partir de votre compte de développeur
appName

string

Obtient ou définit le nom de l’application
certificateKey

string

Obtient ou définit la clé de certificat.
endpoint

string

Obtient ou définit le point de terminaison de ces informations d’identification.
keyId

string

Obtient ou définit une clé d’identificateur de clé de 10 caractères (enfant) obtenue à partir de votre compte de développeur
thumbprint

string

Obtient ou définit l’empreinte numérique du certificat APNS
token

string

Obtient ou définit le jeton d’authentification du fournisseur, obtenu via votre compte de développeur

BaiduCredential

Description d’un NotificationHub BaiduCredential.

Nom Type Description
properties

BaiduCredentialProperties

Description d’un NotificationHub BaiduCredential.

BaiduCredentialProperties

Description d’un NotificationHub BaiduCredential.

Nom Type Description
baiduApiKey

string

Obtient ou définit la clé API baidu.
baiduEndPoint

string

Obtient ou définit le point de terminaison baidu.
baiduSecretKey

string

Obtient ou définit la clé secrète baidu

BrowserCredential

Description d’un objet NotificationHub BrowserCredential.

Nom Type Description
properties

BrowserCredentialProperties

Description d’un objet NotificationHub BrowserCredential.

BrowserCredentialProperties

Description d’un objet NotificationHub BrowserCredential.

Nom Type Description
subject

string

Obtient ou définit l’objet push web.
vapidPrivateKey

string

Obtient ou définit la clé privée VAPID.
vapidPublicKey

string

Obtient ou définit la clé publique VAPID.

createdByType

Type d’identité qui a créé la ressource.

Nom Type Description
Application

string

Key

string

ManagedIdentity

string

User

string

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.

GcmCredential

Description d’un NotificationHub GcmCredential.

Nom Type Description
properties

GcmCredentialProperties

Description d’un NotificationHub GcmCredential.

GcmCredentialProperties

Description d’un NotificationHub GcmCredential.

Nom Type Description
gcmEndpoint

string

Obtient ou définit le point de terminaison GCM.
googleApiKey

string

Obtient ou définit la clé API Google.

MpnsCredential

Description d’un Objet NotificationHub MpnsCredential.

Nom Type Description
properties

MpnsCredentialProperties

Description d’un Objet NotificationHub MpnsCredential.

MpnsCredentialProperties

Description d’un Objet NotificationHub MpnsCredential.

Nom Type Description
certificateKey

string

Obtient ou définit la clé de certificat pour ces informations d’identification.
mpnsCertificate

string

Obtient ou définit le certificat MPNS.
thumbprint

string

Obtient ou définit l’empreinte numérique du certificat MPNS

NotificationHubListResult

Réponse de l’opération List NotificationHub.

Nom Type Description
nextLink

string

Obtient ou définit le lien vers l’ensemble de résultats suivant.
value

NotificationHubResource[]

Obtient ou définit le résultat de l’opération List AuthorizationRules.

NotificationHubProperties

Propriétés notificationHub.

Nom Type Description
admCredential

AdmCredential

Description d’un AdmCredential NotificationHub.
apnsCredential

ApnsCredential

Description d’un Objet NotificationHub ApnsCredential.
authorizationRules

SharedAccessAuthorizationRuleProperties[]

Obtient ou définit les règles AuthorizationRules du NotificationHub créé
baiduCredential

BaiduCredential

Description d’un NotificationHub BaiduCredential.
browserCredential

BrowserCredential

Description d’un objet NotificationHub BrowserCredential.
dailyMaxActiveDevices

integer

gcmCredential

GcmCredential

Description d’un NotificationHub GcmCredential.
mpnsCredential

MpnsCredential

Description d’un Objet NotificationHub MpnsCredential.
name

string

Obtient ou définit le nom NotificationHub.
registrationTtl

string

Obtient ou définit le RegistrationTtl du NotificationHub créé
wnsCredential

WnsCredential

Description d’un NotificationHub WnsCredential.
xiaomiCredential

XiaomiCredential

Description d’un NotificationHubHubCredential.

NotificationHubResource

Ressource Notification Hub.

Nom Type Description
id

string

ID de ressource complet pour la ressource. Par exemple, « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} »
location

string

Emplacement géographique où réside la ressource
name

string

nom de la ressource.
properties

NotificationHubProperties

Propriétés notificationHub.
sku

Sku

Description de la référence SKU pour un espace de noms
systemData

systemData

Métadonnées Azure Resource Manager contenant les informations createdBy et modifiedBy.
tags

object

Balises de ressource.
type

string

Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

SharedAccessAuthorizationRuleProperties

Propriétés SharedAccessAuthorizationRule.

Nom Type Description
claimType

string

Obtient une chaîne qui décrit le type de revendication
claimValue

string

Obtient une chaîne qui décrit la valeur de revendication
createdTime

string

Obtient l’heure de création pour cette règle
keyName

string

Obtient une chaîne qui décrit la règle d’autorisation.
modifiedTime

string

Obtient l’heure de la dernière modification pour cette règle
primaryKey

string

Obtient une clé primaire 256 bits encodée en base64 pour la signature et la validation du jeton SAS.
revision

integer

Obtient le numéro de révision de la règle
rights

AccessRights[]

Obtient ou définit les droits associés à la règle.
secondaryKey

string

Obtient une clé primaire 256 bits encodée en base64 pour la signature et la validation du jeton SAS.

Sku

Description de la référence SKU pour un espace de noms

Nom Type Description
capacity

integer

Obtient ou définit la capacité de la ressource
family

string

Obtient ou définit la famille de références SKU
name

SkuName

Nom de la référence SKU de l’espace de noms.
size

string

Obtient ou définit la taille de la référence SKU
tier

string

Obtient ou définit le niveau d’une référence SKU particulière

SkuName

Nom de la référence SKU de l’espace de noms.

Nom Type Description
Basic

string

Free

string

Standard

string

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom Type Description
createdAt

string

Horodatage de la création de ressources (UTC).
createdBy

string

Identité qui a créé la ressource.
createdByType

createdByType

Type d’identité qui a créé la ressource.
lastModifiedAt

string

Horodatage de la dernière modification de la ressource (UTC)
lastModifiedBy

string

Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType

createdByType

Type d’identité qui a modifié la ressource pour la dernière fois.

WnsCredential

Description d’un NotificationHub WnsCredential.

Nom Type Description
properties

WnsCredentialProperties

Description d’un NotificationHub WnsCredential.

WnsCredentialProperties

Description d’un NotificationHub WnsCredential.

Nom Type Description
certificateKey

string

Ges ou définit la clé de certificat WNS.
packageSid

string

Obtient ou définit l’ID de package pour ces informations d’identification.
secretKey

string

Obtient ou définit la clé secrète.
windowsLiveEndpoint

string

Obtient ou définit le point de terminaison Windows Live.
wnsCertificate

string

Obtient ou définit le certificat WNS.

XiaomiCredential

Description d’un NotificationHubHubCredential.

Nom Type Description
properties

XiaomiCredentialProperties

Description d’un Objet NotificationHub CdcCredentialProperties.

XiaomiCredentialProperties

Description d’un Objet NotificationHub CdcCredentialProperties.

Nom Type Description
appSecret

string

Obtient ou définit le secret de l’application.
endpoint

string

Obtient ou définit le point de terminaison de service de l’api.