Microsoft.SignalRService signalR 2021-09-01-preview
- meest recente
- 2024-08-01-preview-
- 2024-04-01-preview-
- 2024-03-01
- 2024-01-01-preview-
- 2023-08-01-preview-
- 2023-06-01-preview-
- 2023-03-01-preview-
- 2023-02-01
- 2022-08-01-preview
- 2022-02-01
- 2021-10-01
- 2021-09-01-preview-
- 2021-06-01-preview-
- 2021-04-01-preview-
- 2020-07-01-preview-
- 2020-05-01
- 2018-10-01
- 2018-03-01-preview-
Bicep-resourcedefinitie
Het resourcetype signalR kan worden geïmplementeerd met bewerkingen die zijn gericht op:
- Resourcegroepen - Zie opdrachten voor de implementatie van resourcegroepen
Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.
Resource-indeling
Als u een Microsoft.SignalRService/signalR-resource wilt maken, voegt u de volgende Bicep toe aan uw sjabloon.
resource symbolicname 'Microsoft.SignalRService/signalR@2021-09-01-preview' = {
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
kind: 'string'
location: 'string'
name: 'string'
properties: {
cors: {
allowedOrigins: [
'string'
]
}
disableAadAuth: bool
disableLocalAuth: bool
features: [
{
flag: 'string'
properties: {
{customized property}: 'string'
}
value: 'string'
}
]
networkACLs: {
defaultAction: 'string'
privateEndpoints: [
{
allow: [
'string'
]
deny: [
'string'
]
name: 'string'
}
]
publicNetwork: {
allow: [
'string'
]
deny: [
'string'
]
}
}
publicNetworkAccess: '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'
}
tags: {
{customized property}: 'string'
}
}
Eigenschapswaarden
ManagedIdentity
| Naam | Beschrijving | Waarde |
|---|---|---|
| type | Vertegenwoordig het identiteitstype: systemAssigned, userAssigned, None | 'Geen' 'SystemAssigned' UserAssigned |
| userAssignedIdentities | De door de gebruiker toegewezen identiteiten ophalen of instellen | ManagedIdentityUserAssignedIdentities |
ManagedIdentitySettings
| Naam | Beschrijving | Waarde |
|---|---|---|
| hulpbron | De resource die de app-id-URI van de doelresource aangeeft. Het wordt ook weergegeven in de claim aud (doelgroep) van het uitgegeven token. |
snaar |
ManagedIdentityUserAssignedIdentities
| Naam | Beschrijving | Waarde |
|---|
Microsoft.SignalRService/signalR
| Naam | Beschrijving | Waarde | |||
|---|---|---|---|---|---|
| identiteit | Het antwoord van de beheerde identiteit | ManagedIdentity- | |||
| soort | Het type service, bijvoorbeeld 'SignalR' voor 'Microsoft.SignalRService/SignalR' | 'RawWebSockets' 'SignalR' |
|||
| plaats | De GEO-locatie van de resource. bijvoorbeeld VS - west | VS - oost | VS - noord-centraal | VS - zuid-centraal. | snaar |
| naam | De resourcenaam | tekenreeks (vereist) | |||
| Eigenschappen | Instellingen die worden gebruikt voor het inrichten of configureren van de resource | SignalRProperties- | |||
| Sku | De factureringsgegevens van de resource. (bijvoorbeeld Gratis, Standaard) | ResourceSku- | |||
| Tags | Resourcetags | Woordenlijst met tagnamen en -waarden. Zie Tags in sjablonen |
NetworkACL
| Naam | Beschrijving | Waarde |
|---|---|---|
| toestaan | Toegestane aanvraagtypen. De waarde kan een of meer zijn: ClientConnection, ServerConnection, RESTAPI. | Tekenreeksmatrix met een van de volgende waarden: 'ClientConnection' 'RESTAPI' 'ServerConnection' 'Traceren' |
| ontkennen | Geweigerde aanvraagtypen. De waarde kan een of meer zijn: ClientConnection, ServerConnection, RESTAPI. | Tekenreeksmatrix met een van de volgende waarden: 'ClientConnection' 'RESTAPI' 'ServerConnection' 'Traceren' |
PrivateEndpointACL
| Naam | Beschrijving | Waarde |
|---|---|---|
| toestaan | Toegestane aanvraagtypen. De waarde kan een of meer zijn: ClientConnection, ServerConnection, RESTAPI. | Tekenreeksmatrix met een van de volgende waarden: 'ClientConnection' 'RESTAPI' 'ServerConnection' 'Traceren' |
| ontkennen | Geweigerde aanvraagtypen. De waarde kan een of meer zijn: ClientConnection, ServerConnection, RESTAPI. | Tekenreeksmatrix met een van de volgende waarden: 'ClientConnection' 'RESTAPI' 'ServerConnection' 'Traceren' |
| naam | Naam van de privé-eindpuntverbinding | tekenreeks (vereist) |
ResourceSku
| Naam | Beschrijving | Waarde |
|---|---|---|
| capaciteit | Optioneel, geheel getal. Het aantal eenheden van de 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) |
| rang | Optionele laag van deze specifieke SKU. 'Standaard' of 'Gratis'. Basic is afgeschaft, gebruikt u in plaats daarvan Standard. |
'Basis' 'Gratis' 'Premium' 'Standaard' |
ServerlessUpstreamSettings
| Naam | Beschrijving | Waarde |
|---|---|---|
| Sjablonen | Hiermee haalt u de lijst met Upstream-URL-sjablonen op of stelt u deze in. Volgorde is belangrijk en de eerste overeenkomende sjabloon heeft gevolgen. | UpstreamTemplate[] |
SignalRCorsSettings
| Naam | Beschrijving | Waarde |
|---|---|---|
| allowedOrigins | Hiermee haalt u de lijst met oorsprongen op die moeten worden toegestaan om cross-origin-aanroepen te maken (bijvoorbeeld: http://example.com:12345). Gebruik *om alles toe te staan. Als u dit weglaat, staat u alle standaard toe. | tekenreeks[] |
SignalRFeature
| Naam | Beschrijving | Waarde |
|---|---|---|
| vlag | 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 achterwaartse compatibiliteit. Ondersteuning voor zowel de standaardmodus als de serverloze modus, maar wordt niet aanbevolen; "PredefinedOnly": voor toekomstig gebruik. - EnableConnectivityLogs: 'true'/'false', om respectievelijk de connectiviteitslogboekcategorie in of uit te schakelen. - EnableMessagingLogs: 'true'/'false', om respectievelijk de categorie connectiviteitslogboek in of uit te schakelen. - EnableLiveTrace: Met Live Trace kunt u weten wat er gebeurt in de Azure SignalR-service. Hiermee krijgt u live traceringen in realtime. Het is handig wanneer u uw eigen op Azure SignalR gebaseerde webtoepassing ontwikkelt of zelf problemen kunt oplossen. Houd er rekening mee dat livetraceringen worden geteld als uitgaande berichten die in rekening worden gebracht. Toegestane waarden: 'true'/'false' om de live traceringsfunctie in of uit te schakelen. |
EnableConnectivityLogs EnableLiveTrace 'EnableMessagingLogs' 'ServiceMode' (vereist) |
| Eigenschappen | Optionele eigenschappen met betrekking tot deze functie. | SignalRFeatureProperties- |
| waarde | Waarde van de functievlag. Zie het azure SignalR-servicedocument /azure/azure-signalr/ voor toegestane waarden. | snaar Beperkingen: Minimale lengte = 1 Maximale lengte = 1 (vereist) |
SignalRFeatureProperties
| Naam | Beschrijving | Waarde |
|---|
SignalRNetworkACLs
| Naam | Beschrijving | Waarde |
|---|---|---|
| defaultAction | Standaardactie wanneer geen andere regel overeenkomt | 'Toestaan' 'Weigeren' |
| privateEndpoints | ACL's voor aanvragen van privé-eindpunten | PrivateEndpointACL[] |
| publicNetwork | ACL voor aanvragen van een openbaar netwerk | NetworkACL- |
SignalRProperties
| Naam | Beschrijving | Waarde |
|---|---|---|
| cors | CORS-instellingen (Cross-Origin Resource Sharing). | SignalRCorsSettings |
| disableAadAuth | DisableLocalAuth AAD-verificatie in- of uitschakelen Als de instelling waar is, werkt de verbinding met AuthType=aad niet. |
Bool |
| disableLocalAuth | DisableLocalAuth Lokale verificatie in- of uitschakelen met AccessKey Als deze is ingesteld als waar, werkt de verbinding met AccessKey=xxx niet. |
Bool |
| Functies | Lijst met de featureFlags. 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, wordt de globaal standaardwaarde gebruikt Maar houd er rekening mee dat de standaardwaarde niet 'false' betekent. Het verschilt in termen van verschillende FeatureFlags. |
SignalRFeature[] |
| networkACLs | Netwerk-ACL's | SignalRNetworkACLs |
| publicNetworkAccess | Openbare netwerktoegang in- of uitschakelen. De standaardwaarde is Ingeschakeld. Wanneer deze functie is ingeschakeld, zijn netwerk-ACL's nog steeds van toepassing. Wanneer deze optie is uitgeschakeld, wordt openbare netwerktoegang altijd uitgeschakeld, ongeacht wat u instelt in netwerk-ACL's. |
snaar |
| tls | TLS-instellingen. | SignalRTlsSettings |
| stroomopwaarts | Upstream-instellingen wanneer de service zich in de serverloze modus bevindt. | ServerlessUpstreamSettings |
SignalRTlsSettings
| Naam | Beschrijving | Waarde |
|---|---|---|
| clientCertEnabled | Clientcertificaat aanvragen tijdens TLS-handshake indien ingeschakeld | Bool |
TrackedResourceTags
| Naam | Beschrijving | Waarde |
|---|
UpstreamAuthSettings
| Naam | Beschrijving | Waarde |
|---|---|---|
| managedIdentity | Hiermee haalt u de instellingen voor beheerde identiteit op of stelt u deze in. Dit is vereist als het verificatietype is ingesteld op ManagedIdentity. | ManagedIdentitySettings |
| type | Hiermee haalt u het type verificatie op of stelt u dit in. Geen of ManagedIdentity wordt nu ondersteund. | ManagedIdentity 'Geen' |
UpstreamTemplate
| Naam | Beschrijving | 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 haalt u het overeenkomende patroon voor categorienamen op of stelt u dit in. Als deze niet is ingesteld, komt deze overeen met een categorie. Er worden drie soorten patronen ondersteund: 1. "*", het overeenkomt met elke categorienaam 2. Combineer meerdere categorieën met ",", bijvoorbeeld "verbindingen,berichten", het komt overeen met categorie "verbindingen" en "berichten" 3. De naam van één categorie, bijvoorbeeld 'verbindingen', komt overeen met de categorie 'verbindingen' |
snaar |
| eventPattern | Hiermee haalt u het overeenkomende patroon voor gebeurtenisnamen op of stelt u dit in. Als deze niet is ingesteld, komt deze overeen met een gebeurtenis. Er worden drie soorten patronen ondersteund: 1. "*", 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' |
snaar |
| hubPattern | Hiermee haalt u het overeenkomende patroon voor hubnamen op of stelt u dit in. Als deze niet is ingesteld, komt deze overeen met een hub. Er worden drie soorten patronen ondersteund: 1. "*", het overeenkomt 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' |
snaar |
| urlTemplate | Hiermee haalt u de upstream-URL-sjabloon op of stelt u deze in. U kunt drie 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 http://example.com/{hub}/api/{event}, met een clientaanvraag van de hub chat verbinding maakt, wordt deze eerst post naar deze URL: http://example.com/chat/api/connect. |
tekenreeks (vereist) |
UserAssignedIdentityProperty
| Naam | Beschrijving | Waarde |
|---|
Quickstart-voorbeelden
In de volgende quickstartvoorbeelden wordt dit resourcetype geïmplementeerd.
| Bicep-bestand | 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 de implementatie van resourcegroepen
Zie logboek wijzigenvoor 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": "2021-09-01-preview",
"name": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
}
}
},
"kind": "string",
"location": "string",
"properties": {
"cors": {
"allowedOrigins": [ "string" ]
},
"disableAadAuth": "bool",
"disableLocalAuth": "bool",
"features": [
{
"flag": "string",
"properties": {
"{customized property}": "string"
},
"value": "string"
}
],
"networkACLs": {
"defaultAction": "string",
"privateEndpoints": [
{
"allow": [ "string" ],
"deny": [ "string" ],
"name": "string"
}
],
"publicNetwork": {
"allow": [ "string" ],
"deny": [ "string" ]
}
},
"publicNetworkAccess": "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"
},
"tags": {
"{customized property}": "string"
}
}
Eigenschapswaarden
ManagedIdentity
| Naam | Beschrijving | Waarde |
|---|---|---|
| type | Vertegenwoordig het identiteitstype: systemAssigned, userAssigned, None | 'Geen' 'SystemAssigned' UserAssigned |
| userAssignedIdentities | De door de gebruiker toegewezen identiteiten ophalen of instellen | ManagedIdentityUserAssignedIdentities |
ManagedIdentitySettings
| Naam | Beschrijving | Waarde |
|---|---|---|
| hulpbron | De resource die de app-id-URI van de doelresource aangeeft. Het wordt ook weergegeven in de claim aud (doelgroep) van het uitgegeven token. |
snaar |
ManagedIdentityUserAssignedIdentities
| Naam | Beschrijving | Waarde |
|---|
Microsoft.SignalRService/signalR
| Naam | Beschrijving | Waarde | |||
|---|---|---|---|---|---|
| apiVersion | De API-versie | '2021-09-01-preview' | |||
| identiteit | Het antwoord van de beheerde identiteit | ManagedIdentity- | |||
| soort | Het type service, bijvoorbeeld 'SignalR' voor 'Microsoft.SignalRService/SignalR' | 'RawWebSockets' 'SignalR' |
|||
| plaats | De GEO-locatie van de resource. bijvoorbeeld VS - west | VS - oost | VS - noord-centraal | VS - zuid-centraal. | snaar |
| naam | De resourcenaam | tekenreeks (vereist) | |||
| Eigenschappen | Instellingen die worden gebruikt voor het inrichten of configureren van de resource | SignalRProperties- | |||
| Sku | De factureringsgegevens van de resource. (bijvoorbeeld Gratis, Standaard) | ResourceSku- | |||
| Tags | Resourcetags | Woordenlijst met tagnamen en -waarden. Zie Tags in sjablonen | |||
| type | Het resourcetype | 'Microsoft.SignalRService/signalR' |
NetworkACL
| Naam | Beschrijving | Waarde |
|---|---|---|
| toestaan | Toegestane aanvraagtypen. De waarde kan een of meer zijn: ClientConnection, ServerConnection, RESTAPI. | Tekenreeksmatrix met een van de volgende waarden: 'ClientConnection' 'RESTAPI' 'ServerConnection' 'Traceren' |
| ontkennen | Geweigerde aanvraagtypen. De waarde kan een of meer zijn: ClientConnection, ServerConnection, RESTAPI. | Tekenreeksmatrix met een van de volgende waarden: 'ClientConnection' 'RESTAPI' 'ServerConnection' 'Traceren' |
PrivateEndpointACL
| Naam | Beschrijving | Waarde |
|---|---|---|
| toestaan | Toegestane aanvraagtypen. De waarde kan een of meer zijn: ClientConnection, ServerConnection, RESTAPI. | Tekenreeksmatrix met een van de volgende waarden: 'ClientConnection' 'RESTAPI' 'ServerConnection' 'Traceren' |
| ontkennen | Geweigerde aanvraagtypen. De waarde kan een of meer zijn: ClientConnection, ServerConnection, RESTAPI. | Tekenreeksmatrix met een van de volgende waarden: 'ClientConnection' 'RESTAPI' 'ServerConnection' 'Traceren' |
| naam | Naam van de privé-eindpuntverbinding | tekenreeks (vereist) |
ResourceSku
| Naam | Beschrijving | Waarde |
|---|---|---|
| capaciteit | Optioneel, geheel getal. Het aantal eenheden van de 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) |
| rang | Optionele laag van deze specifieke SKU. 'Standaard' of 'Gratis'. Basic is afgeschaft, gebruikt u in plaats daarvan Standard. |
'Basis' 'Gratis' 'Premium' 'Standaard' |
ServerlessUpstreamSettings
| Naam | Beschrijving | Waarde |
|---|---|---|
| Sjablonen | Hiermee haalt u de lijst met Upstream-URL-sjablonen op of stelt u deze in. Volgorde is belangrijk en de eerste overeenkomende sjabloon heeft gevolgen. | UpstreamTemplate[] |
SignalRCorsSettings
| Naam | Beschrijving | Waarde |
|---|---|---|
| allowedOrigins | Hiermee haalt u de lijst met oorsprongen op die moeten worden toegestaan om cross-origin-aanroepen te maken (bijvoorbeeld: http://example.com:12345). Gebruik *om alles toe te staan. Als u dit weglaat, staat u alle standaard toe. | tekenreeks[] |
SignalRFeature
| Naam | Beschrijving | Waarde |
|---|---|---|
| vlag | 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 achterwaartse compatibiliteit. Ondersteuning voor zowel de standaardmodus als de serverloze modus, maar wordt niet aanbevolen; "PredefinedOnly": voor toekomstig gebruik. - EnableConnectivityLogs: 'true'/'false', om respectievelijk de connectiviteitslogboekcategorie in of uit te schakelen. - EnableMessagingLogs: 'true'/'false', om respectievelijk de categorie connectiviteitslogboek in of uit te schakelen. - EnableLiveTrace: Met Live Trace kunt u weten wat er gebeurt in de Azure SignalR-service. Hiermee krijgt u live traceringen in realtime. Het is handig wanneer u uw eigen op Azure SignalR gebaseerde webtoepassing ontwikkelt of zelf problemen kunt oplossen. Houd er rekening mee dat livetraceringen worden geteld als uitgaande berichten die in rekening worden gebracht. Toegestane waarden: 'true'/'false' om de live traceringsfunctie in of uit te schakelen. |
EnableConnectivityLogs EnableLiveTrace 'EnableMessagingLogs' 'ServiceMode' (vereist) |
| Eigenschappen | Optionele eigenschappen met betrekking tot deze functie. | SignalRFeatureProperties- |
| waarde | Waarde van de functievlag. Zie het azure SignalR-servicedocument /azure/azure-signalr/ voor toegestane waarden. | snaar Beperkingen: Minimale lengte = 1 Maximale lengte = 1 (vereist) |
SignalRFeatureProperties
| Naam | Beschrijving | Waarde |
|---|
SignalRNetworkACLs
| Naam | Beschrijving | Waarde |
|---|---|---|
| defaultAction | Standaardactie wanneer geen andere regel overeenkomt | 'Toestaan' 'Weigeren' |
| privateEndpoints | ACL's voor aanvragen van privé-eindpunten | PrivateEndpointACL[] |
| publicNetwork | ACL voor aanvragen van een openbaar netwerk | NetworkACL- |
SignalRProperties
| Naam | Beschrijving | Waarde |
|---|---|---|
| cors | CORS-instellingen (Cross-Origin Resource Sharing). | SignalRCorsSettings |
| disableAadAuth | DisableLocalAuth AAD-verificatie in- of uitschakelen Als de instelling waar is, werkt de verbinding met AuthType=aad niet. |
Bool |
| disableLocalAuth | DisableLocalAuth Lokale verificatie in- of uitschakelen met AccessKey Als deze is ingesteld als waar, werkt de verbinding met AccessKey=xxx niet. |
Bool |
| Functies | Lijst met de featureFlags. 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, wordt de globaal standaardwaarde gebruikt Maar houd er rekening mee dat de standaardwaarde niet 'false' betekent. Het verschilt in termen van verschillende FeatureFlags. |
SignalRFeature[] |
| networkACLs | Netwerk-ACL's | SignalRNetworkACLs |
| publicNetworkAccess | Openbare netwerktoegang in- of uitschakelen. De standaardwaarde is Ingeschakeld. Wanneer deze functie is ingeschakeld, zijn netwerk-ACL's nog steeds van toepassing. Wanneer deze optie is uitgeschakeld, wordt openbare netwerktoegang altijd uitgeschakeld, ongeacht wat u instelt in netwerk-ACL's. |
snaar |
| tls | TLS-instellingen. | SignalRTlsSettings |
| stroomopwaarts | Upstream-instellingen wanneer de service zich in de serverloze modus bevindt. | ServerlessUpstreamSettings |
SignalRTlsSettings
| Naam | Beschrijving | Waarde |
|---|---|---|
| clientCertEnabled | Clientcertificaat aanvragen tijdens TLS-handshake indien ingeschakeld | Bool |
TrackedResourceTags
| Naam | Beschrijving | Waarde |
|---|
UpstreamAuthSettings
| Naam | Beschrijving | Waarde |
|---|---|---|
| managedIdentity | Hiermee haalt u de instellingen voor beheerde identiteit op of stelt u deze in. Dit is vereist als het verificatietype is ingesteld op ManagedIdentity. | ManagedIdentitySettings |
| type | Hiermee haalt u het type verificatie op of stelt u dit in. Geen of ManagedIdentity wordt nu ondersteund. | ManagedIdentity 'Geen' |
UpstreamTemplate
| Naam | Beschrijving | 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 haalt u het overeenkomende patroon voor categorienamen op of stelt u dit in. Als deze niet is ingesteld, komt deze overeen met een categorie. Er worden drie soorten patronen ondersteund: 1. "*", het overeenkomt met elke categorienaam 2. Combineer meerdere categorieën met ",", bijvoorbeeld "verbindingen,berichten", het komt overeen met categorie "verbindingen" en "berichten" 3. De naam van één categorie, bijvoorbeeld 'verbindingen', komt overeen met de categorie 'verbindingen' |
snaar |
| eventPattern | Hiermee haalt u het overeenkomende patroon voor gebeurtenisnamen op of stelt u dit in. Als deze niet is ingesteld, komt deze overeen met een gebeurtenis. Er worden drie soorten patronen ondersteund: 1. "*", 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' |
snaar |
| hubPattern | Hiermee haalt u het overeenkomende patroon voor hubnamen op of stelt u dit in. Als deze niet is ingesteld, komt deze overeen met een hub. Er worden drie soorten patronen ondersteund: 1. "*", het overeenkomt 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' |
snaar |
| urlTemplate | Hiermee haalt u de upstream-URL-sjabloon op of stelt u deze in. U kunt drie 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 http://example.com/{hub}/api/{event}, met een clientaanvraag van de hub chat verbinding maakt, wordt deze eerst post naar deze URL: http://example.com/chat/api/connect. |
tekenreeks (vereist) |
UserAssignedIdentityProperty
| Naam | Beschrijving | Waarde |
|---|
Quickstart-sjablonen
Met de volgende quickstart-sjablonen wordt dit resourcetype geïmplementeerd.
| Sjabloon | 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 logboek wijzigenvoor 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@2021-09-01-preview"
name = "string"
identity = {
type = "string"
userAssignedIdentities = {
{customized property} = {
}
}
}
kind = "string"
location = "string"
body = jsonencode({
properties = {
cors = {
allowedOrigins = [
"string"
]
}
disableAadAuth = bool
disableLocalAuth = bool
features = [
{
flag = "string"
properties = {
{customized property} = "string"
}
value = "string"
}
]
networkACLs = {
defaultAction = "string"
privateEndpoints = [
{
allow = [
"string"
]
deny = [
"string"
]
name = "string"
}
]
publicNetwork = {
allow = [
"string"
]
deny = [
"string"
]
}
}
publicNetworkAccess = "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"
}
tags = {
{customized property} = "string"
}
}
Eigenschapswaarden
ManagedIdentity
| Naam | Beschrijving | Waarde |
|---|---|---|
| type | Vertegenwoordig het identiteitstype: systemAssigned, userAssigned, None | 'Geen' 'SystemAssigned' UserAssigned |
| userAssignedIdentities | De door de gebruiker toegewezen identiteiten ophalen of instellen | ManagedIdentityUserAssignedIdentities |
ManagedIdentitySettings
| Naam | Beschrijving | Waarde |
|---|---|---|
| hulpbron | De resource die de app-id-URI van de doelresource aangeeft. Het wordt ook weergegeven in de claim aud (doelgroep) van het uitgegeven token. |
snaar |
ManagedIdentityUserAssignedIdentities
| Naam | Beschrijving | Waarde |
|---|
Microsoft.SignalRService/signalR
| Naam | Beschrijving | Waarde | |||
|---|---|---|---|---|---|
| identiteit | Het antwoord van de beheerde identiteit | ManagedIdentity- | |||
| soort | Het type service, bijvoorbeeld 'SignalR' voor 'Microsoft.SignalRService/SignalR' | 'RawWebSockets' 'SignalR' |
|||
| plaats | De GEO-locatie van de resource. bijvoorbeeld VS - west | VS - oost | VS - noord-centraal | VS - zuid-centraal. | snaar |
| naam | De resourcenaam | tekenreeks (vereist) | |||
| Eigenschappen | Instellingen die worden gebruikt voor het inrichten of configureren van de resource | SignalRProperties- | |||
| Sku | De factureringsgegevens van de resource. (bijvoorbeeld Gratis, Standaard) | ResourceSku- | |||
| Tags | Resourcetags | Woordenlijst met tagnamen en -waarden. | |||
| type | Het resourcetype | "Microsoft.SignalRService/signalR@2021-09-01-preview" |
NetworkACL
| Naam | Beschrijving | Waarde |
|---|---|---|
| toestaan | Toegestane aanvraagtypen. De waarde kan een of meer zijn: ClientConnection, ServerConnection, RESTAPI. | Tekenreeksmatrix met een van de volgende waarden: 'ClientConnection' 'RESTAPI' 'ServerConnection' 'Traceren' |
| ontkennen | Geweigerde aanvraagtypen. De waarde kan een of meer zijn: ClientConnection, ServerConnection, RESTAPI. | Tekenreeksmatrix met een van de volgende waarden: 'ClientConnection' 'RESTAPI' 'ServerConnection' 'Traceren' |
PrivateEndpointACL
| Naam | Beschrijving | Waarde |
|---|---|---|
| toestaan | Toegestane aanvraagtypen. De waarde kan een of meer zijn: ClientConnection, ServerConnection, RESTAPI. | Tekenreeksmatrix met een van de volgende waarden: 'ClientConnection' 'RESTAPI' 'ServerConnection' 'Traceren' |
| ontkennen | Geweigerde aanvraagtypen. De waarde kan een of meer zijn: ClientConnection, ServerConnection, RESTAPI. | Tekenreeksmatrix met een van de volgende waarden: 'ClientConnection' 'RESTAPI' 'ServerConnection' 'Traceren' |
| naam | Naam van de privé-eindpuntverbinding | tekenreeks (vereist) |
ResourceSku
| Naam | Beschrijving | Waarde |
|---|---|---|
| capaciteit | Optioneel, geheel getal. Het aantal eenheden van de 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) |
| rang | Optionele laag van deze specifieke SKU. 'Standaard' of 'Gratis'. Basic is afgeschaft, gebruikt u in plaats daarvan Standard. |
'Basis' 'Gratis' 'Premium' 'Standaard' |
ServerlessUpstreamSettings
| Naam | Beschrijving | Waarde |
|---|---|---|
| Sjablonen | Hiermee haalt u de lijst met Upstream-URL-sjablonen op of stelt u deze in. Volgorde is belangrijk en de eerste overeenkomende sjabloon heeft gevolgen. | UpstreamTemplate[] |
SignalRCorsSettings
| Naam | Beschrijving | Waarde |
|---|---|---|
| allowedOrigins | Hiermee haalt u de lijst met oorsprongen op die moeten worden toegestaan om cross-origin-aanroepen te maken (bijvoorbeeld: http://example.com:12345). Gebruik *om alles toe te staan. Als u dit weglaat, staat u alle standaard toe. | tekenreeks[] |
SignalRFeature
| Naam | Beschrijving | Waarde |
|---|---|---|
| vlag | 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 achterwaartse compatibiliteit. Ondersteuning voor zowel de standaardmodus als de serverloze modus, maar wordt niet aanbevolen; "PredefinedOnly": voor toekomstig gebruik. - EnableConnectivityLogs: 'true'/'false', om respectievelijk de connectiviteitslogboekcategorie in of uit te schakelen. - EnableMessagingLogs: 'true'/'false', om respectievelijk de categorie connectiviteitslogboek in of uit te schakelen. - EnableLiveTrace: Met Live Trace kunt u weten wat er gebeurt in de Azure SignalR-service. Hiermee krijgt u live traceringen in realtime. Het is handig wanneer u uw eigen op Azure SignalR gebaseerde webtoepassing ontwikkelt of zelf problemen kunt oplossen. Houd er rekening mee dat livetraceringen worden geteld als uitgaande berichten die in rekening worden gebracht. Toegestane waarden: 'true'/'false' om de live traceringsfunctie in of uit te schakelen. |
EnableConnectivityLogs EnableLiveTrace 'EnableMessagingLogs' 'ServiceMode' (vereist) |
| Eigenschappen | Optionele eigenschappen met betrekking tot deze functie. | SignalRFeatureProperties- |
| waarde | Waarde van de functievlag. Zie het azure SignalR-servicedocument /azure/azure-signalr/ voor toegestane waarden. | snaar Beperkingen: Minimale lengte = 1 Maximale lengte = 1 (vereist) |
SignalRFeatureProperties
| Naam | Beschrijving | Waarde |
|---|
SignalRNetworkACLs
| Naam | Beschrijving | Waarde |
|---|---|---|
| defaultAction | Standaardactie wanneer geen andere regel overeenkomt | 'Toestaan' 'Weigeren' |
| privateEndpoints | ACL's voor aanvragen van privé-eindpunten | PrivateEndpointACL[] |
| publicNetwork | ACL voor aanvragen van een openbaar netwerk | NetworkACL- |
SignalRProperties
| Naam | Beschrijving | Waarde |
|---|---|---|
| cors | CORS-instellingen (Cross-Origin Resource Sharing). | SignalRCorsSettings |
| disableAadAuth | DisableLocalAuth AAD-verificatie in- of uitschakelen Als de instelling waar is, werkt de verbinding met AuthType=aad niet. |
Bool |
| disableLocalAuth | DisableLocalAuth Lokale verificatie in- of uitschakelen met AccessKey Als deze is ingesteld als waar, werkt de verbinding met AccessKey=xxx niet. |
Bool |
| Functies | Lijst met de featureFlags. 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, wordt de globaal standaardwaarde gebruikt Maar houd er rekening mee dat de standaardwaarde niet 'false' betekent. Het verschilt in termen van verschillende FeatureFlags. |
SignalRFeature[] |
| networkACLs | Netwerk-ACL's | SignalRNetworkACLs |
| publicNetworkAccess | Openbare netwerktoegang in- of uitschakelen. De standaardwaarde is Ingeschakeld. Wanneer deze functie is ingeschakeld, zijn netwerk-ACL's nog steeds van toepassing. Wanneer deze optie is uitgeschakeld, wordt openbare netwerktoegang altijd uitgeschakeld, ongeacht wat u instelt in netwerk-ACL's. |
snaar |
| tls | TLS-instellingen. | SignalRTlsSettings |
| stroomopwaarts | Upstream-instellingen wanneer de service zich in de serverloze modus bevindt. | ServerlessUpstreamSettings |
SignalRTlsSettings
| Naam | Beschrijving | Waarde |
|---|---|---|
| clientCertEnabled | Clientcertificaat aanvragen tijdens TLS-handshake indien ingeschakeld | Bool |
TrackedResourceTags
| Naam | Beschrijving | Waarde |
|---|
UpstreamAuthSettings
| Naam | Beschrijving | Waarde |
|---|---|---|
| managedIdentity | Hiermee haalt u de instellingen voor beheerde identiteit op of stelt u deze in. Dit is vereist als het verificatietype is ingesteld op ManagedIdentity. | ManagedIdentitySettings |
| type | Hiermee haalt u het type verificatie op of stelt u dit in. Geen of ManagedIdentity wordt nu ondersteund. | ManagedIdentity 'Geen' |
UpstreamTemplate
| Naam | Beschrijving | 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 haalt u het overeenkomende patroon voor categorienamen op of stelt u dit in. Als deze niet is ingesteld, komt deze overeen met een categorie. Er worden drie soorten patronen ondersteund: 1. "*", het overeenkomt met elke categorienaam 2. Combineer meerdere categorieën met ",", bijvoorbeeld "verbindingen,berichten", het komt overeen met categorie "verbindingen" en "berichten" 3. De naam van één categorie, bijvoorbeeld 'verbindingen', komt overeen met de categorie 'verbindingen' |
snaar |
| eventPattern | Hiermee haalt u het overeenkomende patroon voor gebeurtenisnamen op of stelt u dit in. Als deze niet is ingesteld, komt deze overeen met een gebeurtenis. Er worden drie soorten patronen ondersteund: 1. "*", 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' |
snaar |
| hubPattern | Hiermee haalt u het overeenkomende patroon voor hubnamen op of stelt u dit in. Als deze niet is ingesteld, komt deze overeen met een hub. Er worden drie soorten patronen ondersteund: 1. "*", het overeenkomt 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' |
snaar |
| urlTemplate | Hiermee haalt u de upstream-URL-sjabloon op of stelt u deze in. U kunt drie 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 http://example.com/{hub}/api/{event}, met een clientaanvraag van de hub chat verbinding maakt, wordt deze eerst post naar deze URL: http://example.com/chat/api/connect. |
tekenreeks (vereist) |
UserAssignedIdentityProperty
| Naam | Beschrijving | Waarde |
|---|