Observação
O acesso a essa página exige autorização. Você pode tentar entrar ou alterar diretórios.
O acesso a essa página exige autorização. Você pode tentar alterar os diretórios.
Definição de recurso do Bicep
O tipo de recurso namespaces/notificationHubs pode ser implantado com operações direcionadas:
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/notificationHubs, adicione o Bicep a seguir 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
| 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 = 265 Padrão = ^[a-zA-Z][a-zA-Z0-9-./_]*$ (obrigatório) |
| pai | 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 o recurso do tipo: namespaces |
| Propriedades | Propriedades do NotificationHub. | |
| Sku | A descrição do Sku para um namespace | de SKU |
| 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) |
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 NotificationHub
| 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 |
| nome | Obtém ou define o nome do NotificationHub. | cadeia |
| registroTtl | Obtém ou define o RegistrationTtl do NotificationHub criado | cadeia |
| wnsCredencial | Descrição de um WnsCredential do NotificationHub. | WnsCredential |
| xiaomiCredencial | Descrição de um XiaomiCredential do NotificationHub. | XiaomiCredential |
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/notificationHubs pode ser implantado com operações direcionadas:
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/notificationHubs, adicione o JSON a seguir 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
| 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 = 265 Padrão = ^[a-zA-Z][a-zA-Z0-9-./_]*$ (obrigatório) |
| Propriedades | Propriedades do NotificationHub. | |
| Sku | A descrição do Sku para um namespace | de SKU |
| Tags | Marcas de recurso | Dicionário de nomes e valores de marca. Consulte Marcas em modelos |
| tipo | O tipo de recurso | 'Microsoft.NotificationHubs/namespaces/notificationHubs' |
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) |
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 NotificationHub
| 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 |
| nome | Obtém ou define o nome do NotificationHub. | cadeia |
| registroTtl | Obtém ou define o RegistrationTtl do NotificationHub criado | cadeia |
| wnsCredencial | Descrição de um WnsCredential do NotificationHub. | WnsCredential |
| xiaomiCredencial | Descrição de um XiaomiCredential do NotificationHub. | XiaomiCredential |
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 |
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 |
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/notificationHubs pode ser implantado com operações direcionadas:
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/notificationHubs, adicione o Terraform a seguir 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
| 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 = 265 Padrão = ^[a-zA-Z][a-zA-Z0-9-./_]*$ (obrigatório) |
| parent_id | A ID do recurso que é o pai desse recurso. | ID do recurso do tipo: namespaces |
| Propriedades | Propriedades do NotificationHub. | |
| Sku | A descrição do Sku para um namespace | de SKU |
| Tags | Marcas de recurso | Dicionário de nomes e valores de marca. |
| tipo | O tipo de recurso | "Microsoft.NotificationHubs/namespaces/notificationHubs@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) |
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 NotificationHub
| 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 |
| nome | Obtém ou define o nome do NotificationHub. | cadeia |
| registroTtl | Obtém ou define o RegistrationTtl do NotificationHub criado | cadeia |
| wnsCredencial | Descrição de um WnsCredential do NotificationHub. | WnsCredential |
| xiaomiCredencial | Descrição de um XiaomiCredential do NotificationHub. | XiaomiCredential |
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 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 = ["*"]
}