Namespaces - Get

Referencia

Servicio:: Notification Hubs

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

Devuelve el espacio de nombres especificado.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
namespaceName	path	True	string	Nombre del espacio de nombres Patrón de Regex: `^[a-zA-Z][a-zA-Z0-9-]*$`
resourceGroupName	path	True	string	Nombre del grupo de recursos. El nombre 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	Versión de API que se usará para la operación.

Respuestas

Nombre	Tipo	Description
200 OK	NamespaceResource	Correcto
Other Status Codes	ErrorResponse	Código de error con motivo.

Seguridad

azure_auth

Flujo 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	suplantación de su cuenta de usuario

Ejemplos

Namespaces_Get

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:: 200

{
  "location": "East US",
  "sku": {
    "name": "Standard"
  },
  "properties": {
    "name": "nh-sdk-ns",
    "provisioningState": "Succeeded",
    "status": "Created",
    "enabled": true,
    "critical": false,
    "subscriptionId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40",
    "createdAt": "2023-04-26T06:10:44.01+00:00",
    "updatedAt": "2023-04-26T06:10:44.03+00:00",
    "namespaceType": "NotificationHub",
    "publicNetworkAccess": "Enabled",
    "networkAcls": {
      "ipRules": [
        {
          "ipMask": "185.48.100.00/24",
          "rights": [
            "Manage",
            "Send",
            "Listen"
          ]
        }
      ],
      "publicNetworkRule": {
        "rights": [
          "Listen"
        ]
      }
    },
    "serviceBusEndpoint": "https://nh-sdk-ns.servicebus.windows.net:443/",
    "privateEndpointConnections": []
  },
  "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/5ktrial/providers/Microsoft.NotificationHubs/namespaces/nh-sdk-ns",
  "name": "nh-sdk-ns",
  "type": "Microsoft.NotificationHubs/namespaces",
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  }
}

Definiciones

Nombre	Description
AccessRights	Define los valores de 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.
IpRule	Regla de autorización de red que filtra el tráfico en función de la dirección IP.
MpnsCredential	Descripción de un Objeto MpnsCredential de NotificationHub.
MpnsCredentialProperties	Descripción de un Objeto MpnsCredential de NotificationHub.
NamespaceProperties	Representa las propiedades del espacio de nombres.
NamespaceResource	Recurso de espacio de nombres de Notification Hubs.
NamespaceStatus	Estado del espacio de nombres.
NamespaceType	Define valores para NamespaceType.
NetworkAcls	Colección de reglas de autorización de red.
OperationProvisioningState	Define valores para OperationProvisioningState.
PnsCredentials	Colección de credenciales PNS del espacio de nombres del centro de notificaciones o del centro de notificaciones.
PrivateEndpointConnectionProperties	Propiedades de conexión de punto de conexión privado.
PrivateEndpointConnectionProvisioningState	Estado de la conexión de punto de conexión privado.
PrivateEndpointConnectionResource	Representa un recurso arm de conexión de punto de conexión privado: un subrecurso del espacio de nombres de Notification Hubs.
PrivateLinkConnectionStatus	Estado de Private Link conexión.
PublicInternetAuthorizationRule	Una regla de autorización de red predeterminada (pública de Internet), que contiene derechos si no coincide ninguna otra regla de red.
PublicNetworkAccess	Tipo de acceso a la red pública.
RemotePrivateEndpointConnection	Representa un punto de conexión privado que está conectado al espacio de nombres de Notification Hubs mediante la conexión de punto de conexión privado.
RemotePrivateLinkServiceConnectionState	Estado de la conexión del servicio de Private Link.
ReplicationRegion	Región de replicación permitida
Sku	Descripción de la SKU de un espacio de nombres
SkuName	Nombre de la SKU del espacio de nombres.
systemData	Metadatos relacionados con la creación y la última modificación del recurso.
WnsCredential	Descripción de un NotificationHub WnsCredential.
WnsCredentialProperties	Descripción de un NotificationHub WnsCredential.
XiaomiCredential	Descripción de un NotificationHub XiaomiCredential.
XiaomiCredentialProperties	Descripción de notificationHub XiaomiCredentialProperties.
ZoneRedundancyPreference	Nombre de la SKU del espacio de nombres.

AccessRights

Define los valores de AccessRights.

Nombre	Tipo	Description
Listen	string
Manage	string
Send	string

AdmCredential

Descripción de notificationHub AdmCredential.

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

AdmCredentialProperties

Descripción de notificationHub AdmCredential.

Nombre	Tipo	Description
authTokenUrl	string	Obtiene o establece la dirección URL del token de autorización.
clientId	string	Obtiene o establece el identificador de cliente.
clientSecret	string	Obtiene o establece la clave de acceso del secreto de credencial.

ApnsCredential

Descripción de notificationHub ApnsCredential.

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

ApnsCredentialProperties

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

Descripción de notificationHub BaiduCredential.

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

BaiduCredentialProperties

Descripción de notificationHub BaiduCredential.

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

BrowserCredential

Descripción de notificationHub BrowserCredential.

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

BrowserCredentialProperties

Descripción de notificationHub BrowserCredential.

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

createdByType

Tipo de identidad que creó el recurso.

Nombre	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

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

Detalle del error.

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

ErrorResponse

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

GcmCredential

Descripción de notificationHub GcmCredential.

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

GcmCredentialProperties

Descripción de notificationHub GcmCredential.

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

IpRule

Regla de autorización de red que filtra el tráfico en función de la dirección IP.

Nombre	Tipo	Description
ipMask	string	Máscara IP.
rights	AccessRights[]	Lista de derechos de acceso.

MpnsCredential

Descripción de un Objeto MpnsCredential de NotificationHub.

Nombre	Tipo	Description
properties	MpnsCredentialProperties	Descripción de un Objeto MpnsCredential de NotificationHub.

MpnsCredentialProperties

Descripción de un Objeto MpnsCredential de NotificationHub.

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

NamespaceProperties

Representa las propiedades del espacio de nombres.

Nombre	Tipo	Valor predeterminado	Description
createdAt	string		Hora en que se creó el espacio de nombres.
critical	boolean		Obtiene o establece si el espacio de nombres se establece o no como Crítico.
dataCenter	string		Desusado.
enabled	boolean		Obtiene o establece si el espacio de nombres está habilitado actualmente.
metricId	string		Identificador de métricas de Azure Insights.
name	string		Nombre del espacio de nombres de Notification Hubs. Esta propiedad es inmutable, establecida automáticamente por el servicio cuando se crea el espacio de nombres.
namespaceType	NamespaceType		Define valores para NamespaceType.
networkAcls	NetworkAcls		Colección de reglas de autorización de red.
pnsCredentials	PnsCredentials		Colección de credenciales PNS del espacio de nombres del centro de notificaciones o del centro de notificaciones.
privateEndpointConnections	PrivateEndpointConnectionResource[]		Connections de punto de conexión privado para el espacio de nombres
provisioningState	OperationProvisioningState		Define valores para OperationProvisioningState.
publicNetworkAccess	PublicNetworkAccess	Enabled	Tipo de acceso a la red pública.
region	string		Región. El valor siempre se establece en el mismo valor que Namespace.Location, por lo que estamos en desuso en esta propiedad.
replicationRegion	ReplicationRegion		Región de replicación permitida
scaleUnit	string		Obtiene o establece scaleUnit donde se crea el espacio de nombres.
serviceBusEndpoint	string		Obtiene o establece el punto de conexión que puede usar para realizar operaciones de NotificationHub.
status	NamespaceStatus		Estado del espacio de nombres.
subscriptionId	string		Id. de suscripción del espacio de nombres.
updatedAt	string		Hora en que se actualizó el espacio de nombres.
zoneRedundancy	ZoneRedundancyPreference	Disabled	Nombre de la SKU del espacio de nombres.

NamespaceResource

Recurso de espacio de nombres de Notification Hubs.

Nombre	Tipo	Description
id	string	Identificador de recurso completo del 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	NamespaceProperties	Representa las propiedades del espacio de nombres.
sku	Sku	Descripción de la SKU de un espacio de nombres
systemData	systemData	Metadatos de Azure Resource Manager que contienen información sobre los valores de createdBy y modifiedBy.
tags	object	Etiquetas del recurso.
type	string	Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

NamespaceStatus

Estado del espacio de nombres.

Nombre	Tipo	Description
Created	string
Creating	string
Deleting	string
Suspended	string

NamespaceType

Define valores para NamespaceType.

Nombre	Tipo	Description
Messaging	string
NotificationHub	string

NetworkAcls

Colección de reglas de autorización de red.

Nombre	Tipo	Description
ipRules	IpRule[]	Lista de reglas de IP.
publicNetworkRule	PublicInternetAuthorizationRule	Una regla de autorización de red predeterminada (pública de Internet), que contiene derechos si no coincide ninguna otra regla de red.

OperationProvisioningState

Define valores para OperationProvisioningState.

Nombre	Tipo	Description
Canceled	string
Disabled	string
Failed	string
InProgress	string
Pending	string
Succeeded	string
Unknown	string

PnsCredentials

Colección de credenciales PNS del espacio de nombres del centro de notificaciones o del centro de notificaciones.

Nombre	Tipo	Description
admCredential	AdmCredential	Descripción de notificationHub AdmCredential.
apnsCredential	ApnsCredential	Descripción de notificationHub ApnsCredential.
baiduCredential	BaiduCredential	Descripción de notificationHub BaiduCredential.
browserCredential	BrowserCredential	Descripción de notificationHub BrowserCredential.
gcmCredential	GcmCredential	Descripción de notificationHub GcmCredential.
mpnsCredential	MpnsCredential	Descripción de un Objeto MpnsCredential de NotificationHub.
wnsCredential	WnsCredential	Descripción de un NotificationHub WnsCredential.
xiaomiCredential	XiaomiCredential	Descripción de un NotificationHub XiaomiCredential.

PrivateEndpointConnectionProperties

Propiedades de conexión de punto de conexión privado.

Nombre	Tipo	Description
groupIds	string[]	Lista de identificadores de grupo. Para Notification Hubs, siempre contiene un único elemento "espacio de nombres".
privateEndpoint	RemotePrivateEndpointConnection	Representa un punto de conexión privado que está conectado al espacio de nombres de Notification Hubs mediante la conexión de punto de conexión privado.
privateLinkServiceConnectionState	RemotePrivateLinkServiceConnectionState	Estado de la conexión del servicio de Private Link.
provisioningState	PrivateEndpointConnectionProvisioningState	Estado de la conexión de punto de conexión privado.

PrivateEndpointConnectionProvisioningState

Estado de la conexión de punto de conexión privado.

Nombre	Tipo	Description
Creating	string
Deleted	string
Deleting	string
DeletingByProxy	string
Succeeded	string
Unknown	string
Updating	string
UpdatingByProxy	string

PrivateEndpointConnectionResource

Representa un recurso arm de conexión de punto de conexión privado: un subrecurso del espacio de nombres de Notification Hubs.

Nombre	Tipo	Description
id	string	Identificador de recurso completo del recurso. Por ejemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Nombre del recurso.
properties	PrivateEndpointConnectionProperties	Propiedades de conexión de punto de conexión privado.
systemData	systemData	Metadatos de Azure Resource Manager que contienen información sobre los valores de createdBy y modifiedBy.
type	string	Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

PrivateLinkConnectionStatus

Estado de Private Link conexión.

Nombre	Tipo	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

PublicInternetAuthorizationRule

Una regla de autorización de red predeterminada (pública de Internet), que contiene derechos si no coincide ninguna otra regla de red.

Nombre	Tipo	Description
rights	AccessRights[]	Lista de derechos de acceso.

PublicNetworkAccess

Tipo de acceso a la red pública.

Nombre	Tipo	Description
Disabled	string
Enabled	string

RemotePrivateEndpointConnection

Representa un punto de conexión privado que está conectado al espacio de nombres de Notification Hubs mediante la conexión de punto de conexión privado.

Nombre	Tipo	Description
id	string	Identificador de recurso de ARM del punto de conexión privado. Esto puede pertenecer a una suscripción y un grupo de recursos diferentes a un espacio de nombres de Notification Hubs.

RemotePrivateLinkServiceConnectionState

Estado de la conexión del servicio de Private Link.

Nombre	Tipo	Description
actionsRequired	string	Descripción humana de las acciones necesarias.
description	string	Descripción humana.
status	PrivateLinkConnectionStatus	Estado de Private Link conexión.

ReplicationRegion

Región de replicación permitida

Nombre	Tipo	Description
AustraliaEast	string
BrazilSouth	string
Default	string
None	string
NorthEurope	string
SouthAfricaNorth	string
SouthEastAsia	string
WestUs2	string

Sku

Descripción de la SKU de un espacio de nombres

Nombre	Tipo	Description
capacity	integer	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 la SKU.
tier	string	Obtiene o establece el nivel de SKU determinada.

SkuName

Nombre de la SKU del espacio de nombres.

Nombre	Tipo	Description
Basic	string
Free	string
Standard	string

systemData

Metadatos relacionados con la creación y la última modificación del recurso.

Nombre	Tipo	Description
createdAt	string	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	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

Descripción de un NotificationHub WnsCredential.

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

WnsCredentialProperties