Partilhar via


Namespaces Microsoft.NotificationHubs

Definição de recursos do bíceps

O tipo de recurso namespaces pode ser implantado com operações que visam:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.NotificationHubs/namespaces, adicione o seguinte Bicep ao seu modelo.

resource symbolicname 'Microsoft.NotificationHubs/namespaces@2023-10-01-preview' = {
  location: 'string'
  name: 'string'
  properties: {
    dataCenter: 'string'
    namespaceType: 'string'
    networkAcls: {
      ipRules: [
        {
          ipMask: 'string'
          rights: [
            'string'
          ]
        }
      ]
      publicNetworkRule: {
        rights: [
          'string'
        ]
      }
    }
    pnsCredentials: {
      admCredential: {
        properties: {
          authTokenUrl: 'string'
          clientId: 'string'
          clientSecret: 'string'
        }
      }
      apnsCredential: {
        properties: {
          apnsCertificate: 'string'
          appId: 'string'
          appName: 'string'
          certificateKey: 'string'
          endpoint: 'string'
          keyId: 'string'
          thumbprint: 'string'
          token: 'string'
        }
      }
      baiduCredential: {
        properties: {
          baiduApiKey: 'string'
          baiduEndPoint: 'string'
          baiduSecretKey: 'string'
        }
      }
      browserCredential: {
        properties: {
          subject: 'string'
          vapidPrivateKey: 'string'
          vapidPublicKey: 'string'
        }
      }
      fcmV1Credential: {
        properties: {
          clientEmail: 'string'
          privateKey: 'string'
          projectId: 'string'
        }
      }
      gcmCredential: {
        properties: {
          gcmEndpoint: 'string'
          googleApiKey: 'string'
        }
      }
      mpnsCredential: {
        properties: {
          certificateKey: 'string'
          mpnsCertificate: 'string'
          thumbprint: 'string'
        }
      }
      wnsCredential: {
        properties: {
          certificateKey: 'string'
          packageSid: 'string'
          secretKey: 'string'
          windowsLiveEndpoint: 'string'
          wnsCertificate: 'string'
        }
      }
      xiaomiCredential: {
        properties: {
          appSecret: 'string'
          endpoint: 'string'
        }
      }
    }
    provisioningState: 'string'
    publicNetworkAccess: 'string'
    replicationRegion: 'string'
    scaleUnit: 'string'
    status: 'string'
    zoneRedundancy: 'string'
  }
  sku: {
    capacity: int
    family: 'string'
    name: 'string'
    size: 'string'
    tier: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Valores de propriedade

AdmCredential

Designação Descrição Valor
propriedades Descrição de um AdmCredential do NotificationHub. AdmCredentialProperties (obrigatório)

AdmCredentialProperties

Designação Descrição Valor
authTokenUrl Obtém ou define a URL do token de autorização. string

Restrições:
Comprimento mínimo = 1
Valor sensível. Passe como um parâmetro seguro. (obrigatório)
ID do cliente Obtém ou define o identificador do cliente. string

Restrições:
Comprimento mínimo = 1
Valor sensível. Passe como um parâmetro seguro. (obrigatório)
clientSecret Obtém ou define a chave de acesso secreta da credencial. string

Restrições:
Comprimento mínimo = 1
Valor sensível. Passe como um parâmetro seguro. (obrigatório)

ApnsCredential

Designação Descrição Valor
propriedades Descrição de um NotificationHub ApnsCredential. ApnsCredentialProperties (obrigatório)

ApnsCredentialProperties

Designação Descrição Valor
apnsCertificate Obtém ou define o certificado APNS. string

Restrições:
Valor sensível. Passe como um parâmetro seguro.
appId Obtém ou define a chave de declaração registrada do emissor (iss), cujo valor é
o seu ID de Equipa de 10 caracteres, obtido a partir da sua conta de programador
string

Restrições:
Valor sensível. Passe como um parâmetro seguro.
nome_do_aplicativo Obtém ou define o nome do aplicativo string

Restrições:
Valor sensível. Passe como um parâmetro seguro.
certificateKey Obtém ou define a chave do certificado. string

Restrições:
Valor sensível. Passe como um parâmetro seguro.
Ponto final Obtém ou define o ponto de extremidade dessa credencial. string

Restrições:
Comprimento mínimo = 1
Valor sensível. Passe como um parâmetro seguro. (obrigatório)
keyId Obtém ou define uma chave de identificador de chave (kid) de 10 caracteres, obtida de
A sua conta de programador
string

Restrições:
Valor sensível. Passe como um parâmetro seguro.
impressão digital Obtém ou define a impressão digital do certificado APNS string

Restrições:
Valor sensível. Passe como um parâmetro seguro.
ficha Obtém ou define o Token de Autenticação do provedor, obtido através do seu
Conta de desenvolvedor
string

Restrições:
Valor sensível. Passe como um parâmetro seguro.

BaiduCredential

Designação Descrição Valor
propriedades Descrição de um NotificationHub BaiduCredential. BaiduCredentialProperties (obrigatório)

BaiduCredentialProperties

Designação Descrição Valor
baiduApiKey Obtém ou define baidu Api Key. string

Restrições:
Comprimento mínimo = 1
Valor sensível. Passe como um parâmetro seguro. (obrigatório)
baiduEndPoint Obtém ou define baidu Endpoint. string

Restrições:
Comprimento mínimo = 1
Valor sensível. Passe como um parâmetro seguro. (obrigatório)
baiduSecretKey Obtém ou define baidu Secret Key string

Restrições:
Comprimento mínimo = 1
Valor sensível. Passe como um parâmetro seguro. (obrigatório)

BrowserCredential

Designação Descrição Valor
propriedades Descrição de um NotificationHub BrowserCredential. BrowserCredentialProperties (obrigatório)

BrowserCredentialProperties

Designação Descrição Valor
Assunto Obtém ou define o assunto web push. string

Restrições:
Comprimento mínimo = 1
Valor sensível. Passe como um parâmetro seguro. (obrigatório)
vapidPrivateKey Obtém ou define a chave privada VAVID. string

Restrições:
Comprimento mínimo = 1
Valor sensível. Passe como um parâmetro seguro. (obrigatório)
vapidPublicKey Obtém ou define a chave pública VAPID. string

Restrições:
Comprimento mínimo = 1
Valor sensível. Passe como um parâmetro seguro. (obrigatório)

Credencial FcmV1

Designação Descrição Valor
propriedades Descrição de um NotificationHub FcmV1Credential. FcmV1CredentialProperties (obrigatório)

FcmV1CredentialProperties

Designação Descrição Valor
e-mail do cliente Obtém ou define o e-mail do cliente. string

Restrições:
Comprimento mínimo = 1
Valor sensível. Passe como um parâmetro seguro. (obrigatório)
chave privada Obtém ou define a chave privada. string

Restrições:
Comprimento mínimo = 1
Valor sensível. Passe como um parâmetro seguro. (obrigatório)
projectId Obtém ou define a ID do projeto. string

Restrições:
Comprimento mínimo = 1
Valor sensível. Passe como um parâmetro seguro. (obrigatório)

GcmCredencial

Designação Descrição Valor
propriedades Descrição de um NotificationHub GcmCredential. GcmCredentialProperties (obrigatório)

GcmCredentialProperties

Designação Descrição Valor
gcmPonto final Obtém ou define o ponto de extremidade GCM. string

Restrições:
Valor sensível. Passe como um parâmetro seguro.
googleApiKey Obtém ou define a chave da API do Google. string

Restrições:
Comprimento mínimo = 1
Valor sensível. Passe como um parâmetro seguro. (obrigatório)

IpRule

Designação Descrição Valor
ipMask Máscara de IP. string

Restrições:
Comprimento mínimo = 1 (obrigatório)
Direitos Lista de direitos de acesso. Matriz de cadeia de caracteres contendo qualquer uma das:
'Ouvir'
'Gerenciar'
'Enviar' (obrigatório)

Microsoft.NotificationHubs/namespaces

Designação Descrição Valor
Localização A geolocalização onde o recurso vive string (obrigatório)
Designação O nome do recurso string

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1
Padrão = ^[a-zA-Z][a-zA-Z0-9-]*$ (obrigatório)
propriedades Representa as propriedades do namespace. NamespaceProperties
SKU A descrição da Sku para um namespace Sku (obrigatório)
Etiquetas Tags de recursos Dicionário de nomes e valores de tags. Consulte Tags em modelos

MpnsCredential

Designação Descrição Valor
propriedades Descrição de um NotificationHub MpnsCredential. MpnsCredentialProperties (obrigatório)

MpnsCredentialProperties

Designação Descrição Valor
certificateKey Obtém ou define a chave de certificado para essa credencial. string

Restrições:
Comprimento mínimo = 1
Valor sensível. Passe como um parâmetro seguro. (obrigatório)
mpnsCertificate Obtém ou define o certificado MPNS. string

Restrições:
Comprimento mínimo = 1
Valor sensível. Passe como um parâmetro seguro. (obrigatório)
impressão digital Obtém ou define a impressão digital do certificado MPNS string

Restrições:
Comprimento mínimo = 1
Valor sensível. Passe como um parâmetro seguro. (obrigatório)

NamespacePropriedades

Designação Descrição Valor
Centro de dados Preterido. string
Tipo de namespace Define valores para NamespaceType. 'Mensagens'
'NotificationHub'
networkAcls Uma coleção de regras de autorização de rede. NetworkAcls
pnsCredenciais Coleção de credenciais PNS do Hub de Notificação ou do Namespace do Hub de Notificação. PnsCredentials
provisionamentoEstado Define valores para OperationProvisioningState. 'Cancelado'
'Desativado'
'Falhou'
'Em andamento'
'Pendente'
'Conseguiu'
'Desconhecido'
publicNetworkAccess Tipo de acesso à rede pública. 'Desativado'
'Habilitado'
replicaçãoRegião Região de replicação permitida 'AustráliaLeste'
'BrasilSul'
'Inadimplência'
'Nenhuma'
"Norte da Europa"
"África do SulNorte"
'Sudeste Asiático'
'WestUs2'
ScaleUnit Obtém ou define scaleUnit onde o namespace é criado string
Situação Status do namespace. 'Criado'
'Criar'
'Eliminação'
'Suspenso'
zonaRedundância Nome da SKU do namespace. 'Desativado'
'Habilitado'

NetworkAcls

Designação Descrição Valor
ipRegras Lista de regras de PI. IpRule[]
publicNetworkRule Uma regra de autorização de rede padrão (Internet pública), que contém direitos se nenhuma outra regra de rede corresponder. PublicInternetAuthorizationRule

PnsCredentials

Designação Descrição Valor
admCredencial Descrição de um AdmCredential do NotificationHub. AdmCredential
apnsCredential Descrição de um NotificationHub ApnsCredential. ApnsCredential
baiduCredencial Descrição de um NotificationHub BaiduCredential. BaiduCredential
browserCredential Descrição de um NotificationHub BrowserCredential. BrowserCredential
fcmV1Credencial Descrição de um NotificationHub FcmV1Credential. FcmV1Credential
gcmCredencial Descrição de um NotificationHub GcmCredential. GcmCredential
mpnsCredential Descrição de um NotificationHub MpnsCredential. MpnsCredential
wnsCredential Descrição de um NotificationHub WnsCredential. WnsCredential
xiaomiCredencial Descrição de um NotificationHub XiaomiCredential. XiaomiCredential

PublicInternetAuthorizationRule

Designação Descrição Valor
Direitos Lista de direitos de acesso. Matriz de cadeia de caracteres contendo qualquer uma das:
'Ouvir'
'Gerenciar'
'Enviar' (obrigatório)

Referência

Designação Descrição Valor
capacidade Obtém ou define a capacidade do recurso Int
Família Obtém ou define a Família Sku string
Designação Nome da SKU do namespace. 'Básico'
'Grátis'
'Standard' (obrigatório)
tamanho Obtém ou define o tamanho da Sku string
nível Obtém ou define a camada de sku específico string

TrackedResourceTags

Designação Descrição Valor

WnsCredential

Designação Descrição Valor
propriedades Descrição de um NotificationHub WnsCredential. WnsCredentialProperties (obrigatório)

WnsCredentialProperties

Designação Descrição Valor
certificateKey Ges ou define a chave de certificado WNS. string

Restrições:
Valor sensível. Passe como um parâmetro seguro.
pacoteSid Obtém ou define a ID do pacote para essa credencial. string

Restrições:
Valor sensível. Passe como um parâmetro seguro.
chave secreta Obtém ou define a chave secreta. string

Restrições:
Valor sensível. Passe como um parâmetro seguro.
windowsLiveEndpoint Obtém ou define o ponto de extremidade do Windows Live. string

Restrições:
Valor sensível. Passe como um parâmetro seguro.
wnsCertificado Obtém ou define o Certificado WNS. string

Restrições:
Valor sensível. Passe como um parâmetro seguro.

Credencial Xiaomi

Designação Descrição Valor
propriedades Descrição de um NotificationHub XiaomiCredentialProperties. XiaomiCredentialProperties (obrigatório)

XiaomiCredentialProperties

Designação Descrição Valor
appSecret Obtém ou define o segredo do aplicativo. string

Restrições:
Valor sensível. Passe como um parâmetro seguro.
Ponto final Obtém ou define o ponto de extremidade do serviço xiaomi. string

Restrições:
Valor sensível. Passe como um parâmetro seguro.

Exemplos de início rápido

Os exemplos de início rápido a seguir implantam esse tipo de recurso.

Arquivo Bicep Descrição
Criar do Hub de Notificação do Azure Cria um Hub de Notificação do Azure, Modelo originalmente criado por John Downs.

Definição de recurso de modelo ARM

O tipo de recurso namespaces pode ser implantado com operações que visam:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.NotificationHubs/namespaces, adicione o seguinte JSON ao seu modelo.

{
  "type": "Microsoft.NotificationHubs/namespaces",
  "apiVersion": "2023-10-01-preview",
  "name": "string",
  "location": "string",
  "properties": {
    "dataCenter": "string",
    "namespaceType": "string",
    "networkAcls": {
      "ipRules": [
        {
          "ipMask": "string",
          "rights": [ "string" ]
        }
      ],
      "publicNetworkRule": {
        "rights": [ "string" ]
      }
    },
    "pnsCredentials": {
      "admCredential": {
        "properties": {
          "authTokenUrl": "string",
          "clientId": "string",
          "clientSecret": "string"
        }
      },
      "apnsCredential": {
        "properties": {
          "apnsCertificate": "string",
          "appId": "string",
          "appName": "string",
          "certificateKey": "string",
          "endpoint": "string",
          "keyId": "string",
          "thumbprint": "string",
          "token": "string"
        }
      },
      "baiduCredential": {
        "properties": {
          "baiduApiKey": "string",
          "baiduEndPoint": "string",
          "baiduSecretKey": "string"
        }
      },
      "browserCredential": {
        "properties": {
          "subject": "string",
          "vapidPrivateKey": "string",
          "vapidPublicKey": "string"
        }
      },
      "fcmV1Credential": {
        "properties": {
          "clientEmail": "string",
          "privateKey": "string",
          "projectId": "string"
        }
      },
      "gcmCredential": {
        "properties": {
          "gcmEndpoint": "string",
          "googleApiKey": "string"
        }
      },
      "mpnsCredential": {
        "properties": {
          "certificateKey": "string",
          "mpnsCertificate": "string",
          "thumbprint": "string"
        }
      },
      "wnsCredential": {
        "properties": {
          "certificateKey": "string",
          "packageSid": "string",
          "secretKey": "string",
          "windowsLiveEndpoint": "string",
          "wnsCertificate": "string"
        }
      },
      "xiaomiCredential": {
        "properties": {
          "appSecret": "string",
          "endpoint": "string"
        }
      }
    },
    "provisioningState": "string",
    "publicNetworkAccess": "string",
    "replicationRegion": "string",
    "scaleUnit": "string",
    "status": "string",
    "zoneRedundancy": "string"
  },
  "sku": {
    "capacity": "int",
    "family": "string",
    "name": "string",
    "size": "string",
    "tier": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valores de propriedade

AdmCredential

Designação Descrição Valor
propriedades Descrição de um AdmCredential do NotificationHub. AdmCredentialProperties (obrigatório)

AdmCredentialProperties

Designação Descrição Valor
authTokenUrl Obtém ou define a URL do token de autorização. string

Restrições:
Comprimento mínimo = 1
Valor sensível. Passe como um parâmetro seguro. (obrigatório)
ID do cliente Obtém ou define o identificador do cliente. string

Restrições:
Comprimento mínimo = 1
Valor sensível. Passe como um parâmetro seguro. (obrigatório)
clientSecret Obtém ou define a chave de acesso secreta da credencial. string

Restrições:
Comprimento mínimo = 1
Valor sensível. Passe como um parâmetro seguro. (obrigatório)

ApnsCredential

Designação Descrição Valor
propriedades Descrição de um NotificationHub ApnsCredential. ApnsCredentialProperties (obrigatório)

ApnsCredentialProperties

Designação Descrição Valor
apnsCertificate Obtém ou define o certificado APNS. string

Restrições:
Valor sensível. Passe como um parâmetro seguro.
appId Obtém ou define a chave de declaração registrada do emissor (iss), cujo valor é
o seu ID de Equipa de 10 caracteres, obtido a partir da sua conta de programador
string

Restrições:
Valor sensível. Passe como um parâmetro seguro.
nome_do_aplicativo Obtém ou define o nome do aplicativo string

Restrições:
Valor sensível. Passe como um parâmetro seguro.
certificateKey Obtém ou define a chave do certificado. string

Restrições:
Valor sensível. Passe como um parâmetro seguro.
Ponto final Obtém ou define o ponto de extremidade dessa credencial. string

Restrições:
Comprimento mínimo = 1
Valor sensível. Passe como um parâmetro seguro. (obrigatório)
keyId Obtém ou define uma chave de identificador de chave (kid) de 10 caracteres, obtida de
A sua conta de programador
string

Restrições:
Valor sensível. Passe como um parâmetro seguro.
impressão digital Obtém ou define a impressão digital do certificado APNS string

Restrições:
Valor sensível. Passe como um parâmetro seguro.
ficha Obtém ou define o Token de Autenticação do provedor, obtido através do seu
Conta de desenvolvedor
string

Restrições:
Valor sensível. Passe como um parâmetro seguro.

BaiduCredential

Designação Descrição Valor
propriedades Descrição de um NotificationHub BaiduCredential. BaiduCredentialProperties (obrigatório)

BaiduCredentialProperties

Designação Descrição Valor
baiduApiKey Obtém ou define baidu Api Key. string

Restrições:
Comprimento mínimo = 1
Valor sensível. Passe como um parâmetro seguro. (obrigatório)
baiduEndPoint Obtém ou define baidu Endpoint. string

Restrições:
Comprimento mínimo = 1
Valor sensível. Passe como um parâmetro seguro. (obrigatório)
baiduSecretKey Obtém ou define baidu Secret Key string

Restrições:
Comprimento mínimo = 1
Valor sensível. Passe como um parâmetro seguro. (obrigatório)

BrowserCredential

Designação Descrição Valor
propriedades Descrição de um NotificationHub BrowserCredential. BrowserCredentialProperties (obrigatório)

BrowserCredentialProperties

Designação Descrição Valor
Assunto Obtém ou define o assunto web push. string

Restrições:
Comprimento mínimo = 1
Valor sensível. Passe como um parâmetro seguro. (obrigatório)
vapidPrivateKey Obtém ou define a chave privada VAVID. string

Restrições:
Comprimento mínimo = 1
Valor sensível. Passe como um parâmetro seguro. (obrigatório)
vapidPublicKey Obtém ou define a chave pública VAPID. string

Restrições:
Comprimento mínimo = 1
Valor sensível. Passe como um parâmetro seguro. (obrigatório)

Credencial FcmV1

Designação Descrição Valor
propriedades Descrição de um NotificationHub FcmV1Credential. FcmV1CredentialProperties (obrigatório)

FcmV1CredentialProperties

Designação Descrição Valor
e-mail do cliente Obtém ou define o e-mail do cliente. string

Restrições:
Comprimento mínimo = 1
Valor sensível. Passe como um parâmetro seguro. (obrigatório)
chave privada Obtém ou define a chave privada. string

Restrições:
Comprimento mínimo = 1
Valor sensível. Passe como um parâmetro seguro. (obrigatório)
projectId Obtém ou define a ID do projeto. string

Restrições:
Comprimento mínimo = 1
Valor sensível. Passe como um parâmetro seguro. (obrigatório)

GcmCredencial

Designação Descrição Valor
propriedades Descrição de um NotificationHub GcmCredential. GcmCredentialProperties (obrigatório)

GcmCredentialProperties

Designação Descrição Valor
gcmPonto final Obtém ou define o ponto de extremidade GCM. string

Restrições:
Valor sensível. Passe como um parâmetro seguro.
googleApiKey Obtém ou define a chave da API do Google. string

Restrições:
Comprimento mínimo = 1
Valor sensível. Passe como um parâmetro seguro. (obrigatório)

IpRule

Designação Descrição Valor
ipMask Máscara de IP. string

Restrições:
Comprimento mínimo = 1 (obrigatório)
Direitos Lista de direitos de acesso. Matriz de cadeia de caracteres contendo qualquer uma das:
'Ouvir'
'Gerenciar'
'Enviar' (obrigatório)

Microsoft.NotificationHubs/namespaces

Designação Descrição Valor
apiVersion A versão api '2023-10-01-pré-visualização'
Localização A geolocalização onde o recurso vive string (obrigatório)
Designação O nome do recurso string

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1
Padrão = ^[a-zA-Z][a-zA-Z0-9-]*$ (obrigatório)
propriedades Representa as propriedades do namespace. NamespaceProperties
SKU A descrição da Sku para um namespace Sku (obrigatório)
Etiquetas Tags de recursos Dicionário de nomes e valores de tags. Consulte Tags em modelos
tipo O tipo de recurso 'Microsoft.NotificationHubs/namespaces'

MpnsCredential

Designação Descrição Valor
propriedades Descrição de um NotificationHub MpnsCredential. MpnsCredentialProperties (obrigatório)

MpnsCredentialProperties

Designação Descrição Valor
certificateKey Obtém ou define a chave de certificado para essa credencial. string

Restrições:
Comprimento mínimo = 1
Valor sensível. Passe como um parâmetro seguro. (obrigatório)
mpnsCertificate Obtém ou define o certificado MPNS. string

Restrições:
Comprimento mínimo = 1
Valor sensível. Passe como um parâmetro seguro. (obrigatório)
impressão digital Obtém ou define a impressão digital do certificado MPNS string

Restrições:
Comprimento mínimo = 1
Valor sensível. Passe como um parâmetro seguro. (obrigatório)

NamespacePropriedades

Designação Descrição Valor
Centro de dados Preterido. string
Tipo de namespace Define valores para NamespaceType. 'Mensagens'
'NotificationHub'
networkAcls Uma coleção de regras de autorização de rede. NetworkAcls
pnsCredenciais Coleção de credenciais PNS do Hub de Notificação ou do Namespace do Hub de Notificação. PnsCredentials
provisionamentoEstado Define valores para OperationProvisioningState. 'Cancelado'
'Desativado'
'Falhou'
'Em andamento'
'Pendente'
'Conseguiu'
'Desconhecido'
publicNetworkAccess Tipo de acesso à rede pública. 'Desativado'
'Habilitado'
replicaçãoRegião Região de replicação permitida 'AustráliaLeste'
'BrasilSul'
'Inadimplência'
'Nenhuma'
"Norte da Europa"
"África do SulNorte"
'Sudeste Asiático'
'WestUs2'
ScaleUnit Obtém ou define scaleUnit onde o namespace é criado string
Situação Status do namespace. 'Criado'
'Criar'
'Eliminação'
'Suspenso'
zonaRedundância Nome da SKU do namespace. 'Desativado'
'Habilitado'

NetworkAcls

Designação Descrição Valor
ipRegras Lista de regras de PI. IpRule[]
publicNetworkRule Uma regra de autorização de rede padrão (Internet pública), que contém direitos se nenhuma outra regra de rede corresponder. PublicInternetAuthorizationRule

PnsCredentials

Designação Descrição Valor
admCredencial Descrição de um AdmCredential do NotificationHub. AdmCredential
apnsCredential Descrição de um NotificationHub ApnsCredential. ApnsCredential
baiduCredencial Descrição de um NotificationHub BaiduCredential. BaiduCredential
browserCredential Descrição de um NotificationHub BrowserCredential. BrowserCredential
fcmV1Credencial Descrição de um NotificationHub FcmV1Credential. FcmV1Credential
gcmCredencial Descrição de um NotificationHub GcmCredential. GcmCredential
mpnsCredential Descrição de um NotificationHub MpnsCredential. MpnsCredential
wnsCredential Descrição de um NotificationHub WnsCredential. WnsCredential
xiaomiCredencial Descrição de um NotificationHub XiaomiCredential. XiaomiCredential

PublicInternetAuthorizationRule

Designação Descrição Valor
Direitos Lista de direitos de acesso. Matriz de cadeia de caracteres contendo qualquer uma das:
'Ouvir'
'Gerenciar'
'Enviar' (obrigatório)

Referência

Designação Descrição Valor
capacidade Obtém ou define a capacidade do recurso Int
Família Obtém ou define a Família Sku string
Designação Nome da SKU do namespace. 'Básico'
'Grátis'
'Standard' (obrigatório)
tamanho Obtém ou define o tamanho da Sku string
nível Obtém ou define a camada de sku específico string

TrackedResourceTags

Designação Descrição Valor

WnsCredential

Designação Descrição Valor
propriedades Descrição de um NotificationHub WnsCredential. WnsCredentialProperties (obrigatório)

WnsCredentialProperties

Designação Descrição Valor
certificateKey Ges ou define a chave de certificado WNS. string

Restrições:
Valor sensível. Passe como um parâmetro seguro.
pacoteSid Obtém ou define a ID do pacote para essa credencial. string

Restrições:
Valor sensível. Passe como um parâmetro seguro.
chave secreta Obtém ou define a chave secreta. string

Restrições:
Valor sensível. Passe como um parâmetro seguro.
windowsLiveEndpoint Obtém ou define o ponto de extremidade do Windows Live. string

Restrições:
Valor sensível. Passe como um parâmetro seguro.
wnsCertificado Obtém ou define o Certificado WNS. string

Restrições:
Valor sensível. Passe como um parâmetro seguro.

Credencial Xiaomi

Designação Descrição Valor
propriedades Descrição de um NotificationHub XiaomiCredentialProperties. XiaomiCredentialProperties (obrigatório)

XiaomiCredentialProperties

Designação Descrição Valor
appSecret Obtém ou define o segredo do aplicativo. string

Restrições:
Valor sensível. Passe como um parâmetro seguro.
Ponto final Obtém ou define o ponto de extremidade do serviço xiaomi. string

Restrições:
Valor sensível. Passe como um parâmetro seguro.

Modelos de início rápido

Os modelos de início rápido a seguir implantam esse tipo de recurso.

Modelo Descrição
Criar do Hub de Notificação do Azure

Implantar no Azure
Cria um Hub de Notificação do Azure, Modelo originalmente criado por John Downs.
provisionar um aplicativo móvel com um banco de dados SQL

Implantar no Azure
Este modelo provisiona um Aplicativo Móvel, Banco de Dados SQL e Hub de Notificação. Ele configura uma cadeia de conexão no aplicativo móvel para o banco de dados e o hub de notificação.

Definição de recursos Terraform (provedor AzAPI)

O tipo de recurso namespaces pode ser implantado com operações que visam:

  • Grupos de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.NotificationHubs/namespaces, adicione o seguinte Terraform ao seu modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.NotificationHubs/namespaces@2023-10-01-preview"
  name = "string"
  location = "string"
  sku = {
    capacity = int
    family = "string"
    name = "string"
    size = "string"
    tier = "string"
  }
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      dataCenter = "string"
      namespaceType = "string"
      networkAcls = {
        ipRules = [
          {
            ipMask = "string"
            rights = [
              "string"
            ]
          }
        ]
        publicNetworkRule = {
          rights = [
            "string"
          ]
        }
      }
      pnsCredentials = {
        admCredential = {
          properties = {
            authTokenUrl = "string"
            clientId = "string"
            clientSecret = "string"
          }
        }
        apnsCredential = {
          properties = {
            apnsCertificate = "string"
            appId = "string"
            appName = "string"
            certificateKey = "string"
            endpoint = "string"
            keyId = "string"
            thumbprint = "string"
            token = "string"
          }
        }
        baiduCredential = {
          properties = {
            baiduApiKey = "string"
            baiduEndPoint = "string"
            baiduSecretKey = "string"
          }
        }
        browserCredential = {
          properties = {
            subject = "string"
            vapidPrivateKey = "string"
            vapidPublicKey = "string"
          }
        }
        fcmV1Credential = {
          properties = {
            clientEmail = "string"
            privateKey = "string"
            projectId = "string"
          }
        }
        gcmCredential = {
          properties = {
            gcmEndpoint = "string"
            googleApiKey = "string"
          }
        }
        mpnsCredential = {
          properties = {
            certificateKey = "string"
            mpnsCertificate = "string"
            thumbprint = "string"
          }
        }
        wnsCredential = {
          properties = {
            certificateKey = "string"
            packageSid = "string"
            secretKey = "string"
            windowsLiveEndpoint = "string"
            wnsCertificate = "string"
          }
        }
        xiaomiCredential = {
          properties = {
            appSecret = "string"
            endpoint = "string"
          }
        }
      }
      provisioningState = "string"
      publicNetworkAccess = "string"
      replicationRegion = "string"
      scaleUnit = "string"
      status = "string"
      zoneRedundancy = "string"
    }
  })
}

Valores de propriedade

AdmCredential

Designação Descrição Valor
propriedades Descrição de um AdmCredential do NotificationHub. AdmCredentialProperties (obrigatório)

AdmCredentialProperties

Designação Descrição Valor
authTokenUrl Obtém ou define a URL do token de autorização. string

Restrições:
Comprimento mínimo = 1
Valor sensível. Passe como um parâmetro seguro. (obrigatório)
ID do cliente Obtém ou define o identificador do cliente. string

Restrições:
Comprimento mínimo = 1
Valor sensível. Passe como um parâmetro seguro. (obrigatório)
clientSecret Obtém ou define a chave de acesso secreta da credencial. string

Restrições:
Comprimento mínimo = 1
Valor sensível. Passe como um parâmetro seguro. (obrigatório)

ApnsCredential

Designação Descrição Valor
propriedades Descrição de um NotificationHub ApnsCredential. ApnsCredentialProperties (obrigatório)

ApnsCredentialProperties

Designação Descrição Valor
apnsCertificate Obtém ou define o certificado APNS. string

Restrições:
Valor sensível. Passe como um parâmetro seguro.
appId Obtém ou define a chave de declaração registrada do emissor (iss), cujo valor é
o seu ID de Equipa de 10 caracteres, obtido a partir da sua conta de programador
string

Restrições:
Valor sensível. Passe como um parâmetro seguro.
nome_do_aplicativo Obtém ou define o nome do aplicativo string

Restrições:
Valor sensível. Passe como um parâmetro seguro.
certificateKey Obtém ou define a chave do certificado. string

Restrições:
Valor sensível. Passe como um parâmetro seguro.
Ponto final Obtém ou define o ponto de extremidade dessa credencial. string

Restrições:
Comprimento mínimo = 1
Valor sensível. Passe como um parâmetro seguro. (obrigatório)
keyId Obtém ou define uma chave de identificador de chave (kid) de 10 caracteres, obtida de
A sua conta de programador
string

Restrições:
Valor sensível. Passe como um parâmetro seguro.
impressão digital Obtém ou define a impressão digital do certificado APNS string

Restrições:
Valor sensível. Passe como um parâmetro seguro.
ficha Obtém ou define o Token de Autenticação do provedor, obtido através do seu
Conta de desenvolvedor
string

Restrições:
Valor sensível. Passe como um parâmetro seguro.

BaiduCredential

Designação Descrição Valor
propriedades Descrição de um NotificationHub BaiduCredential. BaiduCredentialProperties (obrigatório)

BaiduCredentialProperties

Designação Descrição Valor
baiduApiKey Obtém ou define baidu Api Key. string

Restrições:
Comprimento mínimo = 1
Valor sensível. Passe como um parâmetro seguro. (obrigatório)
baiduEndPoint Obtém ou define baidu Endpoint. string

Restrições:
Comprimento mínimo = 1
Valor sensível. Passe como um parâmetro seguro. (obrigatório)
baiduSecretKey Obtém ou define baidu Secret Key string

Restrições:
Comprimento mínimo = 1
Valor sensível. Passe como um parâmetro seguro. (obrigatório)

BrowserCredential

Designação Descrição Valor
propriedades Descrição de um NotificationHub BrowserCredential. BrowserCredentialProperties (obrigatório)

BrowserCredentialProperties

Designação Descrição Valor
Assunto Obtém ou define o assunto web push. string

Restrições:
Comprimento mínimo = 1
Valor sensível. Passe como um parâmetro seguro. (obrigatório)
vapidPrivateKey Obtém ou define a chave privada VAVID. string

Restrições:
Comprimento mínimo = 1
Valor sensível. Passe como um parâmetro seguro. (obrigatório)
vapidPublicKey Obtém ou define a chave pública VAPID. string

Restrições:
Comprimento mínimo = 1
Valor sensível. Passe como um parâmetro seguro. (obrigatório)

Credencial FcmV1

Designação Descrição Valor
propriedades Descrição de um NotificationHub FcmV1Credential. FcmV1CredentialProperties (obrigatório)

FcmV1CredentialProperties

Designação Descrição Valor
e-mail do cliente Obtém ou define o e-mail do cliente. string

Restrições:
Comprimento mínimo = 1
Valor sensível. Passe como um parâmetro seguro. (obrigatório)
chave privada Obtém ou define a chave privada. string

Restrições:
Comprimento mínimo = 1
Valor sensível. Passe como um parâmetro seguro. (obrigatório)
projectId Obtém ou define a ID do projeto. string

Restrições:
Comprimento mínimo = 1
Valor sensível. Passe como um parâmetro seguro. (obrigatório)

GcmCredencial

Designação Descrição Valor
propriedades Descrição de um NotificationHub GcmCredential. GcmCredentialProperties (obrigatório)

GcmCredentialProperties

Designação Descrição Valor
gcmPonto final Obtém ou define o ponto de extremidade GCM. string

Restrições:
Valor sensível. Passe como um parâmetro seguro.
googleApiKey Obtém ou define a chave da API do Google. string

Restrições:
Comprimento mínimo = 1
Valor sensível. Passe como um parâmetro seguro. (obrigatório)

IpRule

Designação Descrição Valor
ipMask Máscara de IP. string

Restrições:
Comprimento mínimo = 1 (obrigatório)
Direitos Lista de direitos de acesso. Matriz de cadeia de caracteres contendo qualquer uma das:
'Ouvir'
'Gerenciar'
'Enviar' (obrigatório)

Microsoft.NotificationHubs/namespaces

Designação Descrição Valor
Localização A geolocalização onde o recurso vive string (obrigatório)
Designação O nome do recurso string

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1
Padrão = ^[a-zA-Z][a-zA-Z0-9-]*$ (obrigatório)
propriedades Representa as propriedades do namespace. NamespaceProperties
SKU A descrição da Sku para um namespace Sku (obrigatório)
Etiquetas Tags de recursos Dicionário de nomes e valores de tags.
tipo O tipo de recurso "Microsoft.NotificationHubs/namespaces@2023-10-01-pré-visualização"

MpnsCredential

Designação Descrição Valor
propriedades Descrição de um NotificationHub MpnsCredential. MpnsCredentialProperties (obrigatório)

MpnsCredentialProperties

Designação Descrição Valor
certificateKey Obtém ou define a chave de certificado para essa credencial. string

Restrições:
Comprimento mínimo = 1
Valor sensível. Passe como um parâmetro seguro. (obrigatório)
mpnsCertificate Obtém ou define o certificado MPNS. string

Restrições:
Comprimento mínimo = 1
Valor sensível. Passe como um parâmetro seguro. (obrigatório)
impressão digital Obtém ou define a impressão digital do certificado MPNS string

Restrições:
Comprimento mínimo = 1
Valor sensível. Passe como um parâmetro seguro. (obrigatório)

NamespacePropriedades

Designação Descrição Valor
Centro de dados Preterido. string
Tipo de namespace Define valores para NamespaceType. 'Mensagens'
'NotificationHub'
networkAcls Uma coleção de regras de autorização de rede. NetworkAcls
pnsCredenciais Coleção de credenciais PNS do Hub de Notificação ou do Namespace do Hub de Notificação. PnsCredentials
provisionamentoEstado Define valores para OperationProvisioningState. 'Cancelado'
'Desativado'
'Falhou'
'Em andamento'
'Pendente'
'Conseguiu'
'Desconhecido'
publicNetworkAccess Tipo de acesso à rede pública. 'Desativado'
'Habilitado'
replicaçãoRegião Região de replicação permitida 'AustráliaLeste'
'BrasilSul'
'Inadimplência'
'Nenhuma'
"Norte da Europa"
"África do SulNorte"
'Sudeste Asiático'
'WestUs2'
ScaleUnit Obtém ou define scaleUnit onde o namespace é criado string
Situação Status do namespace. 'Criado'
'Criar'
'Eliminação'
'Suspenso'
zonaRedundância Nome da SKU do namespace. 'Desativado'
'Habilitado'

NetworkAcls

Designação Descrição Valor
ipRegras Lista de regras de PI. IpRule[]
publicNetworkRule Uma regra de autorização de rede padrão (Internet pública), que contém direitos se nenhuma outra regra de rede corresponder. PublicInternetAuthorizationRule

PnsCredentials

Designação Descrição Valor
admCredencial Descrição de um AdmCredential do NotificationHub. AdmCredential
apnsCredential Descrição de um NotificationHub ApnsCredential. ApnsCredential
baiduCredencial Descrição de um NotificationHub BaiduCredential. BaiduCredential
browserCredential Descrição de um NotificationHub BrowserCredential. BrowserCredential
fcmV1Credencial Descrição de um NotificationHub FcmV1Credential. FcmV1Credential
gcmCredencial Descrição de um NotificationHub GcmCredential. GcmCredential
mpnsCredential Descrição de um NotificationHub MpnsCredential. MpnsCredential
wnsCredential Descrição de um NotificationHub WnsCredential. WnsCredential
xiaomiCredencial Descrição de um NotificationHub XiaomiCredential. XiaomiCredential

PublicInternetAuthorizationRule

Designação Descrição Valor
Direitos Lista de direitos de acesso. Matriz de cadeia de caracteres contendo qualquer uma das:
'Ouvir'
'Gerenciar'
'Enviar' (obrigatório)

Referência

Designação Descrição Valor
capacidade Obtém ou define a capacidade do recurso Int
Família Obtém ou define a Família Sku string
Designação Nome da SKU do namespace. 'Básico'
'Grátis'
'Standard' (obrigatório)
tamanho Obtém ou define o tamanho da Sku string
nível Obtém ou define a camada de sku específico string

TrackedResourceTags

Designação Descrição Valor

WnsCredential

Designação Descrição Valor
propriedades Descrição de um NotificationHub WnsCredential. WnsCredentialProperties (obrigatório)

WnsCredentialProperties

Designação Descrição Valor
certificateKey Ges ou define a chave de certificado WNS. string

Restrições:
Valor sensível. Passe como um parâmetro seguro.
pacoteSid Obtém ou define a ID do pacote para essa credencial. string

Restrições:
Valor sensível. Passe como um parâmetro seguro.
chave secreta Obtém ou define a chave secreta. string

Restrições:
Valor sensível. Passe como um parâmetro seguro.
windowsLiveEndpoint Obtém ou define o ponto de extremidade do Windows Live. string

Restrições:
Valor sensível. Passe como um parâmetro seguro.
wnsCertificado Obtém ou define o Certificado WNS. string

Restrições:
Valor sensível. Passe como um parâmetro seguro.

Credencial Xiaomi

Designação Descrição Valor
propriedades Descrição de um NotificationHub XiaomiCredentialProperties. XiaomiCredentialProperties (obrigatório)

XiaomiCredentialProperties

Designação Descrição Valor
appSecret Obtém ou define o segredo do aplicativo. string

Restrições:
Valor sensível. Passe como um parâmetro seguro.
Ponto final Obtém ou define o ponto de extremidade do serviço xiaomi. string

Restrições:
Valor sensível. Passe como um parâmetro seguro.