Notification Hubs - Create Or Update

Referência

Service:: Notification Hubs

API Version:: 2023-10-01-preview

Cria/atualiza um NotificationHub em um namespace.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}?api-version=2023-10-01-preview

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
namespaceName	path	True	string	Nome do Namespace Regex pattern: `^[a-zA-Z][a-zA-Z0-9-]*$`
notificationHubName	path	True	string	Nome do hub de notificação Regex pattern: `^[a-zA-Z][a-zA-Z0-9-./_]*$`
resourceGroupName	path	True	string	O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string uuid	A ID da assinatura de destino. O valor deve ser um UUID.
api-version	query	True	string	A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
location	True	string	A localização geográfica em que o recurso reside
properties.admCredential		AdmCredential	Descrição de um NotificationHub AdmCredential.
properties.apnsCredential		ApnsCredential	Descrição de um ApnsCredential do NotificationHub.
properties.baiduCredential		BaiduCredential	Descrição de um BaiduCredential do NotificationHub.
properties.browserCredential		BrowserCredential	Descrição de um NotificationHub BrowserCredential.
properties.fcmV1Credential		FcmV1Credential	Descrição de um NotificationHub FcmV1Credential.
properties.gcmCredential		GcmCredential	Descrição de um NotificationHub GcmCredential.
properties.mpnsCredential		MpnsCredential	Descrição de um MpnsCredential do NotificationHub.
properties.name		string	Obtém ou define o nome do NotificationHub.
properties.registrationTtl		string	Obtém ou define o RegistrationTtl do NotificationHub criado
properties.wnsCredential		WnsCredential	Descrição de um WnsCredential do NotificationHub.
properties.xiaomiCredential		XiaomiCredential	Descrição de um NotificationHub XiaomiCredential.
sku		Sku	A descrição do SKU para um namespace
tags		object	Marcas de recurso.

Respostas

Nome	Tipo	Description
200 OK	NotificationHubResource	Atualizado
201 Created	NotificationHubResource	Criado
Other Status Codes	ErrorResponse	Código de erro com motivo.

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

NotificationHubs_CreateOrUpdate

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/5ktrial/providers/Microsoft.NotificationHubs/namespaces/nh-sdk-ns/notificationHubs/nh-sdk-hub?api-version=2023-10-01-preview

{
  "location": "eastus",
  "properties": {}
}

Sample Response

Status code:: 200

{
  "location": "East US",
  "properties": {
    "name": "test",
    "registrationTtl": "10675199.02:48:05.4775807",
    "dailyMaxActiveDevices": 0
  },
  "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/5ktrial/providers/Microsoft.NotificationHubs/namespaces/nh-sdk-ns/notificationHubs/test",
  "name": "test",
  "type": "Microsoft.NotificationHubs/namespaces/notificationHubs",
  "tags": {
    "hubTag1": "hubTagValue1",
    "hubTag2": "hubTagValue2"
  }
}

Status code:: 201

{
  "location": "East US",
  "properties": {
    "name": "test",
    "registrationTtl": "10675199.02:48:05.4775807",
    "dailyMaxActiveDevices": 0
  },
  "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/5ktrial/providers/Microsoft.NotificationHubs/namespaces/nh-sdk-ns/notificationHubs/test",
  "name": "test",
  "type": "Microsoft.NotificationHubs/namespaces/notificationHubs",
  "tags": {
    "hubTag1": "hubTagValue1",
    "hubTag2": "hubTagValue2"
  }
}

Definições

Nome	Description
AccessRights	Define valores para AccessRights.
AdmCredential	Descrição de um NotificationHub AdmCredential.
ApnsCredential	Descrição de um ApnsCredential do NotificationHub.
BaiduCredential	Descrição de um BaiduCredential do NotificationHub.
BrowserCredential	Descrição de um NotificationHub BrowserCredential.
createdByType	O tipo de identidade que criou o recurso.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
FcmV1Credential	Descrição de um NotificationHub FcmV1Credential.
GcmCredential	Descrição de um NotificationHub GcmCredential.
MpnsCredential	Descrição de um MpnsCredential do NotificationHub.
NotificationHubResource	Recurso do Hub de Notificação.
SharedAccessAuthorizationRuleProperties	Propriedades SharedAccessAuthorizationRule.
Sku	A descrição do SKU para um namespace
SkuName	Nome do SKU do namespace.
systemData	Metadados relativos à criação e à última modificação do recurso.
WnsCredential	Descrição de um WnsCredential do NotificationHub.
XiaomiCredential	Descrição de um NotificationHub XiaomiCredential.

AccessRights

Define valores para AccessRights.

Nome	Tipo	Description
Listen	string
Manage	string
Send	string

AdmCredential

Descrição de um NotificationHub AdmCredential.

Nome	Tipo	Description
properties.authTokenUrl	string	Obtém ou define a URL do token de autorização.
properties.clientId	string	Obtém ou define o identificador do cliente.
properties.clientSecret	string	Obtém ou define a chave de acesso secreta de credencial.

ApnsCredential

Descrição de um ApnsCredential do NotificationHub.

Nome	Tipo	Description
properties.apnsCertificate	string	Obtém ou define o certificado APNS.
properties.appId	string	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
properties.appName	string	Obtém ou define o nome do aplicativo
properties.certificateKey	string	Obtém ou define a chave de certificado.
properties.endpoint	string	Obtém ou define o ponto de extremidade dessa credencial.
properties.keyId	string	Obtém ou define uma chave de identificador de chave de 10 caracteres (kid), obtida de sua conta de desenvolvedor
properties.thumbprint	string	Obtém ou define a impressão digital do certificado APNS
properties.token	string	Obtém ou define o token de autenticação do provedor, obtido por meio de sua conta de desenvolvedor

BaiduCredential

Descrição de um BaiduCredential do NotificationHub.

Nome	Tipo	Description
properties.baiduApiKey	string	Obtém ou define a Chave de API baidu.
properties.baiduEndPoint	string	Obtém ou define o ponto de extremidade baidu.
properties.baiduSecretKey	string	Obtém ou define a chave secreta baidu

BrowserCredential

Descrição de um NotificationHub BrowserCredential.

Nome	Tipo	Description
properties.subject	string	Obtém ou define o assunto de push da Web.
properties.vapidPrivateKey	string	Obtém ou define a chave privada VAPID.
properties.vapidPublicKey	string	Obtém ou define a chave pública VAPID.

createdByType

O tipo de identidade que criou o recurso.

Nome	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

FcmV1Credential

Descrição de um NotificationHub FcmV1Credential.

Nome	Tipo	Description
properties.clientEmail	string	Obtém ou define o email do cliente.
properties.privateKey	string	Obtém ou define a chave privada.
properties.projectId	string	Obtém ou define a ID do projeto.

GcmCredential

Descrição de um NotificationHub GcmCredential.

Nome	Tipo	Description
properties.gcmEndpoint	string	Obtém ou define o ponto de extremidade GCM.
properties.googleApiKey	string	Obtém ou define a chave de API do Google.

MpnsCredential

Descrição de um MpnsCredential do NotificationHub.

Nome	Tipo	Description
properties.certificateKey	string	Obtém ou define a chave de certificado para essa credencial.
properties.mpnsCertificate	string	Obtém ou define o certificado MPNS.
properties.thumbprint	string	Obtém ou define a impressão digital do certificado MPNS

NotificationHubResource

Recurso do Hub de Notificação.

Nome	Tipo	Description
id	string	ID de recurso totalmente qualificada para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string	A localização geográfica em que o recurso reside
name	string	O nome do recurso
properties.admCredential	AdmCredential	Descrição de um NotificationHub AdmCredential.
properties.apnsCredential	ApnsCredential	Descrição de um ApnsCredential do NotificationHub.
properties.authorizationRules	SharedAccessAuthorizationRuleProperties[]	Obtém ou define as AuthorizationRules do NotificationHub criado
properties.baiduCredential	BaiduCredential	Descrição de um BaiduCredential do NotificationHub.
properties.browserCredential	BrowserCredential	Descrição de um NotificationHub BrowserCredential.
properties.dailyMaxActiveDevices	integer
properties.fcmV1Credential	FcmV1Credential	Descrição de um NotificationHub FcmV1Credential.
properties.gcmCredential	GcmCredential	Descrição de um NotificationHub GcmCredential.
properties.mpnsCredential	MpnsCredential	Descrição de um MpnsCredential do NotificationHub.
properties.name	string	Obtém ou define o nome do NotificationHub.
properties.registrationTtl	string	Obtém ou define o RegistrationTtl do NotificationHub criado
properties.wnsCredential	WnsCredential	Descrição de um WnsCredential do NotificationHub.
properties.xiaomiCredential	XiaomiCredential	Descrição de um NotificationHub XiaomiCredential.
sku	Sku	A descrição do SKU para um namespace
systemData	systemData	Os metadados do Azure Resource Manager que contêm as informações createdBy e modifiedBy.
tags	object	Marcas de recurso.
type	string	Tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

SharedAccessAuthorizationRuleProperties

Propriedades SharedAccessAuthorizationRule.

Nome	Tipo	Description
claimType	string	Obtém uma cadeia de caracteres que descreve o tipo de declaração
claimValue	string	Obtém uma cadeia de caracteres que descreve o valor da declaração
createdTime	string	Obtém o tempo criado para essa regra
keyName	string	Obtém uma cadeia de caracteres que descreve a regra de autorização.
modifiedTime	string	Obtém a hora da última modificação para essa regra
primaryKey	string	Obtém uma chave primária de 256 bits codificada em base64 para assinar e validar o token SAS.
revision	integer	Obtém o número de revisão da regra
rights	AccessRights[]	Obtém ou define os direitos associados à regra.
secondaryKey	string	Obtém uma chave primária de 256 bits codificada em base64 para assinar e validar o token SAS.

Sku

A descrição do SKU para um namespace

Nome	Tipo	Description
capacity	integer	Obtém ou define a capacidade do recurso
family	string	Obtém ou define a família Sku
name	SkuName	Nome do SKU do namespace.
size	string	Obtém ou define o tamanho do Sku
tier	string	Obtém ou define a camada de sku específica

SkuName

Nome do SKU do namespace.

Nome	Tipo	Description
Basic	string
Free	string
Standard	string

systemData

Metadados relativos à criação e à última modificação do recurso.

Nome	Tipo	Description
createdAt	string	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

WnsCredential

Descrição de um WnsCredential do NotificationHub.

Nome	Tipo	Description
properties.certificateKey	string	Ges ou define a Chave de Certificado WNS.
properties.packageSid	string	Obtém ou define a ID do pacote para essa credencial.
properties.secretKey	string	Obtém ou define a chave secreta.
properties.windowsLiveEndpoint	string	Obtém ou define o ponto de extremidade do Windows Live.
properties.wnsCertificate	string	Obtém ou define o Certificado WNS.

XiaomiCredential

Descrição de um NotificationHub XiaomiCredential.

Nome	Tipo	Description
properties.appSecret	string	Obtém ou define o segredo do aplicativo.
properties.endpoint	string	Obtém ou define o ponto de extremidade de serviço da Xiaomi.

Share via