Partilhar via


Namespaces/notificationHubs Microsoft.NotificationHubs

Definição de recursos do bíceps

O tipo de recurso namespaces/notificationHubs 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/notificationHubs, adicione o seguinte Bicep ao seu modelo.

resource symbolicname 'Microsoft.NotificationHubs/namespaces/notificationHubs@2023-10-01-preview' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  properties: {
    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'
      }
    }
    name: 'string'
    registrationTtl: 'string'
    wnsCredential: {
      properties: {
        certificateKey: 'string'
        packageSid: 'string'
        secretKey: 'string'
        windowsLiveEndpoint: 'string'
        wnsCertificate: 'string'
      }
    }
    xiaomiCredential: {
      properties: {
        appSecret: 'string'
        endpoint: 'string'
      }
    }
  }
  sku: {
    capacity: int
    family: 'string'
    name: 'string'
    size: 'string'
    tier: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Valores de propriedade

Microsoft.NotificationHubs/namespaces/notificationHubs

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

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 265
Padrão = ^[a-zA-Z][a-zA-Z0-9-./_]*$ (obrigatório)
elemento principal No Bicep, você pode especificar o recurso pai para um recurso filho. Você só precisa adicionar essa propriedade quando o recurso filho é declarado fora do recurso pai.

Para obter mais informações, consulte recurso filho fora do recurso pai.
Nome simbólico para recurso do tipo: namespaces
propriedades Propriedades de NotificationHub. NotificationHubProperties
SKU A descrição da Sku para um namespace Referência
Etiquetas Tags de recursos Dicionário de nomes e valores de tags. Consulte Tags em modelos

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. cadeia de caracteres

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. cadeia de caracteres

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

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. cadeia de caracteres

Restrições:
Valor sensível. Passe como um parâmetro seguro.
ID do aplicativo 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
cadeia de caracteres

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

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

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

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
cadeia de caracteres

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

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

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. cadeia de caracteres

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

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 cadeia de caracteres

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. cadeia de caracteres

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. cadeia de caracteres

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. cadeia de caracteres

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. cadeia de caracteres

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. cadeia de caracteres

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. cadeia de caracteres

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. cadeia de caracteres

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

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

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. cadeia de caracteres

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. cadeia de caracteres

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

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

NotificationHubProperties

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. Credencial FcmV1
gcmCredencial Descrição de um NotificationHub GcmCredential. GcmCredential
mpnsCredential Descrição de um NotificationHub MpnsCredential. MpnsCredential
Designação Obtém ou define o nome NotificationHub. cadeia (de caracteres)
registoTtl Obtém ou define o RegistrationTtl do NotificationHub criado cadeia (de caracteres)
wnsCredential Descrição de um NotificationHub WnsCredential. WnsCredential
xiaomiCredencial Descrição de um NotificationHub XiaomiCredential. Credencial Xiaomi

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 cadeia (de caracteres)
Designação Nome da SKU do namespace. 'Básico'
'Grátis'
'Standard' (obrigatório)
tamanho Obtém ou define o tamanho da Sku cadeia (de caracteres)
escalão Obtém ou define a camada de sku específico cadeia (de caracteres)

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. cadeia de caracteres

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

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

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

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

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. cadeia de caracteres

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. cadeia de caracteres

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

Exemplos de uso

Exemplos de início rápido do Azure

Os seguintes modelos início rápido do Azure 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 ARM

O tipo de recurso namespaces/notificationHubs 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/notificationHubs, adicione o seguinte JSON ao seu modelo.

{
  "type": "Microsoft.NotificationHubs/namespaces/notificationHubs",
  "apiVersion": "2023-10-01-preview",
  "name": "string",
  "location": "string",
  "properties": {
    "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"
      }
    },
    "name": "string",
    "registrationTtl": "string",
    "wnsCredential": {
      "properties": {
        "certificateKey": "string",
        "packageSid": "string",
        "secretKey": "string",
        "windowsLiveEndpoint": "string",
        "wnsCertificate": "string"
      }
    },
    "xiaomiCredential": {
      "properties": {
        "appSecret": "string",
        "endpoint": "string"
      }
    }
  },
  "sku": {
    "capacity": "int",
    "family": "string",
    "name": "string",
    "size": "string",
    "tier": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valores de propriedade

Microsoft.NotificationHubs/namespaces/notificationHubs

Designação Descrição Valor
Versão da API 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 cadeia de caracteres

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

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. cadeia de caracteres

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. cadeia de caracteres

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

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. cadeia de caracteres

Restrições:
Valor sensível. Passe como um parâmetro seguro.
ID do aplicativo 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
cadeia de caracteres

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

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

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

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
cadeia de caracteres

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

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

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. cadeia de caracteres

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

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 cadeia de caracteres

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. cadeia de caracteres

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. cadeia de caracteres

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. cadeia de caracteres

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. cadeia de caracteres

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. cadeia de caracteres

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. cadeia de caracteres

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. cadeia de caracteres

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

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

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. cadeia de caracteres

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. cadeia de caracteres

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

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

NotificationHubProperties

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. Credencial FcmV1
gcmCredencial Descrição de um NotificationHub GcmCredential. GcmCredential
mpnsCredential Descrição de um NotificationHub MpnsCredential. MpnsCredential
Designação Obtém ou define o nome NotificationHub. cadeia (de caracteres)
registoTtl Obtém ou define o RegistrationTtl do NotificationHub criado cadeia (de caracteres)
wnsCredential Descrição de um NotificationHub WnsCredential. WnsCredential
xiaomiCredencial Descrição de um NotificationHub XiaomiCredential. Credencial Xiaomi

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 cadeia (de caracteres)
Designação Nome da SKU do namespace. 'Básico'
'Grátis'
'Standard' (obrigatório)
tamanho Obtém ou define o tamanho da Sku cadeia (de caracteres)
escalão Obtém ou define a camada de sku específico cadeia (de caracteres)

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. cadeia de caracteres

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

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

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

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

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. cadeia de caracteres

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. cadeia de caracteres

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

Exemplos de uso

Modelos de início rápido do Azure

Os seguintes modelos de início rápido do Azure 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
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/notificationHubs 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/notificationHubs, adicione o seguinte Terraform ao seu modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.NotificationHubs/namespaces/notificationHubs@2023-10-01-preview"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      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"
        }
      }
      name = "string"
      registrationTtl = "string"
      wnsCredential = {
        properties = {
          certificateKey = "string"
          packageSid = "string"
          secretKey = "string"
          windowsLiveEndpoint = "string"
          wnsCertificate = "string"
        }
      }
      xiaomiCredential = {
        properties = {
          appSecret = "string"
          endpoint = "string"
        }
      }
    }
    sku = {
      capacity = int
      family = "string"
      name = "string"
      size = "string"
      tier = "string"
    }
  }
}

Valores de propriedade

Microsoft.NotificationHubs/namespaces/notificationHubs

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

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 265
Padrão = ^[a-zA-Z][a-zA-Z0-9-./_]*$ (obrigatório)
parent_id A ID do recurso que é o pai para este recurso. ID para recurso do tipo: namespaces
propriedades Propriedades de NotificationHub. NotificationHubProperties
SKU A descrição da Sku para um namespace Referência
Etiquetas Tags de recursos Dicionário de nomes e valores de tags.
tipo O tipo de recurso "Microsoft.NotificationHubs/namespaces/notificationHubs@2023-10-01-preview"

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. cadeia de caracteres

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. cadeia de caracteres

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

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. cadeia de caracteres

Restrições:
Valor sensível. Passe como um parâmetro seguro.
ID do aplicativo 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
cadeia de caracteres

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

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

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

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
cadeia de caracteres

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

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

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. cadeia de caracteres

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

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 cadeia de caracteres

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. cadeia de caracteres

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. cadeia de caracteres

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. cadeia de caracteres

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. cadeia de caracteres

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. cadeia de caracteres

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. cadeia de caracteres

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. cadeia de caracteres

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

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

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. cadeia de caracteres

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. cadeia de caracteres

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

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

NotificationHubProperties

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. Credencial FcmV1
gcmCredencial Descrição de um NotificationHub GcmCredential. GcmCredential
mpnsCredential Descrição de um NotificationHub MpnsCredential. MpnsCredential
Designação Obtém ou define o nome NotificationHub. cadeia (de caracteres)
registoTtl Obtém ou define o RegistrationTtl do NotificationHub criado cadeia (de caracteres)
wnsCredential Descrição de um NotificationHub WnsCredential. WnsCredential
xiaomiCredencial Descrição de um NotificationHub XiaomiCredential. Credencial Xiaomi

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 cadeia (de caracteres)
Designação Nome da SKU do namespace. 'Básico'
'Grátis'
'Standard' (obrigatório)
tamanho Obtém ou define o tamanho da Sku cadeia (de caracteres)
escalão Obtém ou define a camada de sku específico cadeia (de caracteres)

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. cadeia de caracteres

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

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

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

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

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. cadeia de caracteres

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. cadeia de caracteres

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

Exemplos de uso

Amostras Terraform

Um exemplo básico de implantação do Hub de Notificação em um 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    = ["*"]
}

resource "azapi_resource" "notificationHub" {
  type      = "Microsoft.NotificationHubs/namespaces/notificationHubs@2017-04-01"
  parent_id = azapi_resource.namespace.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}