Microsoft.SignalRService webPubSub 2021-09-01-preview
Définition de ressource Bicep
Le type de ressource webPubSub peut être déployé avec des opérations qui ciblent :
- Groupes de ressources - Voir commandes de déploiement de groupe de ressources
Pour obtenir la liste des propriétés modifiées dans chaque version d’API, consultez journal des modifications.
Format des ressources
Pour créer une ressource Microsoft.SignalRService/webPubSub, ajoutez le Bicep suivant à votre modèle.
resource symbolicname 'Microsoft.SignalRService/webPubSub@2021-09-01-preview' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
sku: {
capacity: int
name: 'string'
tier: 'string'
}
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
properties: {
disableAadAuth: bool
disableLocalAuth: bool
eventHandler: {
items: {
{customized property}: [
{
auth: {
managedIdentity: {
resource: 'string'
}
type: 'string'
}
systemEventPattern: 'string'
urlTemplate: 'string'
userEventPattern: 'string'
}
]
}
}
liveTraceConfiguration: {
categories: [
{
enabled: 'string'
name: 'string'
}
]
enabled: 'string'
}
networkACLs: {
defaultAction: 'string'
privateEndpoints: [
{
allow: [
'string'
]
deny: [
'string'
]
name: 'string'
}
]
publicNetwork: {
allow: [
'string'
]
deny: [
'string'
]
}
}
publicNetworkAccess: 'string'
tls: {
clientCertEnabled: bool
}
}
}
Valeurs de propriétés
webPubSub
| Nom | Description | Valeur |
|---|---|---|
| name | Nom de la ressource | string (obligatoire) |
| location | Emplacement GEO de la ressource. Par exemple, USA Ouest , USA Est , USA Centre Nord , USA Centre Sud. | string |
| tags | Balises du service, qui est une liste de paires clé-valeur qui décrivent la ressource. | Dictionnaire de noms et de valeurs d’étiquettes. Voir Balises dans les modèles |
| sku | Informations de facturation de la ressource. (par exemple, Gratuit, Standard) | ResourceSku |
| identité | Réponse de l’identité managée | ManagedIdentity |
| properties | Paramètres utilisés pour provisionner ou configurer la ressource | WebPubSubProperties |
ManagedIdentity
| Nom | Description | Valeur |
|---|---|---|
| type | Représenter le type d’identité : systemAssigned, userAssigned, None | 'None' 'SystemAssigned' 'UserAssigned' |
| userAssignedIdentities | Obtenir ou définir les identités affectées par l’utilisateur | ManagedIdentityUserAssignedIdentities |
ManagedIdentityUserAssignedIdentities
| Nom | Description | Valeur |
|---|---|---|
| {propriété personnalisée} | UserAssignedIdentityProperty |
UserAssignedIdentityProperty
Cet objet ne contient aucune propriété à définir pendant le déploiement. Toutes les propriétés sont ReadOnly.
WebPubSubProperties
| Nom | Description | Valeur |
|---|---|---|
| disableAadAuth | DisableLocalAuth Activer ou désactiver l’authentification aad Lorsque la valeur est true, la connexion avec AuthType=aad ne fonctionne pas. |
bool |
| disableLocalAuth | DisableLocalAuth Activer ou désactiver l’authentification locale avec AccessKey Lorsque la valeur est true, la connexion avec AccessKey=xxx ne fonctionne pas. |
bool |
| Eventhandler | Paramètres du gestionnaire d’événements dans le service webpubsub. | EventHandlerSettings |
| liveTraceConfiguration | Configuration de trace dynamique d’une ressource Microsoft.SignalRService. | LiveTraceConfiguration |
| networkACLs | Listes de contrôle d'accès réseau | WebPubSubNetworkACLs |
| publicNetworkAccess | Activer ou désactiver l’accès au réseau public. La valeur par défaut est « Enabled ». Quand elle est activée, les listes de contrôle d’accès réseau s’appliquent toujours. Lorsqu’il est désactivé, l’accès au réseau public est toujours désactivé, quel que soit ce que vous définissez dans les listes de contrôle d’accès réseau. |
string |
| Tls | Paramètres TLS. | WebPubSubTlsSettings |
EventHandlerSettings
| Nom | Description | Valeur |
|---|---|---|
| items | Obtenez ou définissez les éléments EventHandler. La clé est le nom du hub et la valeur est l’EventHandlerTemplate correspondant. | EventHandlerSettingsItems |
EventHandlerSettingsItems
| Nom | Description | Valeur |
|---|---|---|
| {propriété personnalisée} | EventHandlerTemplate[] |
EventHandlerTemplate
| Nom | Description | Valeur |
|---|---|---|
| auth | Obtient ou définit les paramètres d’authentification pour un gestionnaire d’événements. S’il n’est pas défini, aucune authentification n’est utilisée. | AmontAuthSettings |
| systemEventPattern | Obtient ot définit le modèle d’événement système. Il existe 2 types de modèles pris en charge : 1. Nom d’événement unique, par exemple, « connect », il correspond à « connect » 2. Combinez plusieurs événements avec « , », par exemple « connect, déconnecté », il correspond à l’événement « connect » et « déconnecté » |
string |
| urlTemplate | Obtient ou définit le modèle d’URL EventHandler. Vous pouvez utiliser un paramètre prédéfini {hub} et {event} à l’intérieur du modèle. La valeur de l’URL EventHandler est calculée dynamiquement lorsque la demande du client arrive. Par exemple, UrlTemplate peut être http://example.com/api/{hub}/{event}. La partie hôte ne peut pas contenir de paramètres. |
chaîne (obligatoire) |
| userEventPattern | Obtient ou définit le modèle correspondant pour les noms d’événements. Il existe 3 types de modèles pris en charge : 1. « * », il correspond à n’importe quel nom d’événement 2. Combiner plusieurs événements avec « , », par exemple « event1,event2 », il correspond à l’événement « event1 » et « event2 » 3. Nom d’événement unique, par exemple, « event1 », il correspond à « event1 » |
string |
AmontAuthSettings
| Nom | Description | Valeur |
|---|---|---|
| managedIdentity | Obtient ou définit les paramètres d’identité managée. Elle est requise si le type d’authentification est défini sur ManagedIdentity. | ManagedIdentitySettings |
| type | Obtient ou définit le type d’authentification. None ou ManagedIdentity est désormais pris en charge. | 'ManagedIdentity' 'None' |
ManagedIdentitySettings
| Nom | Description | Valeur |
|---|---|---|
| resource | Ressource indiquant l’URI d’ID d’application de la ressource cible. Il apparaît également dans la revendication aud (audience) du jeton émis. |
string |
LiveTraceConfiguration
| Nom | Description | Valeur |
|---|---|---|
| categories | Obtient ou définit la liste des configurations de catégorie. | LiveTraceCategory[] |
| enabled | Indique si ou non activer la trace dynamique. Lorsqu’il est défini sur true, le client de trace dynamique peut se connecter au service. Sinon, le client de suivi dynamique ne peut pas se connecter au service, de sorte que vous ne pouvez pas recevoir de journal, quelle que soit la configuration que vous configurez dans les « catégories ». Valeurs disponibles : true, false. Ne respecte pas la casse. |
string |
LiveTraceCategory
| Nom | Description | Valeur |
|---|---|---|
| enabled | Indique si ou la catégorie de journal est activée. Valeurs disponibles : true, false. Ne respecte pas la casse. |
string |
| name | Obtient ou définit le nom de la catégorie de journal. Valeurs disponibles : ConnectivityLogs, MessagingLogs. Ne respecte pas la casse. |
string |
WebPubSubNetworkACLs
| Nom | Description | Valeur |
|---|---|---|
| defaultAction | Action par défaut lorsqu’aucune autre règle ne correspond | 'Autoriser' 'Deny' |
| privateEndpoints | Listes de contrôle d’accès pour les requêtes provenant de points de terminaison privés | PrivateEndpointACL[] |
| publicNetwork | Liste de contrôle d’accès pour les requêtes provenant d’un réseau public | NetworkACL |
PrivateEndpointACL
| Nom | Description | Valeur |
|---|---|---|
| allow | Types de requêtes autorisés. La valeur peut être un ou plusieurs des éléments suivants : ClientConnection, ServerConnection, RESTAPI. | Tableau de chaînes contenant l’un des éléments suivants : 'ClientConnection' 'RESTAPI' 'ServerConnection' 'Trace' |
| deny | Types de demandes refusées. La valeur peut être un ou plusieurs des éléments suivants : ClientConnection, ServerConnection, RESTAPI. | Tableau de chaînes contenant l’un des éléments suivants : 'ClientConnection' 'RESTAPI' 'ServerConnection' 'Trace' |
| name | Nom de la connexion de point de terminaison privé | chaîne (obligatoire) |
NetworkACL
| Nom | Description | Valeur |
|---|---|---|
| allow | Types de requêtes autorisés. La valeur peut être un ou plusieurs des éléments suivants : ClientConnection, ServerConnection, RESTAPI. | Tableau de chaînes contenant l’un des éléments suivants : 'ClientConnection' 'RESTAPI' 'ServerConnection' 'Trace' |
| deny | Types de demandes refusées. La valeur peut être un ou plusieurs des éléments suivants : ClientConnection, ServerConnection, RESTAPI. | Tableau de chaînes contenant l’un des éléments suivants : 'ClientConnection' 'RESTAPI' 'ServerConnection' 'Trace' |
WebPubSubTlsSettings
| Nom | Description | Valeur |
|---|---|---|
| clientCertEnabled | Demander un certificat client pendant la négociation TLS si cette option est activée | bool |
ResourceSku
| Nom | Description | Valeur |
|---|---|---|
| capacité | Facultatif, entier. Nombre d’unités de la ressource. 1 par défaut. Le cas échéant, les valeurs suivantes sont autorisées : Gratuit : 1 Standard : 1,2,5,10,20,50,100 |
int |
| name | Nom de la référence SKU. Obligatoire. Valeurs autorisées : Standard_S1, Free_F1 |
chaîne (obligatoire) |
| Niveau | Niveau facultatif de cette référence SKU particulière. 'Standard' ou 'Free'. Basic est déconseillé, utilisez Standard à la place. |
'De base' 'Gratuit' 'Premium' 'Standard' |
Modèles de démarrage rapide
Les modèles de démarrage rapide suivants déploient ce type de ressource.
| Modèle | Description |
|---|---|
Créer Azure Web PubSub à l’aide de Bicep |
Azure Web PubSub Service vous aide à créer des applications web de messagerie en temps réel à l’aide de WebSockets et du modèle de publication-abonnement. Cela utilise le langage Bicep pour créer et configurer une ressource Web PubSub. Vous pouvez utiliser ce modèle pour déployer facilement Web PubSub pour un didacticiel ou un test, ou comme bloc de construction pour des déploiements plus complexes avec Web PubSub. |
Définition de ressources de modèle ARM
Le type de ressource webPubSub peut être déployé avec des opérations qui ciblent :
- Groupes de ressources - Voir commandes de déploiement de groupes de ressources
Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.
Format des ressources
Pour créer une ressource Microsoft.SignalRService/webPubSub, ajoutez le json suivant à votre modèle.
{
"type": "Microsoft.SignalRService/webPubSub",
"apiVersion": "2021-09-01-preview",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"sku": {
"capacity": "int",
"name": "string",
"tier": "string"
},
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {}
}
},
"properties": {
"disableAadAuth": "bool",
"disableLocalAuth": "bool",
"eventHandler": {
"items": {
"{customized property}": [
{
"auth": {
"managedIdentity": {
"resource": "string"
},
"type": "string"
},
"systemEventPattern": "string",
"urlTemplate": "string",
"userEventPattern": "string"
}
]
}
},
"liveTraceConfiguration": {
"categories": [
{
"enabled": "string",
"name": "string"
}
],
"enabled": "string"
},
"networkACLs": {
"defaultAction": "string",
"privateEndpoints": [
{
"allow": [ "string" ],
"deny": [ "string" ],
"name": "string"
}
],
"publicNetwork": {
"allow": [ "string" ],
"deny": [ "string" ]
}
},
"publicNetworkAccess": "string",
"tls": {
"clientCertEnabled": "bool"
}
}
}
Valeurs de propriétés
webPubSub
| Nom | Description | Valeur |
|---|---|---|
| type | Type de ressource | « Microsoft.SignalRService/webPubSub » |
| apiVersion | Version de l’API de ressource | « 2021-09-01-preview » |
| name | Nom de la ressource | chaîne (obligatoire) |
| location | Emplacement GEO de la ressource. par exemple, USA Ouest, USA Est, USA Centre Nord, USA Centre Sud. | string |
| tags | Étiquettes du service, qui est une liste de paires de valeurs de clé qui décrivent la ressource. | Dictionnaire de noms et de valeurs d’étiquettes. Voir Balises dans les modèles |
| sku | Informations de facturation de la ressource. (par exemple, Gratuit, Standard) | ResourceSku |
| identité | Réponse d’identité managée | ManagedIdentity |
| properties | Paramètres utilisés pour approvisionner ou configurer la ressource | WebPubSubProperties |
ManagedIdentity
| Nom | Description | Valeur |
|---|---|---|
| type | Représenter le type d’identité : systemAssigned, userAssigned, None | 'None' 'SystemAssigned' 'UserAssigned' |
| userAssignedIdentities | Obtenir ou définir les identités affectées par l’utilisateur | ManagedIdentityUserAssignedIdentities |
ManagedIdentityUserAssignedIdentities
| Nom | Description | Valeur |
|---|---|---|
| {propriété personnalisée} | UserAssignedIdentityProperty |
UserAssignedIdentityProperty
Cet objet ne contient aucune propriété à définir pendant le déploiement. Toutes les propriétés sont ReadOnly.
WebPubSubProperties
| Nom | Description | Valeur |
|---|---|---|
| disableAadAuth | DésactiverLocalAuth Activer ou désactiver l’authentification aad Lorsque la valeur est true, la connexion à AuthType=aad ne fonctionne pas. |
bool |
| disableLocalAuth | DésactiverLocalAuth Activer ou désactiver l’authentification locale avec AccessKey Lorsque la valeur est true, la connexion à AccessKey=xxx ne fonctionne pas. |
bool |
| Eventhandler | Paramètres du gestionnaire d’événements dans le service webpubsub. | EventHandlerSettings |
| liveTraceConfiguration | Configuration de trace dynamique d’une ressource Microsoft.SignalRService. | LiveTraceConfiguration |
| networkACLs | Listes de contrôle d'accès réseau | WebPubSubNetworkACLs |
| publicNetworkAccess | Activez ou désactivez l’accès au réseau public. La valeur par défaut est « Enabled ». Lorsqu’elle est activée, les listes de contrôle d’accès réseau s’appliquent toujours. Lorsqu’il est désactivé, l’accès au réseau public est toujours désactivé, quel que soit ce que vous définissez dans les listes de contrôle d’accès réseau. |
string |
| Tls | Paramètres TLS. | WebPubSubTlsSettings |
EventHandlerSettings
| Nom | Description | Valeur |
|---|---|---|
| items | Obtenez ou définissez les éléments EventHandler. La clé est le nom du hub et la valeur est l’EventHandlerTemplate correspondant. | EventHandlerSettingsItems |
EventHandlerSettingsItems
| Nom | Description | Valeur |
|---|---|---|
| {propriété personnalisée} | EventHandlerTemplate[] |
EventHandlerTemplate
| Nom | Description | Valeur |
|---|---|---|
| auth | Obtient ou définit les paramètres d’authentification pour un gestionnaire d’événements. S’il n’est pas défini, aucune authentification n’est utilisée. | AmontAuthSettings |
| systemEventPattern | Obtient ot définit le modèle d’événement système. Il existe 2 types de modèles pris en charge : 1. Nom d’événement unique, par exemple, « connect », il correspond à « connect » 2. Combinez plusieurs événements avec « , », par exemple « connect, disconnected », il correspond à l’événement « connect » et « disconnected » |
string |
| urlTemplate | Obtient ou définit le modèle d’URL eventHandler. Vous pouvez utiliser un paramètre prédéfini {hub} et {event} dans le modèle. La valeur de l’URL eventHandler est calculée dynamiquement lorsque la demande du client arrive. Par exemple, UrlTemplate peut être http://example.com/api/{hub}/{event}. La partie hôte ne peut pas contenir de paramètres. |
string (obligatoire) |
| userEventPattern | Obtient ou définit le modèle correspondant pour les noms d’événements. Trois types de modèles sont pris en charge : 1. « * », il correspond à n’importe quel nom d’événement 2. Combiner plusieurs événements avec « , », par exemple « event1,event2 », il correspond à l’événement « event1 » et « event2 » 3. Nom d’événement unique, par exemple, « event1 », il correspond à « event1 » |
string |
UpstreamAuthSettings
| Nom | Description | Valeur |
|---|---|---|
| managedIdentity | Obtient ou définit les paramètres d’identité managée. Elle est requise si le type d’authentification est défini sur ManagedIdentity. | ManagedIdentitySettings |
| type | Obtient ou définit le type d’authentification. None ou ManagedIdentity est désormais pris en charge. | 'ManagedIdentity' 'None' |
ManagedIdentitySettings
| Nom | Description | Valeur |
|---|---|---|
| resource | Ressource indiquant l’URI d’ID d’application de la ressource cible. Il apparaît également dans la revendication aud (audience) du jeton émis. |
string |
LiveTraceConfiguration
| Nom | Description | Valeur |
|---|---|---|
| categories | Obtient ou définit la liste des configurations de catégorie. | LiveTraceCategory[] |
| enabled | Indique si la trace dynamique est activé ou non. Lorsqu’il est défini sur true, le client de trace dynamique peut se connecter au service. Sinon, le client de trace dynamique ne peut pas se connecter au service, de sorte que vous ne pouvez pas recevoir de journal, quel que soit ce que vous configurez dans les « catégories ». Valeurs disponibles : true, false. Ne respecte pas la casse. |
string |
LiveTraceCategory
| Nom | Description | Valeur |
|---|---|---|
| enabled | Indique si ou la catégorie de journal est activée. Valeurs disponibles : true, false. Ne respecte pas la casse. |
string |
| name | Obtient ou définit le nom de la catégorie de journal. Valeurs disponibles : ConnectivityLogs, MessagingLogs. Ne respecte pas la casse. |
string |
WebPubSubNetworkACLs
| Nom | Description | Valeur |
|---|---|---|
| defaultAction | Action par défaut lorsqu’aucune autre règle ne correspond | 'Autoriser' 'Deny' |
| privateEndpoints | Listes de contrôle d’accès pour les demandes provenant de points de terminaison privés | PrivateEndpointACL[] |
| publicNetwork | Liste de contrôle d’accès pour les requêtes provenant du réseau public | NetworkACL |
PrivateEndpointACL
| Nom | Description | Valeur |
|---|---|---|
| allow | Types de requêtes autorisés. La valeur peut être un ou plusieurs de : ClientConnection, ServerConnection, RESTAPI. | Tableau de chaînes contenant l’un des éléments suivants : 'ClientConnection' 'RESTAPI' 'ServerConnection' 'Trace' |
| deny | Types de requêtes refusés. La valeur peut être un ou plusieurs de : ClientConnection, ServerConnection, RESTAPI. | Tableau de chaînes contenant l’un des éléments suivants : 'ClientConnection' 'RESTAPI' 'ServerConnection' 'Trace' |
| name | Nom de la connexion de point de terminaison privé | string (obligatoire) |
NetworkACL
| Nom | Description | Valeur |
|---|---|---|
| allow | Types de requêtes autorisés. La valeur peut être un ou plusieurs de : ClientConnection, ServerConnection, RESTAPI. | Tableau de chaînes contenant l’un des éléments suivants : 'ClientConnection' 'RESTAPI' 'ServerConnection' 'Trace' |
| deny | Types de requêtes refusés. La valeur peut être un ou plusieurs de : ClientConnection, ServerConnection, RESTAPI. | Tableau de chaînes contenant l’un des éléments suivants : 'ClientConnection' 'RESTAPI' 'ServerConnection' 'Trace' |
WebPubSubTlsSettings
| Nom | Description | Valeur |
|---|---|---|
| clientCertEnabled | Demander un certificat client pendant l’établissement d’une liaison TLS s’il est activé | bool |
ResourceSku
| Nom | Description | Valeur |
|---|---|---|
| capacité | Facultatif, entier. Nombre d’unités de la ressource. 1 par défaut. Le cas échéant, les valeurs suivantes sont autorisées : Gratuit : 1 Standard : 1,2,5,10,20,50,100 |
int |
| name | Nom de la référence SKU. Obligatoire. Valeurs autorisées : Standard_S1, Free_F1 |
string (obligatoire) |
| Niveau | Niveau facultatif de cette référence SKU particulière. « Standard » ou « Gratuit ». Basic est déconseillé, utilisez Standard à la place. |
'De base' 'Gratuit' 'Premium' 'Standard' |
Modèles de démarrage rapide
Les modèles de démarrage rapide suivants déploient ce type de ressource.
| Modèle | Description |
|---|---|
| Créer Azure Web PubSub à l’aide de Bicep |
Le service Azure Web PubSub vous permet de créer des applications web de messagerie en temps réel à l’aide de WebSockets et du modèle publication-abonnement. Cela utilise le langage Bicep pour créer et configurer une ressource Web PubSub. Vous pouvez utiliser ce modèle pour déployer facilement Web PubSub dans le cadre d’un didacticiel ou d’un test, ou en tant que bloc de construction pour des déploiements plus complexes avec Web PubSub. |
Définition de ressource Terraform (fournisseur AzAPI)
Le type de ressource webPubSub peut être déployé avec des opérations qui ciblent :
- Groupes de ressources
Pour obtenir la liste des propriétés modifiées dans chaque version d’API, consultez journal des modifications.
Format des ressources
Pour créer une ressource Microsoft.SignalRService/webPubSub, ajoutez le Terraform suivant à votre modèle.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.SignalRService/webPubSub@2021-09-01-preview"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
type = "string"
identity_ids = []
}
body = jsonencode({
properties = {
disableAadAuth = bool
disableLocalAuth = bool
eventHandler = {
items = {
{customized property} = [
{
auth = {
managedIdentity = {
resource = "string"
}
type = "string"
}
systemEventPattern = "string"
urlTemplate = "string"
userEventPattern = "string"
}
]
}
}
liveTraceConfiguration = {
categories = [
{
enabled = "string"
name = "string"
}
]
enabled = "string"
}
networkACLs = {
defaultAction = "string"
privateEndpoints = [
{
allow = [
"string"
]
deny = [
"string"
]
name = "string"
}
]
publicNetwork = {
allow = [
"string"
]
deny = [
"string"
]
}
}
publicNetworkAccess = "string"
tls = {
clientCertEnabled = bool
}
}
sku = {
capacity = int
name = "string"
tier = "string"
}
})
}
Valeurs de propriétés
webPubSub
| Nom | Description | Valeur |
|---|---|---|
| type | Type de ressource | « Microsoft.SignalRService/webPubSub@2021-09-01-preview » |
| name | Nom de la ressource | string (obligatoire) |
| location | Emplacement GEO de la ressource. Par exemple, USA Ouest , USA Est , USA Centre Nord , USA Centre Sud. | string |
| parent_id | Pour effectuer un déploiement dans un groupe de ressources, utilisez l’ID de ce groupe de ressources. | string (obligatoire) |
| tags | Balises du service, qui est une liste de paires clé-valeur qui décrivent la ressource. | Dictionnaire de noms et de valeurs d’étiquettes. |
| sku | Informations de facturation de la ressource. (par exemple, Gratuit, Standard) | ResourceSku |
| identité | Réponse de l’identité managée | ManagedIdentity |
| properties | Paramètres utilisés pour provisionner ou configurer la ressource | WebPubSubProperties |
ManagedIdentity
| Nom | Description | Valeur |
|---|---|---|
| type | Représenter le type d’identité : systemAssigned, userAssigned, None | « SystemAssigned » « UserAssigned » |
| identity_ids | Obtenir ou définir les identités affectées par l’utilisateur | Tableau d’ID d’identité utilisateur. |
ManagedIdentityUserAssignedIdentities
| Nom | Description | Valeur |
|---|---|---|
| {propriété personnalisée} | UserAssignedIdentityProperty |
UserAssignedIdentityProperty
Cet objet ne contient aucune propriété à définir pendant le déploiement. Toutes les propriétés sont ReadOnly.
WebPubSubProperties
| Nom | Description | Valeur |
|---|---|---|
| disableAadAuth | DisableLocalAuth Activer ou désactiver l’authentification aad Lorsque la valeur est true, la connexion avec AuthType=aad ne fonctionne pas. |
bool |
| disableLocalAuth | DisableLocalAuth Activer ou désactiver l’authentification locale avec AccessKey Lorsque la valeur est true, la connexion avec AccessKey=xxx ne fonctionne pas. |
bool |
| Eventhandler | Paramètres du gestionnaire d’événements dans le service webpubsub. | EventHandlerSettings |
| liveTraceConfiguration | Configuration de trace dynamique d’une ressource Microsoft.SignalRService. | LiveTraceConfiguration |
| networkACLs | Listes de contrôle d'accès réseau | WebPubSubNetworkACLs |
| publicNetworkAccess | Activer ou désactiver l’accès au réseau public. La valeur par défaut est « Enabled ». Quand elle est activée, les listes de contrôle d’accès réseau s’appliquent toujours. Lorsqu’il est désactivé, l’accès au réseau public est toujours désactivé, quel que soit ce que vous définissez dans les listes de contrôle d’accès réseau. |
string |
| Tls | Paramètres TLS. | WebPubSubTlsSettings |
EventHandlerSettings
| Nom | Description | Valeur |
|---|---|---|
| items | Obtenez ou définissez les éléments EventHandler. La clé est le nom du hub et la valeur est l’EventHandlerTemplate correspondant. | EventHandlerSettingsItems |
EventHandlerSettingsItems
| Nom | Description | Valeur |
|---|---|---|
| {propriété personnalisée} | EventHandlerTemplate[] |
EventHandlerTemplate
| Nom | Description | Valeur |
|---|---|---|
| auth | Obtient ou définit les paramètres d’authentification pour un gestionnaire d’événements. Si elle n’est pas définie, aucune authentification n’est utilisée. | UpstreamAuthSettings |
| systemEventPattern | Obtient ot définit le modèle d’événement système. Deux types de modèles sont pris en charge : 1. Nom d’événement unique, par exemple, « connect », il correspond à « connect » 2. Combinez plusieurs événements avec « , », par exemple « connect, disconnected », il correspond à l’événement « connect » et « disconnected » |
string |
| urlTemplate | Obtient ou définit le modèle d’URL eventHandler. Vous pouvez utiliser un paramètre prédéfini {hub} et {event} dans le modèle. La valeur de l’URL eventHandler est calculée dynamiquement lorsque la demande du client arrive. Par exemple, UrlTemplate peut être http://example.com/api/{hub}/{event}. La partie hôte ne peut pas contenir de paramètres. |
string (obligatoire) |
| userEventPattern | Obtient ou définit le modèle correspondant pour les noms d’événements. Trois types de modèles sont pris en charge : 1. « * », il correspond à n’importe quel nom d’événement 2. Combiner plusieurs événements avec « , », par exemple « event1,event2 », il correspond à l’événement « event1 » et « event2 » 3. Nom d’événement unique, par exemple, « event1 », il correspond à « event1 » |
string |
UpstreamAuthSettings
| Nom | Description | Valeur |
|---|---|---|
| managedIdentity | Obtient ou définit les paramètres d’identité managée. Elle est requise si le type d’authentification est défini sur ManagedIdentity. | ManagedIdentitySettings |
| type | Obtient ou définit le type d’authentification. None ou ManagedIdentity est désormais pris en charge. | « ManagedIdentity » "None" |
ManagedIdentitySettings
| Nom | Description | Valeur |
|---|---|---|
| resource | Ressource indiquant l’URI d’ID d’application de la ressource cible. Il apparaît également dans la revendication aud (audience) du jeton émis. |
string |
LiveTraceConfiguration
| Nom | Description | Valeur |
|---|---|---|
| categories | Obtient ou définit la liste des configurations de catégorie. | LiveTraceCategory[] |
| enabled | Indique si ou non activer la trace dynamique. Lorsqu’il est défini sur true, le client de trace dynamique peut se connecter au service. Sinon, le client de suivi dynamique ne peut pas se connecter au service, de sorte que vous ne pouvez pas recevoir de journal, quelle que soit la configuration que vous configurez dans les « catégories ». Valeurs disponibles : true, false. Ne respecte pas la casse. |
string |
LiveTraceCategory
| Nom | Description | Valeur |
|---|---|---|
| enabled | Indique si ou la catégorie de journal est activée. Valeurs disponibles : true, false. Ne respecte pas la casse. |
string |
| name | Obtient ou définit le nom de la catégorie de journal. Valeurs disponibles : ConnectivityLogs, MessagingLogs. Ne respecte pas la casse. |
string |
WebPubSubNetworkACLs
| Nom | Description | Valeur |
|---|---|---|
| defaultAction | Action par défaut lorsqu’aucune autre règle ne correspond | « Autoriser » « Refuser » |
| privateEndpoints | Listes de contrôle d’accès pour les requêtes provenant de points de terminaison privés | PrivateEndpointACL[] |
| publicNetwork | Liste de contrôle d’accès pour les requêtes provenant d’un réseau public | NetworkACL |
PrivateEndpointACL
| Nom | Description | Valeur |
|---|---|---|
| allow | Types de requêtes autorisés. La valeur peut être un ou plusieurs des éléments suivants : ClientConnection, ServerConnection, RESTAPI. | Tableau de chaînes contenant l’un des éléments suivants : « ClientConnection » « RESTAPI » « ServerConnection » « Trace » |
| deny | Types de demandes refusées. La valeur peut être un ou plusieurs des éléments suivants : ClientConnection, ServerConnection, RESTAPI. | Tableau de chaînes contenant l’un des éléments suivants : « ClientConnection » « RESTAPI » « ServerConnection » « Trace » |
| name | Nom de la connexion de point de terminaison privé | chaîne (obligatoire) |
NetworkACL
| Nom | Description | Valeur |
|---|---|---|
| allow | Types de requêtes autorisés. La valeur peut être un ou plusieurs des éléments suivants : ClientConnection, ServerConnection, RESTAPI. | Tableau de chaînes contenant l’un des éléments suivants : « ClientConnection » « RESTAPI » « ServerConnection » « Trace » |
| deny | Types de demandes refusées. La valeur peut être un ou plusieurs des éléments suivants : ClientConnection, ServerConnection, RESTAPI. | Tableau de chaînes contenant l’un des éléments suivants : « ClientConnection » « RESTAPI » « ServerConnection » « Trace » |
WebPubSubTlsSettings
| Nom | Description | Valeur |
|---|---|---|
| clientCertEnabled | Demander un certificat client pendant la négociation TLS si cette option est activée | bool |
ResourceSku
| Nom | Description | Valeur |
|---|---|---|
| capacité | Facultatif, entier. Nombre d’unités de la ressource. 1 par défaut. Le cas échéant, les valeurs suivantes sont autorisées : Gratuit : 1 Standard : 1,2,5,10,20,50,100 |
int |
| name | Nom de la référence SKU. Obligatoire. Valeurs autorisées : Standard_S1, Free_F1 |
chaîne (obligatoire) |
| Niveau | Niveau facultatif de cette référence SKU particulière. 'Standard' ou 'Free'. Basic est déconseillé, utilisez Standard à la place. |
"Basic" « Gratuit » « Premium » « Standard » |