Microsoft.SignalRService signalR 2020-07-01-preview
Bicep-resourcedefinitie
Het resourcetype signalR kan worden geïmplementeerd met bewerkingen die zijn gericht op:
- Resourcegroepen - Zie opdrachten voor resourcegroepimplementatie
Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.
Resource-indeling
Als u een Resource Microsoft.SignalRService/signalR wilt maken, voegt u de volgende Bicep toe aan uw sjabloon.
resource symbolicname 'Microsoft.SignalRService/signalR@2020-07-01-preview' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
sku: {
capacity: int
name: 'string'
tier: 'string'
}
kind: 'string'
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
properties: {
cors: {
allowedOrigins: [
'string'
]
}
features: [
{
flag: 'string'
properties: {
{customized property}: 'string'
}
value: 'string'
}
]
networkACLs: {
defaultAction: 'string'
privateEndpoints: [
{
allow: [
'string'
]
deny: [
'string'
]
name: 'string'
}
]
publicNetwork: {
allow: [
'string'
]
deny: [
'string'
]
}
}
tls: {
clientCertEnabled: bool
}
upstream: {
templates: [
{
auth: {
managedIdentity: {
resource: 'string'
}
type: 'string'
}
categoryPattern: 'string'
eventPattern: 'string'
hubPattern: 'string'
urlTemplate: 'string'
}
]
}
}
}
Eigenschapswaarden
signalR
| Naam | Description | Waarde |
|---|---|---|
| naam | De resourcenaam | tekenreeks (vereist) Tekenlimiet: 3-63 Geldige tekens: Alfanumeriek en afbreekstreepjes. Begin met letter. Eindig met letter of cijfer. De resourcenaam moet uniek zijn in Azure. |
| location | De GEO-locatie van de resource. bijvoorbeeld VS - west , VS - oost , VS - noord-centraal, VS - zuid-centraal. | tekenreeks |
| tags | Tags van de service, een lijst met sleutelwaardeparen die de resource beschrijven. | Woordenlijst met tagnamen en -waarden. Tags in sjablonen bekijken |
| sku | De factureringsgegevens van de resource. (bijvoorbeeld Gratis, Standaard) | ResourceSku |
| Soort | Het type service, bijvoorbeeld 'SignalR' voor 'Microsoft.SignalRService/SignalR' | 'RawWebSockets' 'SignalR' |
| identity | Het antwoord van de beheerde identiteit | ManagedIdentity |
| properties | Instellingen die worden gebruikt voor het inrichten of configureren van de resource | SignalRProperties |
ManagedIdentity
| Naam | Description | Waarde |
|---|---|---|
| type | Vertegenwoordigt het identiteitstype: systemAssigned, userAssigned, None | 'Geen' 'SystemAssigned' 'UserAssigned' |
| userAssignedIdentities | De door de gebruiker toegewezen identiteiten ophalen of instellen | ManagedIdentityUserAssignedId-entiteiten |
ManagedIdentityUserAssignedId-entiteiten
| Naam | Description | Waarde |
|---|---|---|
| {aangepaste eigenschap} | UserAssignedIdentityProperty |
UserAssignedIdentityProperty
Dit object bevat geen eigenschappen die tijdens de implementatie moeten worden ingesteld. Alle eigenschappen zijn ReadOnly.
SignalRProperties
| Naam | Description | Waarde |
|---|---|---|
| cors | Cors-instellingen (Cross-Origin Resource Sharing). | SignalRCorsSettings |
| features | Lijst met SignalR featureFlags. bijvoorbeeld ServiceMode. FeatureFlags die niet zijn opgenomen in de parameters voor de updatebewerking, worden niet gewijzigd. En het antwoord bevat alleen featureFlags die expliciet zijn ingesteld. Wanneer een featureFlag niet expliciet is ingesteld, gebruikt de SignalR-service de globale standaardwaarde. Houd er echter rekening mee dat de standaardwaarde niet 'onwaar' betekent. Het varieert in termen van verschillende FeatureFlags. |
SignalRFeature[] |
| networkACLs | Netwerk-ACL's | SignalRNetworkACLs |
| Tls | TLS-instellingen. | SignalRTlsSettings |
| upstream | Upstream-instellingen wanneer de Azure SignalR zich in de serverloze modus bevindt. | ServerlessUpstreamSettings |
SignalRCorsSettings
| Naam | Description | Waarde |
|---|---|---|
| allowedOrigins | Hiermee wordt de lijst met origins opgehaald of ingesteld die moeten worden toegestaan om cross-origin-aanroepen te doen (bijvoorbeeld: http://example.com:12345). Gebruik *om alles toe te staan. Als u dit weglaat, staat u standaard alles toe. |
tekenreeks[] |
SignalRFeature
| Naam | Description | Waarde |
|---|---|---|
| flag | FeatureFlags is de ondersteunde functies van de Azure SignalR-service. - ServiceMode: Vlag voor back-endserver voor SignalR-service. Toegestane waarden: "Standaard": uw eigen back-endserver hebben; 'Serverloos': uw toepassing heeft geen back-endserver; "Klassiek": voor compatibiliteit met eerdere versies. Ondersteuning voor zowel de standaardmodus als de serverloze modus, maar niet aanbevolen; "PredefinedOnly": voor toekomstig gebruik. - EnableConnectivityLogs: "true"/"false", om respectievelijk de categorie van het connectiviteitslogboek in of uit te schakelen. |
'EnableConnectivityLogs' 'EnableMessagingLogs' 'ServiceMode' (vereist) |
| properties | Optionele eigenschappen met betrekking tot deze functie. | SignalRFeatureProperties |
| waarde | Waarde van de functievlag. Zie Azure SignalR-servicedocument https://docs.microsoft.com/azure/azure-signalr/ voor toegestane waarden. |
tekenreeks (vereist) Beperkingen: Minimale lengte = 1 Maximale lengte = 128 |
SignalRFeatureProperties
| Naam | Description | Waarde |
|---|---|---|
| {aangepaste eigenschap} | tekenreeks |
SignalRNetworkACLs
| Naam | Description | Waarde |
|---|---|---|
| defaultAction | Standaardactie wanneer er geen andere regel overeenkomt | 'Toestaan' 'Weigeren' |
| privateEndpoints | ACL's voor aanvragen van privé-eindpunten | PrivateEndpointACL[] |
| publicNetwork | ACL voor aanvragen van een openbaar netwerk | NetworkACL |
PrivateEndpointACL
| Naam | Description | Waarde |
|---|---|---|
| Toestaan | Toegestane aanvraagtypen. De waarde kan een of meer van zijn: ClientConnection, ServerConnection, RESTAPI. | Tekenreeksmatrix met een van de volgende: 'ClientConnection' 'RESTAPI' 'ServerConnection' |
| weigeren | Geweigerde aanvraagtypen. De waarde kan een of meer van zijn: ClientConnection, ServerConnection, RESTAPI. | Tekenreeksmatrix met een van de volgende: 'ClientConnection' 'RESTAPI' 'ServerConnection' |
| naam | Naam van de privé-eindpuntverbinding | tekenreeks (vereist) |
NetworkACL
| Naam | Description | Waarde |
|---|---|---|
| Toestaan | Toegestane aanvraagtypen. De waarde kan een of meer van zijn: ClientConnection, ServerConnection, RESTAPI. | Tekenreeksmatrix met een van de volgende: 'ClientConnection' 'RESTAPI' 'ServerConnection' |
| weigeren | Geweigerde aanvraagtypen. De waarde kan een of meer van zijn: ClientConnection, ServerConnection, RESTAPI. | Tekenreeksmatrix met een van de volgende: 'ClientConnection' 'RESTAPI' 'ServerConnection' |
SignalRTlsSettings
| Naam | Description | Waarde |
|---|---|---|
| clientCertEnabled | Clientcertificaat aanvragen tijdens TLS-handshake indien ingeschakeld | booleaans |
ServerlessUpstreamSettings
| Naam | Description | Waarde |
|---|---|---|
| sjablonen | Hiermee wordt de lijst met upstream-URL-sjablonen opgehaald of ingesteld. Volgorde is van belang en de eerste overeenkomende sjabloon heeft gevolgen. | UpstreamTemplate[] |
UpstreamTemplate
| Naam | Description | Waarde |
|---|---|---|
| Auth | Hiermee worden de verificatie-instellingen voor een upstream opgehaald of ingesteld. Als dit niet is ingesteld, wordt er geen verificatie gebruikt voor upstream-berichten. | UpstreamAuthSettings |
| categoryPattern | Hiermee wordt het overeenkomende patroon voor categorienamen opgehaald of ingesteld. Als deze optie niet is ingesteld, komt deze overeen met elke categorie. Er worden drie soorten patronen ondersteund: 1. "*", het komt overeen met elke categorienaam 2. Combineer meerdere categorieën met ",", bijvoorbeeld "verbindingen,berichten", het komt overeen met de categorie "verbindingen" en "berichten" 3. De naam van één categorie, bijvoorbeeld 'verbindingen', komt overeen met de categorie 'verbindingen' |
tekenreeks |
| eventPattern | Hiermee wordt het overeenkomende patroon voor gebeurtenisnamen opgehaald of ingesteld. Als deze niet is ingesteld, komt deze overeen met elke gebeurtenis. Er worden drie soorten patronen ondersteund: 1. "*", het komt overeen met elke gebeurtenisnaam 2. Combineer meerdere gebeurtenissen met ',', bijvoorbeeld 'verbinding maken,verbinding verbreken', het komt overeen met de gebeurtenis 'verbinding maken' en 'verbinding verbreken' 3. De naam van één gebeurtenis, bijvoorbeeld 'verbinding maken', komt overeen met 'verbinding maken' |
tekenreeks |
| hubPattern | Hiermee wordt het overeenkomende patroon voor hubnamen opgehaald of ingesteld. Als deze niet is ingesteld, komt deze overeen met elke hub. Er worden drie soorten patronen ondersteund: 1. "*", het komt overeen met elke hubnaam 2. Combineer meerdere hubs met ",", bijvoorbeeld "hub1,hub2", het komt overeen met "hub1" en "hub2" 3. De naam van één hub, bijvoorbeeld 'hub1', komt overeen met 'hub1' |
tekenreeks |
| urlTemplate | Hiermee wordt de upstream-URL-sjabloon opgehaald of ingesteld. U kunt 3 vooraf gedefinieerde parameters {hub}, {category} {event} in de sjabloon gebruiken. De waarde van de Upstream-URL wordt dynamisch berekend wanneer de clientaanvraag binnenkomt. Als de urlTemplate bijvoorbeeld is, met http://example.com/{hub}/api/{event}een clientaanvraag van hub-verbinding chat , wordt er eerst POST naar deze URL verzonden: http://example.com/chat/api/connect. |
tekenreeks (vereist) |
UpstreamAuthSettings
| Naam | Description | Waarde |
|---|---|---|
| managedIdentity | Hiermee worden de instellingen voor beheerde identiteiten opgehaald of ingesteld. Dit is vereist als het verificatietype is ingesteld op ManagedIdentity. | ManagedIdentitySettings |
| type | Hiermee wordt het type verificatie opgehaald of ingesteld. None of ManagedIdentity wordt nu ondersteund. | 'ManagedIdentity' 'Geen' |
ManagedIdentitySettings
| Naam | Description | Waarde |
|---|---|---|
| resource | De resource die de app-id-URI van de doelresource aangeeft. Het wordt ook weergegeven in de claim aud (doelgroep) van het uitgegeven token. |
tekenreeks |
ResourceSku
| Naam | Description | Waarde |
|---|---|---|
| capacity | Optioneel, geheel getal. Het aantal eenheden van SignalR-resource. 1 standaard. Indien aanwezig, zijn de volgende waarden toegestaan: Gratis: 1 Standaard: 1,2,5,10,20,50,100 |
int |
| naam | De naam van de SKU. Vereist. Toegestane waarden: Standard_S1, Free_F1 |
tekenreeks (vereist) |
| laag | Optionele laag van deze specifieke SKU. 'Standaard' of 'Gratis'. Basic is afgeschaft. Gebruik Standard in plaats daarvan. |
'Basic' 'Gratis' 'Premium' 'Standaard' |
Snelstartsjablonen
Met de volgende snelstartsjablonen wordt dit resourcetype geïmplementeerd.
| Template | Beschrijving |
|---|---|
Een Azure SignalR-service implementeren |
Met deze sjabloon maakt u een Azure SignalR Service met behulp van een sjabloon. |
Resourcedefinitie van ARM-sjabloon
Het resourcetype signalR kan worden geïmplementeerd met bewerkingen die zijn gericht op:
- Resourcegroepen - Zie opdrachten voor resourcegroepimplementatie
Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.
Resource-indeling
Als u een Microsoft.SignalRService/signalR-resource wilt maken, voegt u de volgende JSON toe aan uw sjabloon.
{
"type": "Microsoft.SignalRService/signalR",
"apiVersion": "2020-07-01-preview",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"sku": {
"capacity": "int",
"name": "string",
"tier": "string"
},
"kind": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {}
}
},
"properties": {
"cors": {
"allowedOrigins": [ "string" ]
},
"features": [
{
"flag": "string",
"properties": {
"{customized property}": "string"
},
"value": "string"
}
],
"networkACLs": {
"defaultAction": "string",
"privateEndpoints": [
{
"allow": [ "string" ],
"deny": [ "string" ],
"name": "string"
}
],
"publicNetwork": {
"allow": [ "string" ],
"deny": [ "string" ]
}
},
"tls": {
"clientCertEnabled": "bool"
},
"upstream": {
"templates": [
{
"auth": {
"managedIdentity": {
"resource": "string"
},
"type": "string"
},
"categoryPattern": "string",
"eventPattern": "string",
"hubPattern": "string",
"urlTemplate": "string"
}
]
}
}
}
Eigenschapswaarden
signalR
| Naam | Description | Waarde |
|---|---|---|
| type | Het resourcetype | 'Microsoft.SignalRService/signalR' |
| apiVersion | De resource-API-versie | '2020-07-01-preview' |
| naam | De resourcenaam | tekenreeks (vereist) Tekenlimiet: 3-63 Geldige tekens: Alfanumeriek en afbreekstreepjes. Begin met letter. Eindig met letter of cijfer. De resourcenaam moet uniek zijn in Azure. |
| location | De GEO-locatie van de resource. bijvoorbeeld VS - west , VS - oost , VS - noord-centraal, VS - zuid-centraal. | tekenreeks |
| tags | Tags van de service, een lijst met sleutelwaardeparen die de resource beschrijven. | Woordenlijst met tagnamen en -waarden. Tags in sjablonen bekijken |
| sku | De factureringsgegevens van de resource. (bijvoorbeeld Gratis, Standaard) | ResourceSku |
| Soort | Het type service, bijvoorbeeld 'SignalR' voor 'Microsoft.SignalRService/SignalR' | 'RawWebSockets' 'SignalR' |
| identity | Het antwoord van de beheerde identiteit | ManagedIdentity |
| properties | Instellingen die worden gebruikt voor het inrichten of configureren van de resource | SignalRProperties |
ManagedIdentity
| Naam | Description | Waarde |
|---|---|---|
| type | Vertegenwoordigt het identiteitstype: systemAssigned, userAssigned, None | 'Geen' 'SystemAssigned' 'UserAssigned' |
| userAssignedIdentities | De door de gebruiker toegewezen identiteiten ophalen of instellen | ManagedIdentityUserAssignedId-entiteiten |
ManagedIdentityUserAssignedId-entiteiten
| Naam | Description | Waarde |
|---|---|---|
| {aangepaste eigenschap} | UserAssignedIdentityProperty |
UserAssignedIdentityProperty
Dit object bevat geen eigenschappen die tijdens de implementatie moeten worden ingesteld. Alle eigenschappen zijn ReadOnly.
SignalRProperties
| Naam | Description | Waarde |
|---|---|---|
| cors | Cors-instellingen (Cross-Origin Resource Sharing). | SignalRCorsSettings |
| features | Lijst met SignalR featureFlags. bijvoorbeeld ServiceMode. FeatureFlags die niet zijn opgenomen in de parameters voor de updatebewerking, worden niet gewijzigd. En het antwoord bevat alleen featureFlags die expliciet zijn ingesteld. Wanneer een featureFlag niet expliciet is ingesteld, gebruikt de SignalR-service de globale standaardwaarde. Houd er echter rekening mee dat de standaardwaarde niet 'onwaar' betekent. Het varieert in termen van verschillende FeatureFlags. |
SignalRFeature[] |
| networkACLs | Netwerk-ACL's | SignalRNetworkACLs |
| Tls | TLS-instellingen. | SignalRTlsSettings |
| upstream | Upstream-instellingen wanneer de Azure SignalR zich in de serverloze modus bevindt. | ServerlessUpstreamSettings |
SignalRCorsSettings
| Naam | Description | Waarde |
|---|---|---|
| allowedOrigins | Hiermee wordt de lijst met oorsprongen opgehaald of ingesteld die moeten worden toegestaan om cross-origin-aanroepen te doen (bijvoorbeeld: http://example.com:12345). Gebruik *om alles toe te staan. Als u dit weglaat, staat u standaard alles toe. |
tekenreeks[] |
SignalRFeature
| Naam | Description | Waarde |
|---|---|---|
| flag | FeatureFlags is de ondersteunde functies van de Azure SignalR-service. - ServiceMode: Vlag voor back-endserver voor SignalR-service. Toegestane waarden: "Standaard": uw eigen back-endserver hebben; 'Serverloos': uw toepassing heeft geen back-endserver; "Klassiek": voor compatibiliteit met eerdere versies. Ondersteuning voor zowel de standaard- als de serverloze modus, maar niet aanbevolen; "PredefinedOnly": voor toekomstig gebruik. - EnableConnectivityLogs: 'true'/'false', om respectievelijk de categorie van het connectiviteitslogboek in of uit te schakelen. |
EnableConnectivityLogs 'EnableMessagingLogs' ServiceMode (vereist) |
| properties | Optionele eigenschappen met betrekking tot deze functie. | SignalRFeatureProperties |
| waarde | Waarde van de functievlag. Zie Azure SignalR-servicedocument https://docs.microsoft.com/azure/azure-signalr/ voor toegestane waarden. |
tekenreeks (vereist) Beperkingen: Minimale lengte = 1 Maximale lengte = 128 |
SignalRFeatureProperties
| Naam | Description | Waarde |
|---|---|---|
| {aangepaste eigenschap} | tekenreeks |
SignalRNetworkACLs
| Naam | Description | Waarde |
|---|---|---|
| defaultAction | Standaardactie wanneer er geen andere regel overeenkomt | 'Toestaan' Weigeren |
| privateEndpoints | ACL's voor aanvragen van privé-eindpunten | PrivateEndpointACL[] |
| publicNetwork | ACL voor aanvragen van openbaar netwerk | NetworkACL |
PrivateEndpointACL
| Naam | Description | Waarde |
|---|---|---|
| Toestaan | Toegestane aanvraagtypen. De waarde kan een of meer van zijn: ClientConnection, ServerConnection, RESTAPI. | Tekenreeksmatrix met een van de volgende waarden: 'ClientConnection' 'RESTAPI' 'ServerConnection' |
| weigeren | Geweigerde aanvraagtypen. De waarde kan een of meer van zijn: ClientConnection, ServerConnection, RESTAPI. | Tekenreeksmatrix met een van de volgende waarden: 'ClientConnection' 'RESTAPI' 'ServerConnection' |
| naam | Naam van de privé-eindpuntverbinding | tekenreeks (vereist) |
NetworkACL
| Naam | Description | Waarde |
|---|---|---|
| Toestaan | Toegestane aanvraagtypen. De waarde kan een of meer van zijn: ClientConnection, ServerConnection, RESTAPI. | Tekenreeksmatrix met een van de volgende waarden: 'ClientConnection' 'RESTAPI' 'ServerConnection' |
| weigeren | Geweigerde aanvraagtypen. De waarde kan een of meer van zijn: ClientConnection, ServerConnection, RESTAPI. | Tekenreeksmatrix met een van de volgende waarden: 'ClientConnection' 'RESTAPI' 'ServerConnection' |
SignalRTlsSettings
| Naam | Description | Waarde |
|---|---|---|
| clientCertEnabled | Clientcertificaat aanvragen tijdens TLS-handshake indien ingeschakeld | booleaans |
ServerlessUpstreamSettings
| Naam | Description | Waarde |
|---|---|---|
| sjablonen | Hiermee wordt de lijst met Upstream-URL-sjablonen opgehaald of ingesteld. Volgorde is van belang en de eerste overeenkomende sjabloon heeft gevolgen. | UpstreamTemplate[] |
UpstreamTemplate
| Naam | Description | Waarde |
|---|---|---|
| Auth | Hiermee worden de verificatie-instellingen voor een upstream opgehaald of ingesteld. Als dit niet is ingesteld, wordt er geen verificatie gebruikt voor upstream-berichten. | UpstreamAuthSettings |
| categoryPattern | Hiermee wordt het overeenkomende patroon voor categorienamen opgehaald of ingesteld. Als dit niet is ingesteld, komt deze overeen met elke categorie. Er worden drie soorten patronen ondersteund: 1. "*", het komt overeen met elke categorienaam 2. Combineer meerdere categorieën met ",", bijvoorbeeld "verbindingen,berichten", het komt overeen met de categorie "verbindingen" en "berichten" 3. De naam van één categorie, bijvoorbeeld 'verbindingen', komt overeen met de categorie 'verbindingen' |
tekenreeks |
| eventPattern | Hiermee wordt het overeenkomende patroon voor gebeurtenisnamen opgehaald of ingesteld. Als dit niet is ingesteld, komt deze overeen met een willekeurige gebeurtenis. Er worden drie soorten patronen ondersteund: 1. "*", het komt overeen met elke gebeurtenisnaam 2. Combineer meerdere gebeurtenissen met ',', bijvoorbeeld 'verbinding maken,verbinding verbreken', het komt overeen met de gebeurtenis 'verbinding maken' en 'verbinding verbreken' 3. De naam van één gebeurtenis, bijvoorbeeld 'verbinding maken', komt overeen met 'verbinding maken' |
tekenreeks |
| hubPattern | Hiermee wordt het overeenkomende patroon voor hubnamen opgehaald of ingesteld. Als dit niet is ingesteld, komt deze overeen met een willekeurige hub. Er worden drie soorten patronen ondersteund: 1. "*", het komt overeen met elke hubnaam 2. Combineer meerdere hubs met ",", bijvoorbeeld "hub1,hub2", het komt overeen met "hub1" en "hub2" 3. De naam van één hub, bijvoorbeeld 'hub1', komt overeen met 'hub1' |
tekenreeks |
| urlTemplate | Hiermee wordt de upstream-URL-sjabloon opgehaald of ingesteld. U kunt 3 vooraf gedefinieerde parameters {hub}, {category} {event} in de sjabloon gebruiken. De waarde van de upstream-URL wordt dynamisch berekend wanneer de clientaanvraag binnenkomt. Als de urlTemplate bijvoorbeeld is, wordt http://example.com/{hub}/api/{event}met een clientaanvraag van de hub chat verbinding gemaakt, eerst POST naar deze URL: http://example.com/chat/api/connect. |
tekenreeks (vereist) |
UpstreamAuthSettings
| Naam | Description | Waarde |
|---|---|---|
| managedIdentity | Hiermee worden de instellingen voor beheerde identiteiten opgehaald of ingesteld. Dit is vereist als het verificatietype is ingesteld op ManagedIdentity. | ManagedIdentitySettings |
| type | Hiermee wordt het type verificatie opgehaald of ingesteld. None of ManagedIdentity wordt nu ondersteund. | 'ManagedIdentity' 'Geen' |
ManagedIdentitySettings
| Naam | Description | Waarde |
|---|---|---|
| resource | De resource die de app-id-URI van de doelresource aangeeft. Het wordt ook weergegeven in de claim aud (doelgroep) van het uitgegeven token. |
tekenreeks |
ResourceSku
| Naam | Description | Waarde |
|---|---|---|
| capacity | Optioneel, geheel getal. Het aantal eenheden van de SignalR-resource. 1 standaard. Indien aanwezig, zijn de volgende waarden toegestaan: Gratis: 1 Standaard: 1,2,5,10,20,50,100 |
int |
| naam | De naam van de SKU. Vereist. Toegestane waarden: Standard_S1, Free_F1 |
tekenreeks (vereist) |
| laag | Optionele laag van deze specifieke SKU. 'Standaard' of 'Gratis'. Basic is afgeschaft, gebruikt Standard u in plaats daarvan. |
'Basic' 'Gratis' Premium 'Standaard' |
Snelstartsjablonen
Met de volgende quickstart-sjablonen wordt dit resourcetype geïmplementeerd.
| Template | Beschrijving |
|---|---|
| Een Azure SignalR-service implementeren |
Met deze sjabloon maakt u een Azure SignalR Service met behulp van een sjabloon. |
Resourcedefinitie van Terraform (AzAPI-provider)
Het resourcetype signalR kan worden geïmplementeerd met bewerkingen die zijn gericht op:
- Resourcegroepen
Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.
Resource-indeling
Als u een Microsoft.SignalRService/signalR-resource wilt maken, voegt u de volgende Terraform toe aan uw sjabloon.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.SignalRService/signalR@2020-07-01-preview"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
type = "string"
identity_ids = []
}
body = jsonencode({
properties = {
cors = {
allowedOrigins = [
"string"
]
}
features = [
{
flag = "string"
properties = {
{customized property} = "string"
}
value = "string"
}
]
networkACLs = {
defaultAction = "string"
privateEndpoints = [
{
allow = [
"string"
]
deny = [
"string"
]
name = "string"
}
]
publicNetwork = {
allow = [
"string"
]
deny = [
"string"
]
}
}
tls = {
clientCertEnabled = bool
}
upstream = {
templates = [
{
auth = {
managedIdentity = {
resource = "string"
}
type = "string"
}
categoryPattern = "string"
eventPattern = "string"
hubPattern = "string"
urlTemplate = "string"
}
]
}
}
sku = {
capacity = int
name = "string"
tier = "string"
}
kind = "string"
})
}
Eigenschapswaarden
signalR
| Naam | Description | Waarde |
|---|---|---|
| type | Het resourcetype | "Microsoft.SignalRService/signalR@2020-07-01-preview" |
| naam | De resourcenaam | tekenreeks (vereist) Tekenlimiet: 3-63 Geldige tekens: Alfanumeriek en afbreekstreepjes. Begin met letter. Eindig met letter of cijfer. De resourcenaam moet uniek zijn in Azure. |
| location | De GEO-locatie van de resource. bijvoorbeeld VS - west , VS - oost , VS - noord-centraal, VS - zuid-centraal. | tekenreeks |
| parent_id | Als u wilt implementeren in een resourcegroep, gebruikt u de id van die resourcegroep. | tekenreeks (vereist) |
| tags | Tags van de service, een lijst met sleutelwaardeparen die de resource beschrijven. | Woordenlijst met tagnamen en -waarden. |
| sku | De factureringsgegevens van de resource. (bijvoorbeeld Gratis, Standaard) | ResourceSku |
| Soort | Het type service, bijvoorbeeld 'SignalR' voor 'Microsoft.SignalRService/SignalR' | "RawWebSockets" "SignalR" |
| identity | Het antwoord van de beheerde identiteit | ManagedIdentity |
| properties | Instellingen die worden gebruikt voor het inrichten of configureren van de resource | SignalRProperties |
ManagedIdentity
| Naam | Description | Waarde |
|---|---|---|
| type | Vertegenwoordigt het identiteitstype: systemAssigned, userAssigned, None | "SystemAssigned" "UserAssigned" |
| identity_ids | De door de gebruiker toegewezen identiteiten ophalen of instellen | Matrix met gebruikersidentiteits-id's. |
ManagedIdentityUserAssignedId-entiteiten
| Naam | Description | Waarde |
|---|---|---|
| {aangepaste eigenschap} | UserAssignedIdentityProperty |
UserAssignedIdentityProperty
Dit object bevat geen eigenschappen die tijdens de implementatie moeten worden ingesteld. Alle eigenschappen zijn ReadOnly.
SignalRProperties
| Naam | Description | Waarde |
|---|---|---|
| cors | Cors-instellingen (Cross-Origin Resource Sharing). | SignalRCorsSettings |
| features | Lijst met SignalR featureFlags. bijvoorbeeld ServiceMode. FeatureFlags die niet zijn opgenomen in de parameters voor de updatebewerking, worden niet gewijzigd. En het antwoord bevat alleen featureFlags die expliciet zijn ingesteld. Wanneer een featureFlag niet expliciet is ingesteld, gebruikt de SignalR-service de globale standaardwaarde. Houd er echter rekening mee dat de standaardwaarde niet 'onwaar' betekent. Het varieert in termen van verschillende FeatureFlags. |
SignalRFeature[] |
| networkACLs | Netwerk-ACL's | SignalRNetworkACLs |
| Tls | TLS-instellingen. | SignalRTlsSettings |
| upstream | Upstream-instellingen wanneer de Azure SignalR zich in de serverloze modus bevindt. | ServerlessUpstreamSettings |
SignalRCorsSettings
| Naam | Description | Waarde |
|---|---|---|
| allowedOrigins | Hiermee wordt de lijst met oorsprongen opgehaald of ingesteld die moeten worden toegestaan om cross-origin-aanroepen te doen (bijvoorbeeld: http://example.com:12345). Gebruik *om alles toe te staan. Als u dit weglaat, staat u standaard alles toe. |
tekenreeks[] |
SignalRFeature
| Naam | Description | Waarde |
|---|---|---|
| flag | FeatureFlags is de ondersteunde functies van de Azure SignalR-service. - ServiceMode: Vlag voor back-endserver voor SignalR-service. Toegestane waarden: "Standaard": uw eigen back-endserver hebben; 'Serverloos': uw toepassing heeft geen back-endserver; "Klassiek": voor compatibiliteit met eerdere versies. Ondersteuning voor zowel de standaard- als de serverloze modus, maar niet aanbevolen; "PredefinedOnly": voor toekomstig gebruik. - EnableConnectivityLogs: 'true'/'false', om respectievelijk de categorie van het connectiviteitslogboek in of uit te schakelen. |
"EnableConnectivityLogs" "EnableMessagingLogs" "ServiceMode" (vereist) |
| properties | Optionele eigenschappen met betrekking tot deze functie. | SignalRFeatureProperties |
| waarde | Waarde van de functievlag. Zie Azure SignalR-servicedocument https://docs.microsoft.com/azure/azure-signalr/ voor toegestane waarden. |
tekenreeks (vereist) Beperkingen: Minimale lengte = 1 Maximale lengte = 128 |
SignalRFeatureProperties
| Naam | Description | Waarde |
|---|---|---|
| {aangepaste eigenschap} | tekenreeks |
SignalRNetworkACLs
| Naam | Description | Waarde |
|---|---|---|
| defaultAction | Standaardactie wanneer er geen andere regel overeenkomt | "Toestaan" "Weigeren" |
| privateEndpoints | ACL's voor aanvragen van privé-eindpunten | PrivateEndpointACL[] |
| publicNetwork | ACL voor aanvragen van openbaar netwerk | NetworkACL |
PrivateEndpointACL
| Naam | Description | Waarde |
|---|---|---|
| Toestaan | Toegestane aanvraagtypen. De waarde kan een of meer van zijn: ClientConnection, ServerConnection, RESTAPI. | Tekenreeksmatrix met een van de volgende waarden: "ClientConnection" "RESTAPI" "ServerConnection" |
| weigeren | Geweigerde aanvraagtypen. De waarde kan een of meer van zijn: ClientConnection, ServerConnection, RESTAPI. | Tekenreeksmatrix met een van de volgende waarden: "ClientConnection" "RESTAPI" "ServerConnection" |
| naam | Naam van de privé-eindpuntverbinding | tekenreeks (vereist) |
NetworkACL
| Naam | Description | Waarde |
|---|---|---|
| Toestaan | Toegestane aanvraagtypen. De waarde kan een of meer van zijn: ClientConnection, ServerConnection, RESTAPI. | Tekenreeksmatrix met een van de volgende waarden: "ClientConnection" "RESTAPI" "ServerConnection" |
| weigeren | Geweigerde aanvraagtypen. De waarde kan een of meer van zijn: ClientConnection, ServerConnection, RESTAPI. | Tekenreeksmatrix met een van de volgende waarden: "ClientConnection" "RESTAPI" "ServerConnection" |
SignalRTlsSettings
| Naam | Description | Waarde |
|---|---|---|
| clientCertEnabled | Clientcertificaat aanvragen tijdens TLS-handshake indien ingeschakeld | booleaans |
ServerlessUpstreamSettings
| Naam | Description | Waarde |
|---|---|---|
| sjablonen | Hiermee wordt de lijst met Upstream-URL-sjablonen opgehaald of ingesteld. Volgorde is van belang en de eerste overeenkomende sjabloon heeft gevolgen. | UpstreamTemplate[] |
UpstreamTemplate
| Naam | Description | Waarde |
|---|---|---|
| Auth | Hiermee worden de verificatie-instellingen voor een upstream opgehaald of ingesteld. Als dit niet is ingesteld, wordt er geen verificatie gebruikt voor upstream-berichten. | UpstreamAuthSettings |
| categoryPattern | Hiermee wordt het overeenkomende patroon voor categorienamen opgehaald of ingesteld. Als dit niet is ingesteld, komt deze overeen met elke categorie. Er worden drie soorten patronen ondersteund: 1. "*", het komt overeen met elke categorienaam 2. Combineer meerdere categorieën met ",", bijvoorbeeld "verbindingen,berichten", het komt overeen met de categorie "verbindingen" en "berichten" 3. De naam van één categorie, bijvoorbeeld 'verbindingen', komt overeen met de categorie 'verbindingen' |
tekenreeks |
| eventPattern | Hiermee wordt het overeenkomende patroon voor gebeurtenisnamen opgehaald of ingesteld. Als dit niet is ingesteld, komt deze overeen met een willekeurige gebeurtenis. Er worden drie soorten patronen ondersteund: 1. "*", het komt overeen met elke gebeurtenisnaam 2. Combineer meerdere gebeurtenissen met ',', bijvoorbeeld 'verbinding maken,verbinding verbreken', het komt overeen met de gebeurtenis 'verbinding maken' en 'verbinding verbreken' 3. De naam van één gebeurtenis, bijvoorbeeld 'verbinding maken', komt overeen met 'verbinding maken' |
tekenreeks |
| hubPattern | Hiermee wordt het overeenkomende patroon voor hubnamen opgehaald of ingesteld. Als dit niet is ingesteld, komt deze overeen met een willekeurige hub. Er worden drie soorten patronen ondersteund: 1. "*", het komt overeen met elke hubnaam 2. Combineer meerdere hubs met ",", bijvoorbeeld "hub1,hub2", het komt overeen met "hub1" en "hub2" 3. De naam van één hub, bijvoorbeeld 'hub1', komt overeen met 'hub1' |
tekenreeks |
| urlTemplate | Hiermee wordt de upstream-URL-sjabloon opgehaald of ingesteld. U kunt 3 vooraf gedefinieerde parameters {hub}, {category} {event} in de sjabloon gebruiken. De waarde van de upstream-URL wordt dynamisch berekend wanneer de clientaanvraag binnenkomt. Als de urlTemplate bijvoorbeeld is, wordt http://example.com/{hub}/api/{event}met een clientaanvraag van de hub chat verbinding gemaakt, eerst POST naar deze URL: http://example.com/chat/api/connect. |
tekenreeks (vereist) |
UpstreamAuthSettings
| Naam | Description | Waarde |
|---|---|---|
| managedIdentity | Hiermee worden de instellingen voor beheerde identiteiten opgehaald of ingesteld. Dit is vereist als het verificatietype is ingesteld op ManagedIdentity. | ManagedIdentitySettings |
| type | Hiermee wordt het type verificatie opgehaald of ingesteld. None of ManagedIdentity wordt nu ondersteund. | "ManagedIdentity" "Geen" |
ManagedIdentitySettings
| Naam | Description | Waarde |
|---|---|---|
| resource | De resource die de app-id-URI van de doelresource aangeeft. Het wordt ook weergegeven in de claim aud (doelgroep) van het uitgegeven token. |
tekenreeks |
ResourceSku
| Naam | Description | Waarde |
|---|---|---|
| capacity | Optioneel, geheel getal. Het aantal eenheden van de SignalR-resource. 1 standaard. Indien aanwezig, zijn de volgende waarden toegestaan: Gratis: 1 Standaard: 1,2,5,10,20,50,100 |
int |
| naam | De naam van de SKU. Vereist. Toegestane waarden: Standard_S1, Free_F1 |
tekenreeks (vereist) |
| laag | Optionele laag van deze specifieke SKU. 'Standaard' of 'Gratis'. Basic is afgeschaft, gebruikt Standard u in plaats daarvan. |
"Basis" "Gratis" "Premium" "Standaard" |