Skip to content

Commit 03171ee

Browse files
authored
Merge pull request #105 from zackliu/csharpsample
Add C# sample for Event Grid integration
2 parents 86c32d9 + eb71a5a commit 03171ee

File tree

6 files changed

+504
-4
lines changed

6 files changed

+504
-4
lines changed

samples/EventGridIntegration/README.md

Lines changed: 32 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ A step by step tutorial to build a chat room with real-time online counting usin
1313

1414
The following softwares are required to build this tutorial.
1515

16-
* [Node.js](https://nodejs.org/en/download/) (Version 10.x)
16+
* [Node.js](https://nodejs.org/en/download/) (Version 10.x, required for JavaScript sample)
1717
* [.NET SDK](https://www.microsoft.com/net/download) (Version 2.x, required for Functions extensions)
1818
* [Azure Functions Core Tools](https://github.com/Azure/azure-functions-core-tools) (Version 2)
1919
* [Azure CLI](https://docs.microsoft.com/en-us/cli/azure/install-azure-cli?view=azure-cli-latest)
@@ -51,15 +51,25 @@ An Azure Storage account is required by a function app using Event Grid trigger.
5151

5252
```bash
5353
git clone [email protected]:aspnet/AzureSignalR-samples.git
54+
```
55+
56+
- In the repository, there're two Event Grid integration samples using different languages. For the JavaScript sample, navigate to
5457
55-
cd AzureSignalR-samples/samples/EventGridIntegration/javascript
58+
```bash
59+
AzureSignalR-samples/samples/EventGridIntegration/javascript
60+
```
61+
62+
- If you want to use C# sample, navigate to
63+
64+
```bash
65+
AzureSignalR-samples/samples/EventGridIntegration/csharp
5666
```
5767
5868
### Configure application settings
5969
6070
When running and debugging the Azure Functions runtime locally, application settings are read from **local.settings.json**. Also, you can upload there settings to remote when you try to deploy Function App to Azure. Update this file with the connection string of the SignalR Service instance that you created earlier.
6171
62-
1. Open the file **local.settings.json** and update the settings.
72+
1. Open the file **local.settings.json** and update the settings. (The file shown below is used by JavaScript sample, and the C# sample is similar)
6373
6474
```json
6575
{
@@ -232,7 +242,25 @@ App Service Authentication supports authentication with Azure Active Directory,
232242
233243
### Update negotiate function
234244
235-
1. Update in `userId` in `negotiate/function.json` to `"{headers.x-ms-client-principal-name}"`
245+
1. Update the attribute parameter of negotiate function.
246+
247+
- If you're using JavaScript sample, update in `userId` in `negotiate/function.json` to `"{headers.x-ms-client-principal-name}"`.
248+
249+
```json
250+
{
251+
"type": "signalRConnectionInfo",
252+
"name": "connectionInfo",
253+
"userId": "{headers.x-ms-client-principal-name}",
254+
"hubName": "EventGridIntegrationSampleChat",
255+
"direction": "in"
256+
}
257+
```
258+
259+
- If you're using C# sample, add parameter `UserId = "{headers.x-ms-signalr-userid}"` to `Negotiate` function.
260+
261+
```C#
262+
[SignalRConnectionInfo(HubName = HubName, UserId = "{headers.x-ms-signalr-userid}")] SignalRConnectionInfo connectionInfo
263+
```
236264
237265
1. Deploy the function to Azure again
238266
Lines changed: 264 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,264 @@
1+
## Ignore Visual Studio temporary files, build results, and
2+
## files generated by popular Visual Studio add-ons.
3+
4+
# Azure Functions localsettings file
5+
local.settings.json
6+
7+
# User-specific files
8+
*.suo
9+
*.user
10+
*.userosscache
11+
*.sln.docstates
12+
13+
# User-specific files (MonoDevelop/Xamarin Studio)
14+
*.userprefs
15+
16+
# Build results
17+
[Dd]ebug/
18+
[Dd]ebugPublic/
19+
[Rr]elease/
20+
[Rr]eleases/
21+
x64/
22+
x86/
23+
bld/
24+
[Bb]in/
25+
[Oo]bj/
26+
[Ll]og/
27+
28+
# Visual Studio 2015 cache/options directory
29+
.vs/
30+
# Uncomment if you have tasks that create the project's static files in wwwroot
31+
#wwwroot/
32+
33+
# MSTest test Results
34+
[Tt]est[Rr]esult*/
35+
[Bb]uild[Ll]og.*
36+
37+
# NUNIT
38+
*.VisualState.xml
39+
TestResult.xml
40+
41+
# Build Results of an ATL Project
42+
[Dd]ebugPS/
43+
[Rr]eleasePS/
44+
dlldata.c
45+
46+
# DNX
47+
project.lock.json
48+
project.fragment.lock.json
49+
artifacts/
50+
51+
*_i.c
52+
*_p.c
53+
*_i.h
54+
*.ilk
55+
*.meta
56+
*.obj
57+
*.pch
58+
*.pdb
59+
*.pgc
60+
*.pgd
61+
*.rsp
62+
*.sbr
63+
*.tlb
64+
*.tli
65+
*.tlh
66+
*.tmp
67+
*.tmp_proj
68+
*.log
69+
*.vspscc
70+
*.vssscc
71+
.builds
72+
*.pidb
73+
*.svclog
74+
*.scc
75+
76+
# Chutzpah Test files
77+
_Chutzpah*
78+
79+
# Visual C++ cache files
80+
ipch/
81+
*.aps
82+
*.ncb
83+
*.opendb
84+
*.opensdf
85+
*.sdf
86+
*.cachefile
87+
*.VC.db
88+
*.VC.VC.opendb
89+
90+
# Visual Studio profiler
91+
*.psess
92+
*.vsp
93+
*.vspx
94+
*.sap
95+
96+
# TFS 2012 Local Workspace
97+
$tf/
98+
99+
# Guidance Automation Toolkit
100+
*.gpState
101+
102+
# ReSharper is a .NET coding add-in
103+
_ReSharper*/
104+
*.[Rr]e[Ss]harper
105+
*.DotSettings.user
106+
107+
# JustCode is a .NET coding add-in
108+
.JustCode
109+
110+
# TeamCity is a build add-in
111+
_TeamCity*
112+
113+
# DotCover is a Code Coverage Tool
114+
*.dotCover
115+
116+
# NCrunch
117+
_NCrunch_*
118+
.*crunch*.local.xml
119+
nCrunchTemp_*
120+
121+
# MightyMoose
122+
*.mm.*
123+
AutoTest.Net/
124+
125+
# Web workbench (sass)
126+
.sass-cache/
127+
128+
# Installshield output folder
129+
[Ee]xpress/
130+
131+
# DocProject is a documentation generator add-in
132+
DocProject/buildhelp/
133+
DocProject/Help/*.HxT
134+
DocProject/Help/*.HxC
135+
DocProject/Help/*.hhc
136+
DocProject/Help/*.hhk
137+
DocProject/Help/*.hhp
138+
DocProject/Help/Html2
139+
DocProject/Help/html
140+
141+
# Click-Once directory
142+
publish/
143+
144+
# Publish Web Output
145+
*.[Pp]ublish.xml
146+
*.azurePubxml
147+
# TODO: Comment the next line if you want to checkin your web deploy settings
148+
# but database connection strings (with potential passwords) will be unencrypted
149+
#*.pubxml
150+
*.publishproj
151+
152+
# Microsoft Azure Web App publish settings. Comment the next line if you want to
153+
# checkin your Azure Web App publish settings, but sensitive information contained
154+
# in these scripts will be unencrypted
155+
PublishScripts/
156+
157+
# NuGet Packages
158+
*.nupkg
159+
# The packages folder can be ignored because of Package Restore
160+
**/packages/*
161+
# except build/, which is used as an MSBuild target.
162+
!**/packages/build/
163+
# Uncomment if necessary however generally it will be regenerated when needed
164+
#!**/packages/repositories.config
165+
# NuGet v3's project.json files produces more ignoreable files
166+
*.nuget.props
167+
*.nuget.targets
168+
169+
# Microsoft Azure Build Output
170+
csx/
171+
*.build.csdef
172+
173+
# Microsoft Azure Emulator
174+
ecf/
175+
rcf/
176+
177+
# Windows Store app package directories and files
178+
AppPackages/
179+
BundleArtifacts/
180+
Package.StoreAssociation.xml
181+
_pkginfo.txt
182+
183+
# Visual Studio cache files
184+
# files ending in .cache can be ignored
185+
*.[Cc]ache
186+
# but keep track of directories ending in .cache
187+
!*.[Cc]ache/
188+
189+
# Others
190+
ClientBin/
191+
~$*
192+
*~
193+
*.dbmdl
194+
*.dbproj.schemaview
195+
*.jfm
196+
*.pfx
197+
*.publishsettings
198+
node_modules/
199+
orleans.codegen.cs
200+
201+
# Since there are multiple workflows, uncomment next line to ignore bower_components
202+
# (https://github.com/github/gitignore/pull/1529#issuecomment-104372622)
203+
#bower_components/
204+
205+
# RIA/Silverlight projects
206+
Generated_Code/
207+
208+
# Backup & report files from converting an old project file
209+
# to a newer Visual Studio version. Backup files are not needed,
210+
# because we have git ;-)
211+
_UpgradeReport_Files/
212+
Backup*/
213+
UpgradeLog*.XML
214+
UpgradeLog*.htm
215+
216+
# SQL Server files
217+
*.mdf
218+
*.ldf
219+
220+
# Business Intelligence projects
221+
*.rdl.data
222+
*.bim.layout
223+
*.bim_*.settings
224+
225+
# Microsoft Fakes
226+
FakesAssemblies/
227+
228+
# GhostDoc plugin setting file
229+
*.GhostDoc.xml
230+
231+
# Node.js Tools for Visual Studio
232+
.ntvs_analysis.dat
233+
234+
# Visual Studio 6 build log
235+
*.plg
236+
237+
# Visual Studio 6 workspace options file
238+
*.opt
239+
240+
# Visual Studio LightSwitch build output
241+
**/*.HTMLClient/GeneratedArtifacts
242+
**/*.DesktopClient/GeneratedArtifacts
243+
**/*.DesktopClient/ModelManifest.xml
244+
**/*.Server/GeneratedArtifacts
245+
**/*.Server/ModelManifest.xml
246+
_Pvt_Extensions
247+
248+
# Paket dependency manager
249+
.paket/paket.exe
250+
paket-files/
251+
252+
# FAKE - F# Make
253+
.fake/
254+
255+
# JetBrains Rider
256+
.idea/
257+
*.sln.iml
258+
259+
# CodeRush
260+
.cr/
261+
262+
# Python Tools for Visual Studio (PTVS)
263+
__pycache__/
264+
*.pyc

0 commit comments

Comments
 (0)