Share via

Namespaces - List

  • Referência
Service:
Notification Hubs
API Version:
2023-09-01

Listas os espaços de nomes disponíveis num grupo de recursos.

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

Parâmetros do URI

Name Em Necessário Tipo Description
resourceGroupName
 path True

string

O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.
subscriptionId
 path True

string

uuid

O ID da subscrição de destino. O valor tem de ser um UUID.
api-version
 query True

string

A versão da API a utilizar para esta operação.
$skipToken
 query

string

Ignorar o token para pedidos subsequentes.
$top
 query

integer

int32

Número máximo de resultados a devolver.

Respostas

Name Tipo Description
200 OK

NamespaceListResult

Com êxito
Other Status Codes

ErrorResponse

Código de erro com motivo.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

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

Scopes

Name Description
user_impersonation representar a sua conta de utilizador

Exemplos

Namespaces_List

Sample Request

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

Sample Response

Status code:
200 
{
  "value": [
    {
      "location": "East US",
      "sku": {
        "name": "Standard"
      },
      "properties": {
        "name": "namespace-1",
        "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://namespace-1.servicebus.windows.net:443/",
        "privateEndpointConnections": []
      },
      "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/5ktrial/providers/Microsoft.NotificationHubs/namespaces/namespace-1",
      "name": "namespace-2",
      "type": "Microsoft.NotificationHubs/namespaces",
      "tags": {}
    },
    {
      "location": "East US",
      "sku": {
        "name": "Standard"
      },
      "properties": {
        "name": "namespace-2",
        "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": [],
          "publicNetworkRule": {
            "rights": [
              "Manage",
              "Listen",
              "Send"
            ]
          }
        },
        "serviceBusEndpoint": "https://namespace-2.servicebus.windows.net:443/",
        "privateEndpointConnections": []
      },
      "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/5ktrial/providers/Microsoft.NotificationHubs/namespaces/namespace-2",
      "name": "namespace-2",
      "type": "Microsoft.NotificationHubs/namespaces",
      "tags": {
        "tag1": "value1",
        "tag2": "value2"
      }
    }
  ],
  "nextLink": "https://management.azure.com/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/providers/Microsoft.NotificationHubs/namespaces?api-version=2023-09-01&$count=2&$skipToken=##################"
}

Definições

Name Description
AccessRights

Define valores para AccessRights.
AdmCredential

Descrição de um NotificationHub AdmCredential.
AdmCredentialProperties

Descrição de um NotificationHub AdmCredential.
ApnsCredential

Descrição de um NotificationHub ApnsCredential.
ApnsCredentialProperties

Descrição de um NotificationHub ApnsCredential.
BaiduCredential

Descrição de um NotificationHub BaiduCredential.
BaiduCredentialProperties

Descrição de um NotificationHub BaiduCredential.
BrowserCredential

Descrição de um NotificationHub BrowserCredential.
BrowserCredentialProperties

Descrição de um NotificationHub BrowserCredential.
createdByType

O tipo de identidade que criou o recurso.
ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.
ErrorDetail

O detalhe do erro.
ErrorResponse

Resposta a erros
GcmCredential

Descrição de um NotificationHub GcmCredential.
GcmCredentialProperties

Descrição de um NotificationHub GcmCredential.
IpRule

Uma regra de autorização de rede que filtra o tráfego com base no endereço IP.
MpnsCredential

Descrição de um NotificationHub MpnsCredential.
MpnsCredentialProperties

Descrição de um NotificationHub MpnsCredential.
NamespaceListResult

A resposta da operação Espaço de Nomes de Lista.
NamespaceProperties

Representa as propriedades do espaço de nomes.
NamespaceResource

Recurso de Espaço de Nomes dos Hubs de Notificação.
NamespaceStatus

Estado do espaço de nomes.
NamespaceType

Define valores para NamespaceType.
NetworkAcls

Uma coleção de regras de autorização de rede.
OperationProvisioningState

Define valores para OperationProvisioningState.
PnsCredentials

Coleção de credenciais PNS do Hub de Notificação ou do Espaço de Nomes do Hub de Notificação.
PrivateEndpointConnectionProperties

Propriedades da Ligação de Ponto Final Privado.
PrivateEndpointConnectionProvisioningState

Estado da Ligação de Ponto Final Privado.
PrivateEndpointConnectionResource

Representa um recurso ARM de Ligação de Ponto Final Privado - um sub-recurso do espaço de nomes dos Hubs de Notificação.
PrivateLinkConnectionStatus

Estado da Ligação Private Link.
PublicInternetAuthorizationRule

Uma regra de autorização de rede predefinida (Internet pública), que contém direitos se nenhuma outra regra de rede corresponder.
PublicNetworkAccess

Tipo de acesso à rede pública.
RemotePrivateEndpointConnection

Representa um Ponto Final Privado que está ligado ao espaço de nomes dos Hubs de Notificação através da Ligação de Ponto Final Privado.
RemotePrivateLinkServiceConnectionState

Estado da ligação do Serviço Private Link.
ReplicationRegion

Região de replicação permitida
Sku

A descrição do SKU para um espaço de nomes
SkuName

Nome do SKU do espaço de nomes.
systemData

Metadados relativos à criação e última modificação do recurso.
WnsCredential

Descrição de um NotificationHub WnsCredential.
WnsCredentialProperties

Descrição de um NotificationHub WnsCredential.
XiaomiCredential

Descrição de um NotificationHub XiaomiCredential.
XiaomiCredentialProperties

Descrição de um NotificationHub XiaomiCredentialProperties.
ZoneRedundancyPreference

Nome do SKU do espaço de nomes.

AccessRights

Define valores para AccessRights.

Name Tipo Description
Listen

string

Manage

string

Send

string

AdmCredential

Descrição de um NotificationHub AdmCredential.

Name Tipo Description
properties

AdmCredentialProperties

Descrição de um NotificationHub AdmCredential.

AdmCredentialProperties

Descrição de um NotificationHub AdmCredential.

Name Tipo Description
authTokenUrl

string

Obtém ou define o URL do token de autorização.
clientId

string

Obtém ou define o identificador de cliente.
clientSecret

string

Obtém ou define a chave de acesso de segredo de credenciais.

ApnsCredential

Descrição de um NotificationHub ApnsCredential.

Name Tipo Description
properties

ApnsCredentialProperties

Descrição de um NotificationHub ApnsCredential.

ApnsCredentialProperties

Descrição de um NotificationHub ApnsCredential.

Name Tipo Description
apnsCertificate

string

Obtém ou define o certificado APNS.
appId

string

Obtém ou define a chave de afirmação registada (iss) do emissor, cujo valor é o seu ID de Equipa de 10 carateres, obtido a partir da sua conta de programador
appName

string

Obtém ou define o nome da aplicação
certificateKey

string

Obtém ou define a chave de certificado.
endpoint

string

Obtém ou define o ponto final desta credencial.
keyId

string

Obtém ou define uma chave de identificador de chave de 10 carateres (criança), obtida a partir da sua conta de programador
thumbprint

string

Obtém ou define o Thumbprint do certificado APNS
token

string

Obtém ou define o Token de Autenticação do fornecedor, obtido através da sua conta de programador

BaiduCredential

Descrição de um NotificationHub BaiduCredential.

Name Tipo Description
properties

BaiduCredentialProperties

Descrição de um NotificationHub BaiduCredential.

BaiduCredentialProperties

Descrição de um NotificationHub BaiduCredential.

Name Tipo Description
baiduApiKey

string

Obtém ou define a Chave de API baidu.
baiduEndPoint

string

Obtém ou define o Ponto Final do baidu.
baiduSecretKey

string

Obtém ou define a Chave Secreta do Baidu

BrowserCredential

Descrição de um NotificationHub BrowserCredential.

Name Tipo Description
properties

BrowserCredentialProperties

Descrição de um NotificationHub BrowserCredential.

BrowserCredentialProperties

Descrição de um NotificationHub BrowserCredential.

Name Tipo Description
subject

string

Obtém ou define o assunto web push.
vapidPrivateKey

string

Obtém ou define a chave privada VAPID.
vapidPublicKey

string

Obtém ou define a chave pública VAPID.

createdByType

O tipo de identidade que criou o recurso.

Name Tipo Description
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.

Name Tipo Description
info

object

As informações adicionais.
type

string

O tipo de informações adicionais.

ErrorDetail

O detalhe do erro.

Name Tipo Description
additionalInfo

ErrorAdditionalInfo[]

As informações adicionais do erro.
code

string

O código de erro.
details

ErrorDetail[]

Os detalhes do erro.
message

string

A mensagem de erro.
target

string

O destino do erro.

ErrorResponse

Resposta a erros

Name Tipo Description
error

ErrorDetail

O objeto de erro.

GcmCredential

Descrição de um NotificationHub GcmCredential.

Name Tipo Description
properties

GcmCredentialProperties

Descrição de um NotificationHub GcmCredential.

GcmCredentialProperties

Descrição de um NotificationHub GcmCredential.

Name Tipo Description
gcmEndpoint

string

Obtém ou define o ponto final do GCM.
googleApiKey

string

Obtém ou define a chave da API Google.

IpRule

Uma regra de autorização de rede que filtra o tráfego com base no endereço IP.

Name Tipo Description
ipMask

string

Máscara de IP.
rights

AccessRights[]

Lista de direitos de acesso.

MpnsCredential

Descrição de um NotificationHub MpnsCredential.

Name Tipo Description
properties

MpnsCredentialProperties

Descrição de um NotificationHub MpnsCredential.

MpnsCredentialProperties

Descrição de um NotificationHub MpnsCredential.

Name Tipo Description
certificateKey

string

Obtém ou define a chave de certificado para esta credencial.
mpnsCertificate

string

Obtém ou define o certificado MPNS.
thumbprint

string

Obtém ou define o Thumbprint do certificado MPNS

NamespaceListResult

A resposta da operação Espaço de Nomes de Lista.

Name Tipo Description
nextLink

string

Obtém ou define a ligação para o próximo conjunto de resultados.
value

NamespaceResource[]

Obtém ou define o resultado da operação List AuthorizationRules.

NamespaceProperties

Representa as propriedades do espaço de nomes.

Name Tipo Valor Predefinido Description
createdAt

string

Hora em que o espaço de nomes foi criado.
critical

boolean

Obtém ou define se o espaço de nomes está ou não definido como Crítico.
dataCenter

string

Preterido.
enabled

boolean

Obtém ou define se o espaço de nomes está ou não ativado.
metricId

string

ID de Métricas do Azure Insights.
name

string

Nome do espaço de nomes dos Hubs de Notificação. Esta é uma propriedade imutável, definida automaticamente pelo serviço quando o espaço de nomes é criado.
namespaceType

NamespaceType

Define valores para NamespaceType.
networkAcls

NetworkAcls

Uma coleção de regras de autorização de rede.
pnsCredentials

PnsCredentials

Coleção de credenciais PNS do Hub de Notificação ou do Espaço de Nomes do Hub de Notificação.
privateEndpointConnections

PrivateEndpointConnectionResource[]

Connections de Ponto Final Privado para o espaço de nomes
provisioningState

OperationProvisioningState

Define valores para OperationProvisioningState.
publicNetworkAccess

PublicNetworkAccess

Enabled

Tipo de acesso à rede pública.
region

string

Região. O valor é sempre definido para o mesmo valor que Namespace.Location, pelo que estamos a preterir esta propriedade.
replicationRegion

ReplicationRegion

Região de replicação permitida
scaleUnit

string

Obtém ou define scaleUnit onde o espaço de nomes é criado
serviceBusEndpoint

string

Obtém ou define o ponto final que pode utilizar para realizar operações do NotificationHub.
status

NamespaceStatus

Estado do espaço de nomes.
subscriptionId

string

ID da subscrição do espaço de nomes.
updatedAt

string

Hora em que o espaço de nomes foi atualizado.
zoneRedundancy

ZoneRedundancyPreference

Disabled

Nome do SKU do espaço de nomes.

NamespaceResource

Recurso de Espaço de Nomes dos Hubs de Notificação.

Name Tipo Description
id

string

ID de recurso completamente qualificado para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location

string

A localização geográfica onde reside o recurso
name

string

O nome do recurso
properties

NamespaceProperties

Representa as propriedades do espaço de nomes.
sku

Sku

A descrição do SKU para um espaço de nomes
systemData

systemData

O Azure Resource Manager metadados que contêm createdBy e modifiedBy information.
tags

object

Etiquetas de recursos.
type

string

O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

NamespaceStatus

Estado do espaço de nomes.

Name Tipo Description
Created

string

Creating

string

Deleting

string

Suspended

string

NamespaceType

Define valores para NamespaceType.

Name Tipo Description
Messaging

string

NotificationHub

string

NetworkAcls

Uma coleção de regras de autorização de rede.

Name Tipo Description
ipRules

IpRule[]

Lista de regras de IP.
publicNetworkRule

PublicInternetAuthorizationRule

Uma regra de autorização de rede predefinida (Internet pública), que contém direitos se nenhuma outra regra de rede corresponder.

OperationProvisioningState

Define valores para OperationProvisioningState.

Name Tipo Description
Canceled

string

Disabled

string

Failed

string

InProgress

string

Pending

string

Succeeded

string

Unknown

string

PnsCredentials

Coleção de credenciais PNS do Hub de Notificação ou do Espaço de Nomes do Hub de Notificação.

Name Tipo Description
admCredential

AdmCredential

Descrição de um NotificationHub AdmCredential.
apnsCredential

ApnsCredential

Descrição de um NotificationHub ApnsCredential.
baiduCredential

BaiduCredential

Descrição de um NotificationHub BaiduCredential.
browserCredential

BrowserCredential

Descrição de um NotificationHub BrowserCredential.
gcmCredential

GcmCredential

Descrição de um NotificationHub GcmCredential.
mpnsCredential

MpnsCredential

Descrição de um NotificationHub MpnsCredential.
wnsCredential

WnsCredential

Descrição de um NotificationHub WnsCredential.
xiaomiCredential

XiaomiCredential

Descrição de um NotificationHub XiaomiCredential.

PrivateEndpointConnectionProperties

Propriedades da Ligação de Ponto Final Privado.

Name Tipo Description
groupIds

string[]

Lista de IDs de grupo. Para Os Hubs de Notificação, contém sempre um único elemento "espaço de nomes".
privateEndpoint

RemotePrivateEndpointConnection

Representa um Ponto Final Privado que está ligado ao espaço de nomes dos Hubs de Notificação através da Ligação de Ponto Final Privado.
privateLinkServiceConnectionState

RemotePrivateLinkServiceConnectionState

Estado da ligação do Serviço Private Link.
provisioningState

PrivateEndpointConnectionProvisioningState

Estado da Ligação de Ponto Final Privado.

PrivateEndpointConnectionProvisioningState

Estado da Ligação de Ponto Final Privado.

Name Tipo Description
Creating

string

Deleted

string

Deleting

string

DeletingByProxy

string

Succeeded

string

Unknown

string

Updating

string

UpdatingByProxy

string

PrivateEndpointConnectionResource

Representa um recurso ARM de Ligação de Ponto Final Privado - um sub-recurso do espaço de nomes dos Hubs de Notificação.

Name Tipo Description
id

string

ID de recurso completamente qualificado para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name

string

O nome do recurso
properties

PrivateEndpointConnectionProperties

Propriedades da Ligação de Ponto Final Privado.
systemData

systemData

O Azure Resource Manager metadados que contêm createdBy e modifiedBy information.
type

string

O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

PrivateLinkConnectionStatus

Estado da Ligação Private Link.

Name Tipo Description
Approved

string

Disconnected

string

Pending

string

Rejected

string

PublicInternetAuthorizationRule

Uma regra de autorização de rede predefinida (Internet pública), que contém direitos se nenhuma outra regra de rede corresponder.

Name Tipo Description
rights

AccessRights[]

Lista de direitos de acesso.

PublicNetworkAccess

Tipo de acesso à rede pública.

Name Tipo Description
Disabled

string

Enabled

string

RemotePrivateEndpointConnection

Representa um Ponto Final Privado que está ligado ao espaço de nomes dos Hubs de Notificação através da Ligação de Ponto Final Privado.

Name Tipo Description
id

string

ID do recurso arm do Ponto Final Privado. Isto pode pertencer a uma subscrição e grupo de recursos diferente de um espaço de nomes dos Hubs de Notificação.

RemotePrivateLinkServiceConnectionState

Estado da ligação do Serviço Private Link.

Name Tipo Description
actionsRequired

string

Descrição amigável das ações necessárias.
description

string

Descrição amigável para humanos.
status

PrivateLinkConnectionStatus

Estado da Ligação Private Link.

ReplicationRegion

Região de replicação permitida

Name Tipo Description
AustraliaEast

string

BrazilSouth

string

Default

string

None

string

NorthEurope

string

SouthAfricaNorth

string

SouthEastAsia

string

WestUs2

string

Sku

A descrição do SKU para um espaço de nomes

Name Tipo Description
capacity

integer

Obtém ou define a capacidade do recurso
family

string

Obtém ou define a Família de SKU
name

SkuName

Nome do SKU do espaço de nomes.
size

string

Obtém ou define o tamanho do SKU
tier

string

Obtém ou define a camada de um SKU específico

SkuName

Nome do SKU do espaço de nomes.

Name Tipo Description
Basic

string

Free

string

Standard

string

systemData

Metadados relativos à criação e última modificação do recurso.

Name Tipo Description
createdAt

string

O carimbo de data/hora da criação de recursos (UTC).
createdBy

string

A identidade que criou o recurso.
createdByType

createdByType

O tipo de identidade que criou o recurso.
lastModifiedAt

string

O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy

string

A identidade que modificou o recurso pela última vez.
lastModifiedByType

createdByType

O tipo de identidade que modificou o recurso pela última vez.

WnsCredential

Descrição de um NotificationHub WnsCredential.

Name Tipo Description
properties

WnsCredentialProperties

Descrição de um NotificationHub WnsCredential.

WnsCredentialProperties

Descrição de um NotificationHub WnsCredential.

Name Tipo Description
certificateKey

string

Ges ou define a Chave de Certificado WNS.
packageSid

string

Obtém ou define o ID do pacote para esta credencial.
secretKey

string

Obtém ou define a chave secreta.
windowsLiveEndpoint

string

Obtém ou define o ponto final do Windows Live.
wnsCertificate

string

Obtém ou define o Certificado WNS.

XiaomiCredential

Descrição de um NotificationHub XiaomiCredential.

Name Tipo Description
properties

XiaomiCredentialProperties

Descrição de um NotificationHub XiaomiCredentialProperties.

XiaomiCredentialProperties

Descrição de um NotificationHub XiaomiCredentialProperties.

Name Tipo Description
appSecret

string

Obtém ou define o segredo da aplicação.
endpoint

string

Obtém ou define o ponto final de serviço da Xiaomi.

ZoneRedundancyPreference

Nome do SKU do espaço de nomes.

Name Tipo Description
Disabled

string

Enabled

string