Espaços de nomes Microsoft.NotificationHubs
Definição de recurso do Bicep
O tipo de recurso de espaços de nomes pode ser implementado com operações que visam:
- Grupos de recursos – veja comandos de implementação de grupos de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, veja registo de alterações.
Formato do recurso
Para criar um recurso Microsoft.NotificationHubs/namespaces, adicione o seguinte Bicep ao seu modelo.
resource symbolicname 'Microsoft.NotificationHubs/namespaces@2023-10-01-preview' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
sku: {
capacity: int
family: 'string'
name: 'string'
size: 'string'
tier: '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'
}
}
Valores de propriedade
espaços de nomes
| Nome | Descrição | Valor |
|---|---|---|
| name | O nome do recurso | cadeia (obrigatório) Limite de carateres: 6-50 Carateres válidos: Alfanuméricos e hífenes Comece com a letra. Termine com alfanumérico. O nome do recurso tem de ser exclusivo em todo o Azure. |
| localização | A localização geográfica onde o recurso se encontra | cadeia (obrigatório) |
| etiquetas | Etiquetas de recursos. | Dicionário de nomes e valores de etiquetas. Ver Etiquetas em modelos |
| sku | A descrição do Sku para um espaço de nomes | SKU (obrigatório) |
| propriedades | Representa propriedades do espaço de nomes. | NamespaceProperties |
NamespaceProperties
| Nome | Descrição | Valor |
|---|---|---|
| dataCenter | Preterido. | string |
| namespaceType | Define valores para NamespaceType. | 'Mensagens' "NotificationHub" |
| networkAcls | Uma coleção de regras de autorização de rede. | NetworkAcls |
| pnsCredentials | Coleção de credenciais PNS do Hub de Notificação ou do Espaço de Nomes do Hub de Notificação. | PnsCredentials |
| provisioningState | Define valores para OperationProvisioningState. | "Cancelado" "Desativado" "Falha" "Entrada" "Pendente" "Bem-sucedido" 'Desconhecido' |
| publicNetworkAccess | Tipo de acesso à rede pública. | "Desativado" "Ativado" |
| replicationRegion | Região de replicação permitida | 'AustraliaEast' 'BrasilSouth' 'Predefinição' "Nenhum" 'NorthEurope' 'SouthAfricaNorth' 'SouthEastAsia' "WestUs2" |
| scaleUnit | Obtém ou define scaleUnit onde o espaço de nomes é criado | string |
| status | Estado do espaço de nomes. | "Criado" "A criar" "A eliminar" "Suspenso" |
| zoneRedundancy | Nome do SKU do espaço de nomes. | "Desativado" "Ativado" |
NetworkAcls
| Nome | Descrição | Valor |
|---|---|---|
| ipRules | Lista de regras de IP. | IpRule[] |
| publicNetworkRule | Uma regra de autorização de rede predefinida (Internet pública), que contém direitos se nenhuma outra regra de rede corresponder. | PublicInternetAuthorizationRule |
IpRule
| Nome | Descrição | Valor |
|---|---|---|
| ipMask | Máscara de IP. | cadeia (obrigatório) Restrições: Comprimento mínimo = 1 |
| direitos | Lista de direitos de acesso. | Matriz de cadeia que contém qualquer um dos seguintes: 'Ouvir' "Gerir" "Enviar" (obrigatório) |
PublicInternetAuthorizationRule
| Nome | Descrição | Valor |
|---|---|---|
| direitos | Lista de direitos de acesso. | Matriz de cadeia que contém qualquer um dos seguintes: 'Ouvir' "Gerir" "Enviar" (obrigatório) |
PnsCredentials
| Nome | Descrição | Valor |
|---|---|---|
| admCredential | Descrição de um NotificationHub AdmCredential. | AdmCredential |
| apnsCredential | Descrição de um NotificationHub ApnsCredential. | ApnsCredential |
| baiduCredential | Descrição de um NotificationHub BaiduCredential. | BaiduCredential |
| browserCredential | Descrição de um NotificationHub BrowserCredential. | BrowserCredential |
| fcmV1Credential | Descrição de um NotificationHub FcmV1Credential. | FcmV1Credential |
| gcmCredential | Descrição de um NotificationHub GcmCredential. | GcmCredential |
| mpnsCredential | Descrição de um NotificationHub MpnsCredential. | MpnsCredential |
| wnsCredential | Descrição de um NotificationHub WnsCredential. | WnsCredential |
| xiaomiCredential | Descrição de um NotificationHub XiaomiCredential. | XiaomiCredential |
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 o URL do token de autorização. | cadeia (obrigatório) Restrições: Comprimento mínimo = 1 Valor confidencial. Transmita como um parâmetro seguro. |
| clientId | Obtém ou define o identificador do cliente. | cadeia (obrigatório) Restrições: Comprimento mínimo = 1 Valor confidencial. Transmita como um parâmetro seguro. |
| clientSecret | Obtém ou define a chave de acesso do segredo de credenciais. | cadeia (obrigatório) Restrições: Comprimento mínimo = 1 Valor confidencial. Transmita como um parâmetro seguro. |
ApnsCredential
| Nome | Descrição | Valor |
|---|---|---|
| propriedades | Descrição de um NotificationHub ApnsCredential. | ApnsCredentialProperties (obrigatório) |
ApnsCredentialProperties
| Nome | Descrição | Valor |
|---|---|---|
| apnsCertificate | Obtém ou define o certificado APNS. | string Restrições: Valor sensível. Transmita como um parâmetro seguro. |
| appId | Obtém ou define a chave de afirmação registada do emissor (iss), cujo valor é o seu ID de Equipa de 10 carateres, obtido a partir da sua conta de programador |
string Restrições: Valor sensível. Transmita como um parâmetro seguro. |
| appName | Obtém ou define o nome da aplicação | string Restrições: Valor sensível. Transmita como um parâmetro seguro. |
| certificateKey | Obtém ou define a chave de certificado. | string Restrições: Valor sensível. Transmita como um parâmetro seguro. |
| endpoint | Obtém ou define o ponto final desta credencial. | cadeia (obrigatório) Restrições: Comprimento mínimo = 1 Valor sensível. Transmita como um parâmetro seguro. |
| keyId | Obtém ou define uma chave de identificador de chave de 10 carateres (criança), obtida a partir de a sua conta de programador |
string Restrições: Valor sensível. Transmita como um parâmetro seguro. |
| thumbprint | Obtém ou define o Thumbprint do certificado APNS | string Restrições: Valor sensível. Transmita como um parâmetro seguro. |
| token | Obtém ou define o Token de Autenticação do fornecedor, obtido através do seu conta de programador |
string Restrições: Valor sensível. Transmita como um parâmetro seguro. |
BaiduCredential
| Nome | Descrição | Valor |
|---|---|---|
| propriedades | Descrição de um NotificationHub BaiduCredential. | BaiduCredentialProperties (obrigatório) |
BaiduCredentialProperties
| Nome | Descrição | Valor |
|---|---|---|
| baiduApiKey | Obtém ou define a Chave de API baidu. | cadeia (obrigatório) Restrições: Comprimento mínimo = 1 Valor sensível. Transmita como um parâmetro seguro. |
| baiduEndPoint | Obtém ou define o Ponto Final do baidu. | cadeia (obrigatório) Restrições: Comprimento mínimo = 1 Valor sensível. Transmita como um parâmetro seguro. |
| baiduSecretKey | Obtém ou define a Chave Secreta do Baidu | cadeia (obrigatório) Restrições: Comprimento mínimo = 1 Valor sensível. Transmita como um parâmetro seguro. |
BrowserCredential
| Nome | Descrição | Valor |
|---|---|---|
| propriedades | Descrição de um NotificationHub BrowserCredential. | BrowserCredentialProperties (obrigatório) |
BrowserCredentialProperties
| Nome | Descrição | Valor |
|---|---|---|
| subject | Obtém ou define o assunto web push. | cadeia (obrigatório) Restrições: Comprimento mínimo = 1 Valor sensível. Transmita como um parâmetro seguro. |
| vapidPrivateKey | Obtém ou define a chave privada VAPID. | cadeia (obrigatório) Restrições: Comprimento mínimo = 1 Valor sensível. Transmita como um parâmetro seguro. |
| vapidPublicKey | Obtém ou define a chave pública VAPID. | cadeia (obrigatório) Restrições: Comprimento mínimo = 1 Valor sensível. Transmita como um parâmetro seguro. |
FcmV1Credential
| Nome | Descrição | Valor |
|---|---|---|
| propriedades | Descrição de um NotificationHub FcmV1Credential. | FcmV1CredentialProperties (obrigatório) |
FcmV1CredentialProperties
| Nome | Descrição | Valor |
|---|---|---|
| clientEmail | Obtém ou define o e-mail do cliente. | cadeia (obrigatório) Restrições: Comprimento mínimo = 1 Valor sensível. Transmita como um parâmetro seguro. |
| privateKey | Obtém ou define a chave privada. | cadeia (obrigatório) Restrições: Comprimento mínimo = 1 Valor sensível. Transmita como um parâmetro seguro. |
| projectId | Obtém ou define o ID do projeto. | cadeia (obrigatório) Restrições: Comprimento mínimo = 1 Valor sensível. Transmita como um parâmetro seguro. |
GcmCredential
| Nome | Descrição | Valor |
|---|---|---|
| propriedades | Descrição de um NotificationHub GcmCredential. | GcmCredentialProperties (obrigatório) |
GcmCredentialProperties
| Nome | Descrição | Valor |
|---|---|---|
| gcmEndpoint | Obtém ou define o ponto final do GCM. | string Restrições: Valor sensível. Transmita como um parâmetro seguro. |
| googleApiKey | Obtém ou define a chave da API Google. | cadeia (obrigatório) Restrições: Comprimento mínimo = 1 Valor sensível. Transmita como um parâmetro seguro. |
MpnsCredential
| Nome | Descrição | Valor |
|---|---|---|
| propriedades | Descrição de um NotificationHub MpnsCredential. | MpnsCredentialProperties (obrigatório) |
MpnsCredentialProperties
| Nome | Descrição | Valor |
|---|---|---|
| certificateKey | Obtém ou define a chave de certificado para esta credencial. | cadeia (obrigatório) Restrições: Comprimento mínimo = 1 Valor sensível. Transmita como um parâmetro seguro. |
| mpnsCertificate | Obtém ou define o certificado MPNS. | cadeia (obrigatório) Restrições: Comprimento mínimo = 1 Valor sensível. Transmita como um parâmetro seguro. |
| thumbprint | Obtém ou define o Thumbprint do certificado MPNS | cadeia (obrigatório) Restrições: Comprimento mínimo = 1 Valor sensível. Transmita como um parâmetro seguro. |
WnsCredential
| Nome | Descrição | Valor |
|---|---|---|
| propriedades | Descrição de um NotificationHub WnsCredential. | WnsCredentialProperties (obrigatório) |
WnsCredentialProperties
| Nome | Descrição | Valor |
|---|---|---|
| certificateKey | Ges ou define a Chave de Certificado WNS. | string Restrições: Valor sensível. Transmita como um parâmetro seguro. |
| packageSid | Obtém ou define o ID do pacote para esta credencial. | string Restrições: Valor sensível. Transmita como um parâmetro seguro. |
| secretKey | Obtém ou define a chave secreta. | string Restrições: Valor sensível. Transmita como um parâmetro seguro. |
| windowsLiveEndpoint | Obtém ou define o ponto final do Windows Live. | string Restrições: Valor sensível. Transmita como um parâmetro seguro. |
| wnsCertificate | Obtém ou define o Certificado WNS. | string Restrições: Valor sensível. Transmita como um parâmetro seguro. |
XiaomiCredential
| 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 da aplicação. | string Restrições: Valor sensível. Transmita como um parâmetro seguro. |
| endpoint | Obtém ou define o ponto final de serviço da Xiaomi. | string Restrições: Valor sensível. Transmita como um parâmetro seguro. |
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 | string |
| name | Nome do SKU do espaço de nomes. | "Básico" 'Gratuito' "Standard" (obrigatório) |
| size | Obtém ou define o tamanho do Sku | string |
| tier | Obtém ou define a camada de sku específico | string |
Modelos de início rápido
Os seguintes modelos de início rápido implementam este tipo de recurso.
| Modelo | Description |
|---|---|
Criar o Hub de Notificação do Azure |
Cria um Hub de Notificação do Azure, um Modelo originalmente criado por John Downs. |
| Aprovisionar uma Aplicação Móvel com um Base de Dados SQL |
Este modelo aprovisiona uma Aplicação Móvel, Base de Dados SQL e Hub de Notificação. Configura uma cadeia de ligação na aplicação móvel para a base de dados e o hub de notificação. |
Definição de recurso do modelo arm
O tipo de recurso de espaços de nomes pode ser implementado com operações que visam:
- Grupos de recursos – veja os comandos de implementação do grupo de recursos
Para obter uma lista das propriedades alteradas em cada versão da API, veja Registo de alterações.
Formato do recurso
Para criar um recurso Microsoft.NotificationHubs/namespaces, adicione o seguinte JSON ao seu modelo.
{
"type": "Microsoft.NotificationHubs/namespaces",
"apiVersion": "2023-10-01-preview",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"sku": {
"capacity": "int",
"family": "string",
"name": "string",
"size": "string",
"tier": "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"
}
}
Valores de propriedade
espaços de nomes
| Nome | Descrição | Valor |
|---|---|---|
| tipo | O tipo de recurso | "Microsoft.NotificationHubs/namespaces" |
| apiVersion | A versão da API de recursos | '2023-10-01-preview' |
| name | O nome do recurso | cadeia (obrigatório) Limite de carateres: 6-50 Carateres válidos: Alfanuméricos e hífenes Comece com a letra. Terminar com alfanumérico. O nome do recurso tem de ser exclusivo em todo o Azure. |
| localização | A localização geográfica onde reside o recurso | cadeia (obrigatório) |
| etiquetas | Etiquetas de recursos. | Dicionário de nomes e valores de etiquetas. Ver Etiquetas em modelos |
| sku | A descrição do SKU para um espaço de nomes | SKU (obrigatório) |
| propriedades | Representa as propriedades do espaço de nomes. | NamespaceProperties |
NamespaceProperties
| Nome | Descrição | Valor |
|---|---|---|
| dataCenter | Preterido. | string |
| namespaceType | Define valores para NamespaceType. | 'Mensagens' "NotificationHub" |
| networkAcls | Uma coleção de regras de autorização de rede. | NetworkAcls |
| pnsCredentials | Coleção de credenciais PNS do Hub de Notificação ou do Espaço de Nomes do Hub de Notificação. | PnsCredentials |
| provisioningState | Define valores para OperationProvisioningState. | "Cancelado" "Desativado" "Com falhas" "Entrada" "Pendente" "Com êxito" "Desconhecido" |
| publicNetworkAccess | Tipo de acesso à rede pública. | "Desativado" "Ativado" |
| replicationRegion | Região de replicação permitida | 'AustraliaEast' 'BrazilSouth' 'Predefinição' "Nenhum" 'NorthEurope' 'SouthAfricaNorth' 'SouthEastAsia' "E.U.A. Oeste2" |
| scaleUnit | Obtém ou define scaleUnit onde o espaço de nomes é criado | string |
| status | Estado do espaço de nomes. | "Criado" "A criar" "A eliminar" "Suspenso" |
| zoneRedundancy | Nome do SKU do espaço de nomes. | "Desativado" "Ativado" |
NetworkAcls
| Nome | Descrição | Valor |
|---|---|---|
| ipRules | Lista de regras de IP. | IpRule[] |
| publicNetworkRule | Uma regra de autorização de rede predefinida (Internet pública), que contém direitos se nenhuma outra regra de rede corresponder. | PublicInternetAuthorizationRule |
IpRule
| Nome | Descrição | Valor |
|---|---|---|
| ipMask | Máscara de IP. | cadeia (obrigatório) Restrições: Comprimento mínimo = 1 |
| direitos | Lista de direitos de acesso. | Matriz de cadeia que contém qualquer um dos seguintes: 'Ouvir' "Gerir" "Enviar" (obrigatório) |
PublicInternetAuthorizationRule
| Nome | Descrição | Valor |
|---|---|---|
| direitos | Lista de direitos de acesso. | Matriz de cadeia que contém qualquer um dos seguintes: 'Ouvir' "Gerir" "Enviar" (obrigatório) |
PnsCredentials
| Nome | Descrição | Valor |
|---|---|---|
| admCredential | Descrição de um NotificationHub AdmCredential. | AdmCredential |
| apnsCredential | Descrição de um NotificationHub ApnsCredential. | ApnsCredential |
| baiduCredential | Descrição de um NotificationHub BaiduCredential. | BaiduCredential |
| browserCredential | Descrição de um NotificationHub BrowserCredential. | BrowserCredential |
| fcmV1Credential | Descrição de um NotificationHub FcmV1Credential. | FcmV1Credential |
| gcmCredential | Descrição de um NotificationHub GcmCredential. | GcmCredential |
| mpnsCredential | Descrição de um NotificationHub MpnsCredential. | MpnsCredential |
| wnsCredential | Descrição de um NotificationHub WnsCredential. | WnsCredential |
| xiaomiCredential | Descrição de um NotificationHub XiaomiCredential. | XiaomiCredential |
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 o URL do token de autorização. | cadeia (obrigatório) Restrições: Comprimento mínimo = 1 Valor confidencial. Transmita como um parâmetro seguro. |
| clientId | Obtém ou define o identificador do cliente. | cadeia (obrigatório) Restrições: Comprimento mínimo = 1 Valor confidencial. Transmita como um parâmetro seguro. |
| clientSecret | Obtém ou define a chave de acesso do segredo de credenciais. | cadeia (obrigatório) Restrições: Comprimento mínimo = 1 Valor confidencial. Transmita como um parâmetro seguro. |
ApnsCredential
| Nome | Descrição | Valor |
|---|---|---|
| propriedades | Descrição de um NotificationHub ApnsCredential. | ApnsCredentialProperties (obrigatório) |
ApnsCredentialProperties
| Nome | Descrição | Valor |
|---|---|---|
| apnsCertificate | Obtém ou define o certificado APNS. | string Restrições: Valor confidencial. Transmita como um parâmetro seguro. |
| appId | Obtém ou define a chave de afirmação registada do emissor (iss), cujo valor é o seu ID de Equipa de 10 carateres, obtido a partir da sua conta de programador |
string Restrições: Valor confidencial. Transmita como um parâmetro seguro. |
| appName | Obtém ou define o nome da aplicação | string Restrições: Valor confidencial. Transmita como um parâmetro seguro. |
| certificateKey | Obtém ou define a chave de certificado. | string Restrições: Valor confidencial. Transmita como um parâmetro seguro. |
| endpoint | Obtém ou define o ponto final desta credencial. | cadeia (obrigatório) Restrições: Comprimento mínimo = 1 Valor confidencial. Transmita como um parâmetro seguro. |
| keyId | Obtém ou define uma chave de identificador de chave de 10 carateres (kid), obtida a partir de a sua conta de programador |
string Restrições: Valor confidencial. Transmita como um parâmetro seguro. |
| thumbprint | Obtém ou define o Thumbprint do certificado APNS | string Restrições: Valor confidencial. Transmita como um parâmetro seguro. |
| token | Obtém ou define o Token de Autenticação do fornecedor, obtido através do seu conta de programador |
string Restrições: Valor confidencial. Transmita como um parâmetro seguro. |
BaiduCredential
| Nome | Descrição | Valor |
|---|---|---|
| propriedades | Descrição de um NotificationHub BaiduCredential. | BaiduCredentialProperties (obrigatório) |
BaiduCredentialProperties
| Nome | Descrição | Valor |
|---|---|---|
| baiduApiKey | Obtém ou define a Chave de API do Baidu. | cadeia (obrigatório) Restrições: Comprimento mínimo = 1 Valor confidencial. Transmita como um parâmetro seguro. |
| baiduEndPoint | Obtém ou define o Ponto Final do Baidu. | cadeia (obrigatório) Restrições: Comprimento mínimo = 1 Valor confidencial. Transmita como um parâmetro seguro. |
| baiduSecretKey | Obtém ou define a Chave Secreta do Baidu | cadeia (obrigatório) Restrições: Comprimento mínimo = 1 Valor confidencial. Transmita como um parâmetro seguro. |
BrowserCredential
| Nome | Descrição | Valor |
|---|---|---|
| propriedades | Descrição de um NotificationHub BrowserCredential. | BrowserCredentialProperties (obrigatório) |
BrowserCredentialProperties
| Nome | Descrição | Valor |
|---|---|---|
| subject | Obtém ou define o assunto web push. | cadeia (obrigatório) Restrições: Comprimento mínimo = 1 Valor sensível. Transmita como um parâmetro seguro. |
| vapidPrivateKey | Obtém ou define a chave privada VAPID. | cadeia (obrigatório) Restrições: Comprimento mínimo = 1 Valor sensível. Transmita como um parâmetro seguro. |
| vapidPublicKey | Obtém ou define a chave pública VAPID. | cadeia (obrigatório) Restrições: Comprimento mínimo = 1 Valor sensível. Transmita como um parâmetro seguro. |
FcmV1Credential
| Nome | Descrição | Valor |
|---|---|---|
| propriedades | Descrição de um NotificationHub FcmV1Credential. | FcmV1CredentialProperties (obrigatório) |
FcmV1CredentialProperties
| Nome | Descrição | Valor |
|---|---|---|
| clientEmail | Obtém ou define o e-mail do cliente. | cadeia (obrigatório) Restrições: Comprimento mínimo = 1 Valor sensível. Transmita como um parâmetro seguro. |
| privateKey | Obtém ou define a chave privada. | cadeia (obrigatório) Restrições: Comprimento mínimo = 1 Valor sensível. Transmita como um parâmetro seguro. |
| projectId | Obtém ou define o ID do projeto. | cadeia (obrigatório) Restrições: Comprimento mínimo = 1 Valor sensível. Transmita como um parâmetro seguro. |
GcmCredential
| Nome | Descrição | Valor |
|---|---|---|
| propriedades | Descrição de um NotificationHub GcmCredential. | GcmCredentialProperties (obrigatório) |
GcmCredentialProperties
| Nome | Descrição | Valor |
|---|---|---|
| gcmEndpoint | Obtém ou define o ponto final do GCM. | string Restrições: Valor sensível. Transmita como um parâmetro seguro. |
| googleApiKey | Obtém ou define a chave da API Google. | cadeia (obrigatório) Restrições: Comprimento mínimo = 1 Valor sensível. Transmita como um parâmetro seguro. |
MpnsCredential
| Nome | Descrição | Valor |
|---|---|---|
| propriedades | Descrição de um NotificationHub MpnsCredential. | MpnsCredentialProperties (obrigatório) |
MpnsCredentialProperties
| Nome | Descrição | Valor |
|---|---|---|
| certificateKey | Obtém ou define a chave de certificado para esta credencial. | cadeia (obrigatório) Restrições: Comprimento mínimo = 1 Valor sensível. Transmita como um parâmetro seguro. |
| mpnsCertificate | Obtém ou define o certificado MPNS. | cadeia (obrigatório) Restrições: Comprimento mínimo = 1 Valor confidencial. Transmita como um parâmetro seguro. |
| thumbprint | Obtém ou define o Thumbprint do certificado MPNS | cadeia (obrigatório) Restrições: Comprimento mínimo = 1 Valor confidencial. Transmita como um parâmetro seguro. |
WnsCredential
| Nome | Descrição | Valor |
|---|---|---|
| propriedades | Descrição de um NotificationHub WnsCredential. | WnsCredentialProperties (obrigatório) |
WnsCredentialProperties
| Nome | Descrição | Valor |
|---|---|---|
| certificateKey | Ges ou define a Chave de Certificado WNS. | string Restrições: Valor confidencial. Transmita como um parâmetro seguro. |
| packageSid | Obtém ou define o ID do pacote para esta credencial. | string Restrições: Valor confidencial. Transmita como um parâmetro seguro. |
| secretKey | Obtém ou define a chave secreta. | string Restrições: Valor confidencial. Transmita como um parâmetro seguro. |
| windowsLiveEndpoint | Obtém ou define o ponto final do Windows Live. | string Restrições: Valor confidencial. Transmita como um parâmetro seguro. |
| wnsCertificate | Obtém ou define o Certificado WNS. | string Restrições: Valor confidencial. Transmita como um parâmetro seguro. |
XiaomiCredential
| 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 da aplicação. | string Restrições: Valor confidencial. Transmita como um parâmetro seguro. |
| endpoint | Obtém ou define o ponto final de serviço do Xiaomi. | string Restrições: Valor confidencial. Transmita como um parâmetro seguro. |
Sku
| Nome | Descrição | Valor |
|---|---|---|
| capacidade | Obtém ou define a capacidade do recurso | int |
| família | Obtém ou define a Família de SKU | string |
| name | Nome do SKU do espaço de nomes. | "Básico" 'Gratuito' "Standard" (obrigatório) |
| size | Obtém ou define o tamanho do SKU | string |
| tier | Obtém ou define a camada de um SKU específico | string |
Modelos de início rápido
Os seguintes modelos de início rápido implementam este tipo de recurso.
| Modelo | Description |
|---|---|
| Criar o Hub de Notificação do Azure |
Cria um Hub de Notificação do Azure, um Modelo originalmente criado por John Downs. |
| Aprovisionar uma Aplicação Móvel com um Base de Dados SQL |
Este modelo aprovisiona uma Aplicação Móvel, Base de Dados SQL e Hub de Notificação. Configura uma cadeia de ligação na aplicação móvel para a base de dados e o hub de notificação. |
Definição de recurso terraform (fornecedor AzAPI)
O tipo de recurso de espaços de nomes pode ser implementado com operações que visam:
- Grupos de recursos
Para obter uma lista das propriedades alteradas em cada versão da API, veja Registo de alterações.
Formato do recurso
Para criar um recurso Microsoft.NotificationHubs/namespaces, adicione o seguinte Terraform ao seu modelo.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.NotificationHubs/namespaces@2023-10-01-preview"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
dataCenter = "string"
namespaceType = "string"
networkAcls = {
ipRules = [
{
ipMask = "string"
rights = [
"string"
]
}
]
publicNetworkRule = {
rights = [
"string"
]
}
}
pnsCredentials = {
admCredential = {
properties = {
authTokenUrl = "string"
clientId = "string"
clientSecret = "string"
}
}
apnsCredential = {
properties = {
apnsCertificate = "string"
appId = "string"
appName = "string"
certificateKey = "string"
endpoint = "string"
keyId = "string"
thumbprint = "string"
token = "string"
}
}
baiduCredential = {
properties = {
baiduApiKey = "string"
baiduEndPoint = "string"
baiduSecretKey = "string"
}
}
browserCredential = {
properties = {
subject = "string"
vapidPrivateKey = "string"
vapidPublicKey = "string"
}
}
fcmV1Credential = {
properties = {
clientEmail = "string"
privateKey = "string"
projectId = "string"
}
}
gcmCredential = {
properties = {
gcmEndpoint = "string"
googleApiKey = "string"
}
}
mpnsCredential = {
properties = {
certificateKey = "string"
mpnsCertificate = "string"
thumbprint = "string"
}
}
wnsCredential = {
properties = {
certificateKey = "string"
packageSid = "string"
secretKey = "string"
windowsLiveEndpoint = "string"
wnsCertificate = "string"
}
}
xiaomiCredential = {
properties = {
appSecret = "string"
endpoint = "string"
}
}
}
provisioningState = "string"
publicNetworkAccess = "string"
replicationRegion = "string"
scaleUnit = "string"
status = "string"
zoneRedundancy = "string"
}
sku = {
capacity = int
family = "string"
name = "string"
size = "string"
tier = "string"
}
})
}
Valores de propriedade
espaços de nomes
| Nome | Descrição | Valor |
|---|---|---|
| tipo | O tipo de recurso | "Microsoft.NotificationHubs/namespaces@2023-10-01-preview" |
| name | O nome do recurso | cadeia (obrigatório) Limite de carateres: 6-50 Carateres válidos: Alfanuméricos e hífenes Comece com a letra. Terminar com alfanumérico. O nome do recurso tem de ser exclusivo em todo o Azure. |
| localização | A localização geográfica onde reside o recurso | cadeia (obrigatório) |
| parent_id | Para implementar num grupo de recursos, utilize o ID desse grupo de recursos. | cadeia (obrigatório) |
| etiquetas | Etiquetas de recursos. | Dicionário de nomes e valores de etiquetas. |
| sku | A descrição do SKU para um espaço de nomes | SKU (obrigatório) |
| propriedades | Representa as propriedades do espaço de nomes. | NamespaceProperties |
NamespaceProperties
| Nome | Descrição | Valor |
|---|---|---|
| dataCenter | Preterido. | string |
| namespaceType | Define valores para NamespaceType. | "Mensagens" "NotificationHub" |
| networkAcls | Uma coleção de regras de autorização de rede. | NetworkAcls |
| pnsCredentials | Coleção de credenciais PNS do Hub de Notificação ou do Espaço de Nomes do Hub de Notificação. | PnsCredentials |
| provisioningState | Define valores para OperationProvisioningState. | "Cancelado" "Desativado" "Falhou" "Entrada" "Pendente" "Com êxito" "Desconhecido" |
| publicNetworkAccess | Tipo de acesso à rede pública. | "Desativado" "Ativado" |
| replicationRegion | Região de replicação permitida | "AustraliaEast" "BrazilSouth" "Predefinição" "Nenhum" "NorthEurope" "SouthAfricaNorth" "Sudeste Asiático" "WestUs2" |
| scaleUnit | Obtém ou define scaleUnit onde o espaço de nomes é criado | string |
| status | Estado do espaço de nomes. | "Criado" "A criar" "A eliminar" "Suspenso" |
| zoneRedundancy | Nome do SKU do espaço de nomes. | "Desativado" "Ativado" |
NetworkAcls
| Nome | Descrição | Valor |
|---|---|---|
| ipRules | Lista de regras de IP. | IpRule[] |
| publicNetworkRule | Uma regra de autorização de rede predefinida (Internet pública), que contém direitos se nenhuma outra regra de rede corresponder. | PublicInternetAuthorizationRule |
IpRule
| Nome | Descrição | Valor |
|---|---|---|
| ipMask | Máscara de IP. | cadeia (obrigatório) Restrições: Comprimento mínimo = 1 |
| direitos | Lista de direitos de acesso. | Matriz de cadeias que contém qualquer um dos seguintes: "Ouvir" "Gerir" "Enviar" (obrigatório) |
PublicInternetAuthorizationRule
| Nome | Descrição | Valor |
|---|---|---|
| direitos | Lista de direitos de acesso. | Matriz de cadeias que contém qualquer um dos seguintes: "Ouvir" "Gerir" "Enviar" (obrigatório) |
PnsCredentials
| Nome | Descrição | Valor |
|---|---|---|
| admCredential | Descrição de um NotificationHub AdmCredential. | AdmCredential |
| apnsCredential | Descrição de um NotificationHub ApnsCredential. | ApnsCredential |
| baiduCredential | Descrição de um NotificationHub BaiduCredential. | BaiduCredential |
| browserCredential | Descrição de um NotificationHub BrowserCredential. | BrowserCredential |
| fcmV1Credential | Descrição de um NotificationHub FcmV1Credential. | FcmV1Credential |
| gcmCredential | Descrição de um NotificationHub GcmCredential. | GcmCredential |
| mpnsCredential | Descrição de um NotificationHub MpnsCredential. | MpnsCredential |
| wnsCredential | Descrição de um NotificationHub WnsCredential. | WnsCredential |
| xiaomiCredential | Descrição de um NotificationHub XiaomiCredential. | XiaomiCredential |
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 o URL do token de autorização. | cadeia (obrigatório) Restrições: Comprimento mínimo = 1 Valor sensível. Transmita como um parâmetro seguro. |
| clientId | Obtém ou define o identificador de cliente. | cadeia (obrigatório) Restrições: Comprimento mínimo = 1 Valor sensível. Transmita como um parâmetro seguro. |
| clientSecret | Obtém ou define a chave de acesso de segredo de credenciais. | cadeia (obrigatório) Restrições: Comprimento mínimo = 1 Valor sensível. Transmita como um parâmetro seguro. |
ApnsCredential
| Nome | Descrição | Valor |
|---|---|---|
| propriedades | Descrição de um NotificationHub ApnsCredential. | ApnsCredentialProperties (obrigatório) |
ApnsCredentialProperties
| Nome | Descrição | Valor |
|---|---|---|
| apnsCertificate | Obtém ou define o certificado APNS. | string Restrições: Valor sensível. Transmita como um parâmetro seguro. |
| appId | Obtém ou define a chave de afirmação registada do emissor (iss), cujo valor é o seu ID de Equipa de 10 carateres, obtido a partir da sua conta de programador |
string Restrições: Valor sensível. Transmita como um parâmetro seguro. |
| appName | Obtém ou define o nome da aplicação | string Restrições: Valor sensível. Transmita como um parâmetro seguro. |
| certificateKey | Obtém ou define a chave de certificado. | string Restrições: Valor sensível. Transmita como um parâmetro seguro. |
| endpoint | Obtém ou define o ponto final desta credencial. | cadeia (obrigatório) Restrições: Comprimento mínimo = 1 Valor sensível. Transmita como um parâmetro seguro. |
| keyId | Obtém ou define uma chave de identificador de chave de 10 carateres (criança), obtida a partir de a sua conta de programador |
string Restrições: Valor sensível. Transmita como um parâmetro seguro. |
| thumbprint | Obtém ou define o Thumbprint do certificado APNS | string Restrições: Valor sensível. Transmita como um parâmetro seguro. |
| token | Obtém ou define o Token de Autenticação do fornecedor, obtido através do seu conta de programador |
string Restrições: Valor sensível. Transmita como um parâmetro seguro. |
BaiduCredential
| Nome | Descrição | Valor |
|---|---|---|
| propriedades | Descrição de um NotificationHub BaiduCredential. | BaiduCredentialProperties (obrigatório) |
BaiduCredentialProperties
| Nome | Descrição | Valor |
|---|---|---|
| baiduApiKey | Obtém ou define a Chave de API baidu. | cadeia (obrigatório) Restrições: Comprimento mínimo = 1 Valor sensível. Transmita como um parâmetro seguro. |
| baiduEndPoint | Obtém ou define o Ponto Final do baidu. | cadeia (obrigatório) Restrições: Comprimento mínimo = 1 Valor sensível. Transmita como um parâmetro seguro. |
| baiduSecretKey | Obtém ou define a Chave Secreta do Baidu | cadeia (obrigatório) Restrições: Comprimento mínimo = 1 Valor sensível. Transmita como um parâmetro seguro. |
BrowserCredential
| Nome | Descrição | Valor |
|---|---|---|
| propriedades | Descrição de um NotificationHub BrowserCredential. | BrowserCredentialProperties (obrigatório) |
BrowserCredentialProperties
| Nome | Descrição | Valor |
|---|---|---|
| subject | Obtém ou define o assunto web push. | cadeia (obrigatório) Restrições: Comprimento mínimo = 1 Valor sensível. Transmita como um parâmetro seguro. |
| vapidPrivateKey | Obtém ou define a chave privada VAPID. | cadeia (obrigatório) Restrições: Comprimento mínimo = 1 Valor sensível. Transmita como um parâmetro seguro. |
| vapidPublicKey | Obtém ou define a chave pública VAPID. | cadeia (obrigatório) Restrições: Comprimento mínimo = 1 Valor sensível. Transmita como um parâmetro seguro. |
FcmV1Credential
| Nome | Descrição | Valor |
|---|---|---|
| propriedades | Descrição de um NotificationHub FcmV1Credential. | FcmV1CredentialProperties (obrigatório) |
FcmV1CredentialProperties
| Nome | Descrição | Valor |
|---|---|---|
| clientEmail | Obtém ou define o e-mail do cliente. | cadeia (obrigatório) Restrições: Comprimento mínimo = 1 Valor sensível. Transmita como um parâmetro seguro. |
| privateKey | Obtém ou define a chave privada. | cadeia (obrigatório) Restrições: Comprimento mínimo = 1 Valor sensível. Transmita como um parâmetro seguro. |
| projectId | Obtém ou define o ID do projeto. | cadeia (obrigatório) Restrições: Comprimento mínimo = 1 Valor sensível. Transmita como um parâmetro seguro. |
GcmCredential
| Nome | Descrição | Valor |
|---|---|---|
| propriedades | Descrição de um NotificationHub GcmCredential. | GcmCredentialProperties (obrigatório) |
GcmCredentialProperties
| Nome | Descrição | Valor |
|---|---|---|
| gcmEndpoint | Obtém ou define o ponto final do GCM. | string Restrições: Valor sensível. Transmita como um parâmetro seguro. |
| googleApiKey | Obtém ou define a chave da API Google. | cadeia (obrigatório) Restrições: Comprimento mínimo = 1 Valor sensível. Transmita como um parâmetro seguro. |
MpnsCredential
| Nome | Descrição | Valor |
|---|---|---|
| propriedades | Descrição de um NotificationHub MpnsCredential. | MpnsCredentialProperties (obrigatório) |
MpnsCredentialProperties
| Nome | Descrição | Valor |
|---|---|---|
| certificateKey | Obtém ou define a chave de certificado para esta credencial. | cadeia (obrigatório) Restrições: Comprimento mínimo = 1 Valor sensível. Transmita como um parâmetro seguro. |
| mpnsCertificate | Obtém ou define o certificado MPNS. | cadeia (obrigatório) Restrições: Comprimento mínimo = 1 Valor sensível. Transmita como um parâmetro seguro. |
| thumbprint | Obtém ou define o Thumbprint do certificado MPNS | cadeia (obrigatório) Restrições: Comprimento mínimo = 1 Valor sensível. Transmita como um parâmetro seguro. |
WnsCredential
| Nome | Descrição | Valor |
|---|---|---|
| propriedades | Descrição de um NotificationHub WnsCredential. | WnsCredentialProperties (obrigatório) |
WnsCredentialProperties
| Nome | Descrição | Valor |
|---|---|---|
| certificateKey | Ges ou define a Chave de Certificado WNS. | string Restrições: Valor sensível. Transmita como um parâmetro seguro. |
| packageSid | Obtém ou define o ID do pacote para esta credencial. | string Restrições: Valor sensível. Transmita como um parâmetro seguro. |
| secretKey | Obtém ou define a chave secreta. | string Restrições: Valor sensível. Transmita como um parâmetro seguro. |
| windowsLiveEndpoint | Obtém ou define o ponto final do Windows Live. | string Restrições: Valor sensível. Transmita como um parâmetro seguro. |
| wnsCertificate | Obtém ou define o Certificado WNS. | string Restrições: Valor sensível. Transmita como um parâmetro seguro. |
XiaomiCredential
| 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 da aplicação. | string Restrições: Valor sensível. Transmita como um parâmetro seguro. |
| endpoint | Obtém ou define o ponto final de serviço da Xiaomi. | string Restrições: Valor sensível. Transmita como um parâmetro seguro. |
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 | string |
| name | Nome do SKU do espaço de nomes. | "Básico" "Gratuito" "Standard" (obrigatório) |
| size | Obtém ou define o tamanho do Sku | string |
| tier | Obtém ou define a camada de sku específico | string |
Comentários
Brevemente: Ao longo de 2024, vamos descontinuar progressivamente o GitHub Issues como mecanismo de feedback para conteúdos e substituí-lo por um novo sistema de feedback. Para obter mais informações, veja: https://aka.ms/ContentUserFeedback.
Submeter e ver comentários