Compartilhar via


Namespaces do Microsoft.NotificationHubs

Definição de recurso do Bicep

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

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

Formato de recurso

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

resource symbolicname 'Microsoft.NotificationHubs/namespaces@2023-10-01-preview' = {
  scope: resourceSymbolicName or scope
  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

Microsoft.NotificationHubs/namespaces

Nome Descrição Valor
local A localização geográfica onde o recurso reside cadeia de caracteres (obrigatório)
nome O nome do recurso corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 50
Padrão = ^[a-zA-Z][a-zA-Z0-9-]*$ (obrigatório)
Propriedades Representa as propriedades do namespace. Propriedades do namespace
escopo Use ao criar um recurso em um escopo diferente do escopo de implantação. Defina essa propriedade como o nome simbólico de um recurso para aplicar o recurso de extensão .
Sku A descrição do Sku para um namespace de SKU (obrigatório)
Tags Marcas de recurso Dicionário de nomes e valores de marca. Consulte Marcas em modelos

AdmCredential

Nome Descrição Valor
Propriedades Descrição de um NotificationHub AdmCredential. AdmCredentialProperties (obrigatório)

AdmCredentialProperties

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

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

Restrições:
Comprimento mínimo = 1
Valor confidencial. Passe como um parâmetro seguro. (obrigatório)
segredo do cliente Obtém ou define a chave de acesso do segredo da credencial. corda

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

ApnsCredential

Nome Descrição Valor
Propriedades Descrição de um ApnsCredential do NotificationHub. apnsCredentialProperties (obrigatório)

ApnsCredentialProperties

Nome Descrição Valor
apnsCertificate Obtém ou define o certificado APNS. corda

Restrições:
Valor confidencial. Passe como um parâmetro seguro.
ID do aplicativo Obtém ou define a chave de declaração registrada do emissor (iss), cujo valor é
sua ID de equipe de 10 caracteres, obtida de sua conta de desenvolvedor
corda

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

Restrições:
Valor confidencial. Passe como um parâmetro seguro.
certificateKey Obtém ou define a chave de certificado. corda

Restrições:
Valor confidencial. Passe como um parâmetro seguro.
ponto de extremidade Obtém ou define o ponto de extremidade dessa credencial. corda

Restrições:
Comprimento mínimo = 1
Valor confidencial. Passe como um parâmetro seguro. (obrigatório)
ID da chave Obtém ou define uma chave de identificador de chave de 10 caracteres (kid), obtida de
sua conta de desenvolvedor
corda

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

Restrições:
Valor confidencial. Passe como um parâmetro seguro.
símbolo Obtém ou define o Token de Autenticação do provedor, obtido por meio do seu
conta do desenvolvedor
corda

Restrições:
Valor confidencial. Passe como um parâmetro seguro.

Credencial Baidu

Nome Descrição Valor
Propriedades Descrição de um BaiduCredential do NotificationHub. BaiduCredentialProperties (obrigatório)

BaiduCredentialProperties

Nome Descrição Valor
baiduApiKey Obtém ou define a Chave de API baidu. corda

Restrições:
Comprimento mínimo = 1
Valor confidencial. Passe como um parâmetro seguro. (obrigatório)
baiduEndPoint Obtém ou define o ponto de extremidade baidu. corda

Restrições:
Comprimento mínimo = 1
Valor confidencial. Passe como um parâmetro seguro. (obrigatório)
baiduSecretKey Obtém ou define a chave secreta baidu corda

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

Credencial do navegador

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

Propriedades do BrowserCredential

Nome Descrição Valor
Assunto Obtém ou define o assunto de push da Web. corda

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

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

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

Credencial FcmV1

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

FcmV1CredentialProperties

Nome Descrição Valor
clienteE-mail Obtém ou define o email do cliente. corda

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

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

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

GcmCredential

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

Propriedades GcmCredential

Nome Descrição Valor
gcmEndpoint Obtém ou define o ponto de extremidade GCM. corda

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

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

Regra de IP

Nome Descrição Valor
Máscara de ip Máscara de IP. corda

Restrições:
Comprimento mínimo = 1 (obrigatório)
direitos Lista de direitos de acesso. Matriz de cadeia de caracteres que contém qualquer um dos:
'Ouça'
'Gerenciar'
'Send' (obrigatório)

Credencial do Mpns

Nome Descrição Valor
Propriedades Descrição de um MpnsCredential do NotificationHub. MpnsCredentialProperties (obrigatório)

Propriedades de Credencial Mpns

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

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

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

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

Propriedades do namespace

Nome Descrição Valor
Centro de dados Deprecado. cadeia
tipo de namespace Define valores para NamespaceType. 'Mensagens'
'NotificationHub'
networkAcls Uma coleção de regras de autorização de rede. Redes Acls
pnsCredentials Coleção de credenciais PNS do Namespace do Hub de Notificação ou do Hub de Notificação. Credenciais de Pns
estado de provisionamento Define valores para OperationProvisioningState. 'Cancelado'
'Desabilitado'
'Falha'
'Em andamento'
'Pendente'
'Bem-sucedido'
'Desconhecido'
públicoAcessoRedeAcesso Tipo de acesso à rede pública. 'Desabilitado'
'Habilitado'
região de replicação Região de replicação permitida 'Leste da Austrália'
'BrasilSul'
'Padrão'
'Nenhum'
'Norte da Europa'
'África do SulNorte'
'Sudeste Asiático'
'WestUs2'
unidade de escala Obtém ou define scaleUnit em que o namespace é criado cadeia
status Status do namespace. 'Criado'
'Criando'
'Excluindo'
'Suspenso'
zoneRedundância Nome do SKU do namespace. 'Desabilitado'
'Habilitado'

Redes Acls

Nome Descrição Valor
ipRules Lista de regras de IP. Regra de Ip
Regra de Rede Pública Uma regra de autorização de rede padrão (Internet pública), que contém direitos se nenhuma outra regra de rede corresponder. PublicInternetAuthorizationRule

Credenciais de Pns

Nome Descrição Valor
admCredential Descrição de um NotificationHub AdmCredential. AdmCredential
apnsCredential Descrição de um ApnsCredential do NotificationHub. ApnsCredential
baiduCredencial Descrição de um BaiduCredential do NotificationHub. BaiduCredential
browserCredential Descrição de um NotificationHub BrowserCredential. BrowserCredential
fcmV1Credencial Descrição de um NotificationHub FcmV1Credential. fcmV1Credential
gcmCredential Descrição de um NotificationHub GcmCredential. GcmCredential
mpnsCredencial Descrição de um MpnsCredential do NotificationHub. do MpnsCredential
wnsCredencial Descrição de um WnsCredential do NotificationHub. WnsCredential
xiaomiCredencial Descrição de um XiaomiCredential do NotificationHub. XiaomiCredential

Regra de Autorização Pública

Nome Descrição Valor
direitos Lista de direitos de acesso. Matriz de cadeia de caracteres que contém qualquer um dos:
'Ouça'
'Gerenciar'
'Send' (obrigatório)

Sku

Nome Descrição Valor
capacidade Obtém ou define a capacidade do recurso int
família Obtém ou define a família Sku cadeia
nome Nome do SKU do namespace. 'Básico'
'Gratuito'
'Standard' (obrigatório)
tamanho Obtém ou define o tamanho do Sku cadeia
nível Obtém ou define a camada de sku específica cadeia

TrackedResourceTags

Nome Descrição Valor

WnsCredential

Nome Descrição Valor
Propriedades Descrição de um WnsCredential do NotificationHub. WnsCredentialProperties (obrigatório)

Propriedades WnsCredential

Nome Descrição Valor
certificateKey Ges ou define a Chave de Certificado WNS. corda

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

Restrições:
Valor confidencial. Passe como um parâmetro seguro.
Chave secreta Obtém ou define a chave secreta. corda

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

Restrições:
Valor confidencial. Passe como um parâmetro seguro.
wnsCertificado Obtém ou define o Certificado WNS. corda

Restrições:
Valor confidencial. Passe como um parâmetro seguro.

XiaomiCredencial

Nome Descrição Valor
Propriedades Descrição de um NotificationHub XiaomiCredentialProperties. XiaomiCredentialProperties (obrigatório)

XiaomiCredentialProperties

Nome Descrição Valor
appSecret Obtém ou define o segredo do aplicativo. corda

Restrições:
Valor confidencial. Passe como um parâmetro seguro.
ponto de extremidade Obtém ou define o ponto de extremidade de serviço da Xiaomi. corda

Restrições:
Valor confidencial. Passe como um parâmetro seguro.

Exemplos de uso

Exemplos de Início Rápido do Azure

Os modelos de Início Rápido do Azure a seguir contêm exemplos de Bicep para implantar 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 do ARM

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

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

Formato de recurso

Para criar um recurso Microsoft.NotificationHubs/namespaces, adicione o JSON a seguir ao 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

Microsoft.NotificationHubs/namespaces

Nome Descrição Valor
apiVersion A versão da API '2023-10-01-preview'
local A localização geográfica onde o recurso reside cadeia de caracteres (obrigatório)
nome O nome do recurso corda

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

AdmCredential

Nome Descrição Valor
Propriedades Descrição de um NotificationHub AdmCredential. AdmCredentialProperties (obrigatório)

AdmCredentialProperties

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

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

Restrições:
Comprimento mínimo = 1
Valor confidencial. Passe como um parâmetro seguro. (obrigatório)
segredo do cliente Obtém ou define a chave de acesso do segredo da credencial. corda

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

ApnsCredential

Nome Descrição Valor
Propriedades Descrição de um ApnsCredential do NotificationHub. apnsCredentialProperties (obrigatório)

ApnsCredentialProperties

Nome Descrição Valor
apnsCertificate Obtém ou define o certificado APNS. corda

Restrições:
Valor confidencial. Passe como um parâmetro seguro.
ID do aplicativo Obtém ou define a chave de declaração registrada do emissor (iss), cujo valor é
sua ID de equipe de 10 caracteres, obtida de sua conta de desenvolvedor
corda

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

Restrições:
Valor confidencial. Passe como um parâmetro seguro.
certificateKey Obtém ou define a chave de certificado. corda

Restrições:
Valor confidencial. Passe como um parâmetro seguro.
ponto de extremidade Obtém ou define o ponto de extremidade dessa credencial. corda

Restrições:
Comprimento mínimo = 1
Valor confidencial. Passe como um parâmetro seguro. (obrigatório)
ID da chave Obtém ou define uma chave de identificador de chave de 10 caracteres (kid), obtida de
sua conta de desenvolvedor
corda

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

Restrições:
Valor confidencial. Passe como um parâmetro seguro.
símbolo Obtém ou define o Token de Autenticação do provedor, obtido por meio do seu
conta do desenvolvedor
corda

Restrições:
Valor confidencial. Passe como um parâmetro seguro.

Credencial Baidu

Nome Descrição Valor
Propriedades Descrição de um BaiduCredential do NotificationHub. BaiduCredentialProperties (obrigatório)

BaiduCredentialProperties

Nome Descrição Valor
baiduApiKey Obtém ou define a Chave de API baidu. corda

Restrições:
Comprimento mínimo = 1
Valor confidencial. Passe como um parâmetro seguro. (obrigatório)
baiduEndPoint Obtém ou define o ponto de extremidade baidu. corda

Restrições:
Comprimento mínimo = 1
Valor confidencial. Passe como um parâmetro seguro. (obrigatório)
baiduSecretKey Obtém ou define a chave secreta baidu corda

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

Credencial do navegador

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

Propriedades do BrowserCredential

Nome Descrição Valor
Assunto Obtém ou define o assunto de push da Web. corda

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

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

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

Credencial FcmV1

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

FcmV1CredentialProperties

Nome Descrição Valor
clienteE-mail Obtém ou define o email do cliente. corda

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

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

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

GcmCredential

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

Propriedades GcmCredential

Nome Descrição Valor
gcmEndpoint Obtém ou define o ponto de extremidade GCM. corda

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

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

Regra de IP

Nome Descrição Valor
Máscara de ip Máscara de IP. corda

Restrições:
Comprimento mínimo = 1 (obrigatório)
direitos Lista de direitos de acesso. Matriz de cadeia de caracteres que contém qualquer um dos:
'Ouça'
'Gerenciar'
'Send' (obrigatório)

Credencial do Mpns

Nome Descrição Valor
Propriedades Descrição de um MpnsCredential do NotificationHub. MpnsCredentialProperties (obrigatório)

Propriedades de Credencial Mpns

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

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

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

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

Propriedades do namespace

Nome Descrição Valor
Centro de dados Deprecado. cadeia
tipo de namespace Define valores para NamespaceType. 'Mensagens'
'NotificationHub'
networkAcls Uma coleção de regras de autorização de rede. Redes Acls
pnsCredentials Coleção de credenciais PNS do Namespace do Hub de Notificação ou do Hub de Notificação. Credenciais de Pns
estado de provisionamento Define valores para OperationProvisioningState. 'Cancelado'
'Desabilitado'
'Falha'
'Em andamento'
'Pendente'
'Bem-sucedido'
'Desconhecido'
públicoAcessoRedeAcesso Tipo de acesso à rede pública. 'Desabilitado'
'Habilitado'
região de replicação Região de replicação permitida 'Leste da Austrália'
'BrasilSul'
'Padrão'
'Nenhum'
'Norte da Europa'
'África do SulNorte'
'Sudeste Asiático'
'WestUs2'
unidade de escala Obtém ou define scaleUnit em que o namespace é criado cadeia
status Status do namespace. 'Criado'
'Criando'
'Excluindo'
'Suspenso'
zoneRedundância Nome do SKU do namespace. 'Desabilitado'
'Habilitado'

Redes Acls

Nome Descrição Valor
ipRules Lista de regras de IP. Regra de Ip
Regra de Rede Pública Uma regra de autorização de rede padrão (Internet pública), que contém direitos se nenhuma outra regra de rede corresponder. PublicInternetAuthorizationRule

Credenciais de Pns

Nome Descrição Valor
admCredential Descrição de um NotificationHub AdmCredential. AdmCredential
apnsCredential Descrição de um ApnsCredential do NotificationHub. ApnsCredential
baiduCredencial Descrição de um BaiduCredential do NotificationHub. BaiduCredential
browserCredential Descrição de um NotificationHub BrowserCredential. BrowserCredential
fcmV1Credencial Descrição de um NotificationHub FcmV1Credential. fcmV1Credential
gcmCredential Descrição de um NotificationHub GcmCredential. GcmCredential
mpnsCredencial Descrição de um MpnsCredential do NotificationHub. do MpnsCredential
wnsCredencial Descrição de um WnsCredential do NotificationHub. WnsCredential
xiaomiCredencial Descrição de um XiaomiCredential do NotificationHub. XiaomiCredential

Regra de Autorização Pública

Nome Descrição Valor
direitos Lista de direitos de acesso. Matriz de cadeia de caracteres que contém qualquer um dos:
'Ouça'
'Gerenciar'
'Send' (obrigatório)

Sku

Nome Descrição Valor
capacidade Obtém ou define a capacidade do recurso int
família Obtém ou define a família Sku cadeia
nome Nome do SKU do namespace. 'Básico'
'Gratuito'
'Standard' (obrigatório)
tamanho Obtém ou define o tamanho do Sku cadeia
nível Obtém ou define a camada de sku específica cadeia

TrackedResourceTags

Nome Descrição Valor

WnsCredential

Nome Descrição Valor
Propriedades Descrição de um WnsCredential do NotificationHub. WnsCredentialProperties (obrigatório)

Propriedades WnsCredential

Nome Descrição Valor
certificateKey Ges ou define a Chave de Certificado WNS. corda

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

Restrições:
Valor confidencial. Passe como um parâmetro seguro.
Chave secreta Obtém ou define a chave secreta. corda

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

Restrições:
Valor confidencial. Passe como um parâmetro seguro.
wnsCertificado Obtém ou define o Certificado WNS. corda

Restrições:
Valor confidencial. Passe como um parâmetro seguro.

XiaomiCredencial

Nome Descrição Valor
Propriedades Descrição de um NotificationHub XiaomiCredentialProperties. XiaomiCredentialProperties (obrigatório)

XiaomiCredentialProperties

Nome Descrição Valor
appSecret Obtém ou define o segredo do aplicativo. corda

Restrições:
Valor confidencial. Passe como um parâmetro seguro.
ponto de extremidade Obtém ou define o ponto de extremidade de serviço da Xiaomi. corda

Restrições:
Valor confidencial. Passe como um parâmetro seguro.

Exemplos de uso

Modelos de Início Rápido do Azure

Os modelos de Início Rápido do Azure a seguir implantar 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
Esse modelo provisiona um Aplicativo Móvel, um Banco de Dados SQL e um 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 recurso do Terraform (provedor de AzAPI)

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

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

Formato de recurso

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.NotificationHubs/namespaces@2023-10-01-preview"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    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"
    }
  }
}

Valores de propriedade

Microsoft.NotificationHubs/namespaces

Nome Descrição Valor
local A localização geográfica onde o recurso reside cadeia de caracteres (obrigatório)
nome O nome do recurso corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 50
Padrão = ^[a-zA-Z][a-zA-Z0-9-]*$ (obrigatório)
parent_id A ID do recurso ao qual aplicar esse recurso de extensão. cadeia de caracteres (obrigatório)
Propriedades Representa as propriedades do namespace. Propriedades do namespace
Sku A descrição do Sku para um namespace de SKU (obrigatório)
Tags Marcas de recurso Dicionário de nomes e valores de marca.
tipo O tipo de recurso "Microsoft.NotificationHubs/namespaces@2023-10-01-preview"

AdmCredential

Nome Descrição Valor
Propriedades Descrição de um NotificationHub AdmCredential. AdmCredentialProperties (obrigatório)

AdmCredentialProperties

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

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

Restrições:
Comprimento mínimo = 1
Valor confidencial. Passe como um parâmetro seguro. (obrigatório)
segredo do cliente Obtém ou define a chave de acesso do segredo da credencial. corda

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

ApnsCredential

Nome Descrição Valor
Propriedades Descrição de um ApnsCredential do NotificationHub. apnsCredentialProperties (obrigatório)

ApnsCredentialProperties

Nome Descrição Valor
apnsCertificate Obtém ou define o certificado APNS. corda

Restrições:
Valor confidencial. Passe como um parâmetro seguro.
ID do aplicativo Obtém ou define a chave de declaração registrada do emissor (iss), cujo valor é
sua ID de equipe de 10 caracteres, obtida de sua conta de desenvolvedor
corda

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

Restrições:
Valor confidencial. Passe como um parâmetro seguro.
certificateKey Obtém ou define a chave de certificado. corda

Restrições:
Valor confidencial. Passe como um parâmetro seguro.
ponto de extremidade Obtém ou define o ponto de extremidade dessa credencial. corda

Restrições:
Comprimento mínimo = 1
Valor confidencial. Passe como um parâmetro seguro. (obrigatório)
ID da chave Obtém ou define uma chave de identificador de chave de 10 caracteres (kid), obtida de
sua conta de desenvolvedor
corda

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

Restrições:
Valor confidencial. Passe como um parâmetro seguro.
símbolo Obtém ou define o Token de Autenticação do provedor, obtido por meio do seu
conta do desenvolvedor
corda

Restrições:
Valor confidencial. Passe como um parâmetro seguro.

Credencial Baidu

Nome Descrição Valor
Propriedades Descrição de um BaiduCredential do NotificationHub. BaiduCredentialProperties (obrigatório)

BaiduCredentialProperties

Nome Descrição Valor
baiduApiKey Obtém ou define a Chave de API baidu. corda

Restrições:
Comprimento mínimo = 1
Valor confidencial. Passe como um parâmetro seguro. (obrigatório)
baiduEndPoint Obtém ou define o ponto de extremidade baidu. corda

Restrições:
Comprimento mínimo = 1
Valor confidencial. Passe como um parâmetro seguro. (obrigatório)
baiduSecretKey Obtém ou define a chave secreta baidu corda

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

Credencial do navegador

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

Propriedades do BrowserCredential

Nome Descrição Valor
Assunto Obtém ou define o assunto de push da Web. corda

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

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

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

Credencial FcmV1

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

FcmV1CredentialProperties

Nome Descrição Valor
clienteE-mail Obtém ou define o email do cliente. corda

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

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

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

GcmCredential

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

Propriedades GcmCredential

Nome Descrição Valor
gcmEndpoint Obtém ou define o ponto de extremidade GCM. corda

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

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

Regra de IP

Nome Descrição Valor
Máscara de ip Máscara de IP. corda

Restrições:
Comprimento mínimo = 1 (obrigatório)
direitos Lista de direitos de acesso. Matriz de cadeia de caracteres que contém qualquer um dos:
'Ouça'
'Gerenciar'
'Send' (obrigatório)

Credencial do Mpns

Nome Descrição Valor
Propriedades Descrição de um MpnsCredential do NotificationHub. MpnsCredentialProperties (obrigatório)

Propriedades de Credencial Mpns

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

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

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

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

Propriedades do namespace

Nome Descrição Valor
Centro de dados Deprecado. cadeia
tipo de namespace Define valores para NamespaceType. 'Mensagens'
'NotificationHub'
networkAcls Uma coleção de regras de autorização de rede. Redes Acls
pnsCredentials Coleção de credenciais PNS do Namespace do Hub de Notificação ou do Hub de Notificação. Credenciais de Pns
estado de provisionamento Define valores para OperationProvisioningState. 'Cancelado'
'Desabilitado'
'Falha'
'Em andamento'
'Pendente'
'Bem-sucedido'
'Desconhecido'
públicoAcessoRedeAcesso Tipo de acesso à rede pública. 'Desabilitado'
'Habilitado'
região de replicação Região de replicação permitida 'Leste da Austrália'
'BrasilSul'
'Padrão'
'Nenhum'
'Norte da Europa'
'África do SulNorte'
'Sudeste Asiático'
'WestUs2'
unidade de escala Obtém ou define scaleUnit em que o namespace é criado cadeia
status Status do namespace. 'Criado'
'Criando'
'Excluindo'
'Suspenso'
zoneRedundância Nome do SKU do namespace. 'Desabilitado'
'Habilitado'

Redes Acls

Nome Descrição Valor
ipRules Lista de regras de IP. Regra de Ip
Regra de Rede Pública Uma regra de autorização de rede padrão (Internet pública), que contém direitos se nenhuma outra regra de rede corresponder. PublicInternetAuthorizationRule

Credenciais de Pns

Nome Descrição Valor
admCredential Descrição de um NotificationHub AdmCredential. AdmCredential
apnsCredential Descrição de um ApnsCredential do NotificationHub. ApnsCredential
baiduCredencial Descrição de um BaiduCredential do NotificationHub. BaiduCredential
browserCredential Descrição de um NotificationHub BrowserCredential. BrowserCredential
fcmV1Credencial Descrição de um NotificationHub FcmV1Credential. fcmV1Credential
gcmCredential Descrição de um NotificationHub GcmCredential. GcmCredential
mpnsCredencial Descrição de um MpnsCredential do NotificationHub. do MpnsCredential
wnsCredencial Descrição de um WnsCredential do NotificationHub. WnsCredential
xiaomiCredencial Descrição de um XiaomiCredential do NotificationHub. XiaomiCredential

Regra de Autorização Pública

Nome Descrição Valor
direitos Lista de direitos de acesso. Matriz de cadeia de caracteres que contém qualquer um dos:
'Ouça'
'Gerenciar'
'Send' (obrigatório)

Sku

Nome Descrição Valor
capacidade Obtém ou define a capacidade do recurso int
família Obtém ou define a família Sku cadeia
nome Nome do SKU do namespace. 'Básico'
'Gratuito'
'Standard' (obrigatório)
tamanho Obtém ou define o tamanho do Sku cadeia
nível Obtém ou define a camada de sku específica cadeia

TrackedResourceTags

Nome Descrição Valor

WnsCredential

Nome Descrição Valor
Propriedades Descrição de um WnsCredential do NotificationHub. WnsCredentialProperties (obrigatório)

Propriedades WnsCredential

Nome Descrição Valor
certificateKey Ges ou define a Chave de Certificado WNS. corda

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

Restrições:
Valor confidencial. Passe como um parâmetro seguro.
Chave secreta Obtém ou define a chave secreta. corda

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

Restrições:
Valor confidencial. Passe como um parâmetro seguro.
wnsCertificado Obtém ou define o Certificado WNS. corda

Restrições:
Valor confidencial. Passe como um parâmetro seguro.

XiaomiCredencial

Nome Descrição Valor
Propriedades Descrição de um NotificationHub XiaomiCredentialProperties. XiaomiCredentialProperties (obrigatório)

XiaomiCredentialProperties

Nome Descrição Valor
appSecret Obtém ou define o segredo do aplicativo. corda

Restrições:
Valor confidencial. Passe como um parâmetro seguro.
ponto de extremidade Obtém ou define o ponto de extremidade de serviço da Xiaomi. corda

Restrições:
Valor confidencial. Passe como um parâmetro seguro.

Exemplos de uso

Exemplos do Terraform

Um exemplo básico de implantação do Namespace do Hub de Notificação.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "namespace" {
  type      = "Microsoft.NotificationHubs/namespaces@2017-04-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      enabled       = true
      namespaceType = "NotificationHub"
      region        = "westeurope"
    }
    sku = {
      name = "Free"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}