Notification Hubs - List

Referencia

Servicio:: Notification Hubs

Versión de la API:: 2023-09-01

Enumera los centros de notificaciones asociados a un espacio de nombres.

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

Con parámetros opcionales:

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
namespaceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z][a-zA-Z0-9-]*$	Nombre del espacio de nombres
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.
subscriptionId	path	True	string (uuid)	Identificador de la suscripción de destino. El valor debe ser un UUID.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.
$skipToken	query		string	Token de continuación.
$top	query		integer (int32)	Tamaño de página.

Respuestas

Nombre	Tipo	Description
200 OK	NotificationHubListResult	Éxito
Other Status Codes	ErrorResponse	Código de error con motivo.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

NotificationHubs_List

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:: 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"
      }
    }
  ]
}

Definiciones

Nombre	Description
AccessRights	Define valores para AccessRights.
AdmCredential	Descripción de notificationHub AdmCredential.
AdmCredentialProperties	Descripción de notificationHub AdmCredential.
ApnsCredential	Descripción de notificationHub ApnsCredential.
ApnsCredentialProperties	Descripción de notificationHub ApnsCredential.
BaiduCredential	Descripción de notificationHub BaiduCredential.
BaiduCredentialProperties	Descripción de notificationHub BaiduCredential.
BrowserCredential	Descripción de notificationHub BrowserCredential.
BrowserCredentialProperties	Descripción de notificationHub BrowserCredential.
createdByType	Tipo de identidad que creó el recurso.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
GcmCredential	Descripción de notificationHub GcmCredential.
GcmCredentialProperties	Descripción de notificationHub GcmCredential.
MpnsCredential	Descripción de notificationHub MpnsCredential.
MpnsCredentialProperties	Descripción de notificationHub MpnsCredential.
NotificationHubListResult	Respuesta de la operación List NotificationHub.
NotificationHubProperties	Propiedades de NotificationHub.
NotificationHubResource	Recurso del Centro de notificaciones.
SharedAccessAuthorizationRuleProperties	Propiedades SharedAccessAuthorizationRule.
Sku	Descripción de la SKU de un espacio de nombres
SkuName	Nombre de la SKU del espacio de nombres.
systemData	Metadatos relativos a la creación y última modificación del recurso.
WnsCredential	Descripción de un NotificationHub WnsCredential.
WnsCredentialProperties	Descripción de un NotificationHub WnsCredential.
XiaomiCredential	Descripción de notificationHub XiaomiCredential.
XiaomiCredentialProperties	Descripción de notificationHub XiaomiCredentialProperties.

AccessRights

Enumeración

Define valores para AccessRights.

Valor	Description
Listen
Manage
Send

AdmCredential

Object

Descripción de notificationHub AdmCredential.

Nombre	Tipo	Description
properties	AdmCredentialProperties	Descripción de notificationHub AdmCredential.

AdmCredentialProperties

Object

Descripción de notificationHub AdmCredential.

Nombre	Tipo	Description
authTokenUrl	string minLength: 1	Obtiene o establece la dirección URL del token de autorización.
clientId	string minLength: 1	Obtiene o establece el identificador de cliente.
clientSecret	string minLength: 1	Obtiene o establece la clave de acceso secreta de credenciales.

ApnsCredential

Object

Descripción de notificationHub ApnsCredential.

Nombre	Tipo	Description
properties	ApnsCredentialProperties	Descripción de notificationHub ApnsCredential.

ApnsCredentialProperties

Object

Descripción de notificationHub ApnsCredential.

Nombre	Tipo	Description
apnsCertificate	string	Obtiene o establece el certificado APNS.
appId	string	Obtiene o establece la clave de notificación registrada del emisor (iss), cuyo valor es el identificador de equipo de 10 caracteres, obtenido de la cuenta de desarrollador.
appName	string	Obtiene o establece el nombre de la aplicación.
certificateKey	string	Obtiene o establece la clave de certificado.
endpoint	string minLength: 1	Obtiene o establece el punto de conexión de esta credencial.
keyId	string	Obtiene o establece una clave de identificador de clave de 10 caracteres (kid), obtenida de la cuenta de desarrollador.
thumbprint	string	Obtiene o establece la huella digital del certificado APNS.
token	string	Obtiene o establece el token de autenticación del proveedor, obtenido a través de la cuenta de desarrollador.

BaiduCredential

Object

Descripción de notificationHub BaiduCredential.

Nombre	Tipo	Description
properties	BaiduCredentialProperties	Descripción de notificationHub BaiduCredential.

BaiduCredentialProperties

Object

Descripción de notificationHub BaiduCredential.

Nombre	Tipo	Description
baiduApiKey	string minLength: 1	Obtiene o establece la clave de api baidu.
baiduEndPoint	string minLength: 1	Obtiene o establece el punto de conexión baidu.
baiduSecretKey	string minLength: 1	Obtiene o establece baidu Secret Key

BrowserCredential

Object

Descripción de notificationHub BrowserCredential.

Nombre	Tipo	Description
properties	BrowserCredentialProperties	Descripción de notificationHub BrowserCredential.

BrowserCredentialProperties

Object

Descripción de notificationHub BrowserCredential.

Nombre	Tipo	Description
subject	string minLength: 1	Obtiene o establece el asunto de inserción web.
vapidPrivateKey	string minLength: 1	Obtiene o establece la clave privada VAPID.
vapidPublicKey	string minLength: 1	Obtiene o establece la clave pública VAPID.

createdByType

Enumeración

Tipo de identidad que creó el recurso.

Valor	Description
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Object

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

GcmCredential

Object

Descripción de notificationHub GcmCredential.

Nombre	Tipo	Description
properties	GcmCredentialProperties	Descripción de notificationHub GcmCredential.

GcmCredentialProperties

Object

Descripción de notificationHub GcmCredential.

Nombre	Tipo	Description
gcmEndpoint	string	Obtiene o establece el punto de conexión de GCM.
googleApiKey	string minLength: 1	Obtiene o establece la clave de API de Google.

MpnsCredential

Object

Descripción de notificationHub MpnsCredential.

Nombre	Tipo	Description
properties	MpnsCredentialProperties	Descripción de notificationHub MpnsCredential.

MpnsCredentialProperties

Object

Descripción de notificationHub MpnsCredential.

Nombre	Tipo	Description
certificateKey	string minLength: 1	Obtiene o establece la clave de certificado para esta credencial.
mpnsCertificate	string minLength: 1	Obtiene o establece el certificado MPNS.
thumbprint	string minLength: 1	Obtiene o establece la huella digital del certificado MPNS.

NotificationHubListResult

Object

Respuesta de la operación List NotificationHub.

Nombre	Tipo	Description
nextLink	string	Obtiene o establece el vínculo al siguiente conjunto de resultados.
value	NotificationHubResource[]	Obtiene o establece el resultado de la operación List AuthorizationRules.

NotificationHubProperties

Object

Propiedades de NotificationHub.

Nombre	Tipo	Description
admCredential	AdmCredential	Descripción de notificationHub AdmCredential.
apnsCredential	ApnsCredential	Descripción de notificationHub ApnsCredential.
authorizationRules	SharedAccessAuthorizationRuleProperties[]	Obtiene o establece authorizationRules del objeto NotificationHub creado.
baiduCredential	BaiduCredential	Descripción de notificationHub BaiduCredential.
browserCredential	BrowserCredential	Descripción de notificationHub BrowserCredential.
dailyMaxActiveDevices	integer (int64)
gcmCredential	GcmCredential	Descripción de notificationHub GcmCredential.
mpnsCredential	MpnsCredential	Descripción de notificationHub MpnsCredential.
name	string	Obtiene o establece el nombre de NotificationHub.
registrationTtl	string	Obtiene o establece registrationTtl de NotificationHub creado.
wnsCredential	WnsCredential	Descripción de un NotificationHub WnsCredential.
xiaomiCredential	XiaomiCredential	Descripción de notificationHub XiaomiCredential.

NotificationHubResource

Object

Recurso del Centro de notificaciones.

Nombre	Tipo	Description
id	string (arm-id)	Identificador de recurso completo para el recurso. Por ejemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string	Ubicación geográfica donde reside el recurso
name	string	Nombre del recurso
properties	NotificationHubProperties	Propiedades de NotificationHub.
sku	Sku	Descripción de la SKU de un espacio de nombres
systemData	systemData	Metadatos de Azure Resource Manager que contienen información createdBy y modifiedBy.
tags	object	Etiquetas de recursos.
type	string	Tipo del recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

SharedAccessAuthorizationRuleProperties

Object

Propiedades SharedAccessAuthorizationRule.

Nombre	Tipo	Description
claimType	string	Obtiene una cadena que describe el tipo de notificación.
claimValue	string	Obtiene una cadena que describe el valor de notificación.
createdTime	string (date-time)	Obtiene la hora de creación de esta regla.
keyName	string	Obtiene una cadena que describe la regla de autorización.
modifiedTime	string (date-time)	Obtiene la hora de la última modificación de esta regla.
primaryKey	string	Obtiene una clave principal de 256 bits codificada en base64 para firmar y validar el token de SAS.
revision	integer (int32)	Obtiene el número de revisión de la regla.
rights	AccessRights[]	Obtiene o establece los derechos asociados a la regla.
secondaryKey	string	Obtiene una clave principal de 256 bits codificada en base64 para firmar y validar el token de SAS.

Sku

Object

Descripción de la SKU de un espacio de nombres

Nombre	Tipo	Description
capacity	integer (int32)	Obtiene o establece la capacidad del recurso.
family	string	Obtiene o establece la familia de SKU.
name	SkuName	Nombre de la SKU del espacio de nombres.
size	string	Obtiene o establece el tamaño de SKU.
tier	string	Obtiene o establece el nivel de SKU concreto.

SkuName

Enumeración

Nombre de la SKU del espacio de nombres.

Valor	Description
Basic
Free
Standard

systemData

Object

Metadatos relativos a la creación y última modificación del recurso.

Nombre	Tipo	Description
createdAt	string (date-time)	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string (date-time)	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.

WnsCredential

Object

Descripción de un NotificationHub WnsCredential.

Nombre	Tipo	Description
properties	WnsCredentialProperties	Descripción de un NotificationHub WnsCredential.

WnsCredentialProperties

Object

Descripción de un NotificationHub WnsCredential.

Nombre	Tipo	Description
certificateKey	string	Ges o establece la clave de certificado WNS.
packageSid	string	Obtiene o establece el identificador de paquete de esta credencial.
secretKey	string	Obtiene o establece la clave secreta.
windowsLiveEndpoint	string	Obtiene o establece el punto de conexión de Windows Live.
wnsCertificate	string	Obtiene o establece el certificado WNS.

XiaomiCredential

Object

Descripción de notificationHub XiaomiCredential.

Nombre	Tipo	Description
properties	XiaomiCredentialProperties	Descripción de notificationHub XiaomiCredentialProperties.

XiaomiCredentialProperties

Object

Descripción de notificationHub XiaomiCredentialProperties.

Nombre	Tipo	Description
appSecret	string	Obtiene o establece el secreto de la aplicación.
endpoint	string	Obtiene o establece el punto de conexión de servicio de Xiaomi.

Compartir a través de

Notification Hubs - List

Parámetros de identificador URI

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

NotificationHubs_List

Solicitud de ejemplo

Respuesta de muestra

Definiciones

AccessRights

AdmCredential

AdmCredentialProperties

ApnsCredential

ApnsCredentialProperties

BaiduCredential

BaiduCredentialProperties

BrowserCredential

BrowserCredentialProperties

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GcmCredential

GcmCredentialProperties

MpnsCredential

MpnsCredentialProperties

NotificationHubListResult

NotificationHubProperties

NotificationHubResource

SharedAccessAuthorizationRuleProperties

Sku

SkuName

systemData

WnsCredential

WnsCredentialProperties

XiaomiCredential

XiaomiCredentialProperties