Skip to content

[Web PubSub] Add web pubsub stable version 2021-10-01 #16045

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ruowan merged 3 commits into from
Sep 26, 2021
Merged

[Web PubSub] Add web pubsub stable version 2021-10-01 #16045

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
209a110
Add web pubsub stable version 2021-10-01
zackliu Sep 15, 2021
7c3f2e7
Fix structure
zackliu Sep 15, 2021
15c8112
Update swagger
zackliu Sep 23, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions ...resource-manager/Microsoft.SignalRService/stable/2021-10-01/examples/Operations_List.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
{
"parameters": {
"api-version": "2021-10-01"
},
"responses": {
"200": {
"body": {
"value": [
{
"name": "Microsoft.SignalRService/WebPubSub/read",
"isDataAction": false,
"display": {
"provider": "Microsoft.SignalRService",
"resource": "WebPubSub",
"operation": "Manage WebPubSub (read-only)",
"description": "View the resource settings and configurations in the management portal or through API"
},
"properties": {}
}
],
"nextLink": "providers/Microsoft.SignalRService?$skipToken={opaqueString}"
}
}
}
}
36 changes: 36 additions & 0 deletions ...sub/resource-manager/Microsoft.SignalRService/stable/2021-10-01/examples/Usages_List.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
{
"parameters": {
"location": "eastus",
"api-version": "2021-10-01",
"subscriptionId": "00000000-0000-0000-0000-000000000000"
},
"responses": {
"200": {
"body": {
"value": [
{
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.SignalRService/locations/eastus/usages/Usage1",
"currentValue": 0,
"limit": 100,
"name": {
"value": "Usage1",
"localizedValue": "Usage1"
},
"unit": "Count"
},
{
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.SignalRService/locations/eastus/usages/Usage2",
"currentValue": 0,
"limit": 100,
"name": {
"value": "Usage2",
"localizedValue": "Usage2"
},
"unit": "Count"
}
],
"nextLink": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToMoreResults..."
}
}
}
}
72 changes: 72 additions & 0 deletions ...soft.SignalRService/stable/2021-10-01/examples/WebPubSubEventHandlers_CreateOrUpdate.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
{
"parameters": {
"parameters": {
"properties": {
"urlTemplate": "http://host.com",
"userEventPattern": "*",
"systemEvents": [
"connect",
"connected"
],
"auth": {
"type": "ManagedIdentity",
"managedIdentity": {
"resource": "abc"
}
}
}
},
"api-version": "2021-10-01",
"subscriptionId": "00000000-0000-0000-0000-000000000000",
"resourceGroupName": "myResourceGroup",
"resourceName": "myWebPubSubService",
"hubName": "exampleHub",
"eventHandlerName": "exampleEventHandler"
},
"responses": {
"200": {
"body": {
"properties": {
"urlTemplate": "http://host.com",
"userEventPattern": "*",
"systemEvents": [
"connect",
"connected"
],
"auth": {
"type": "ManagedIdentity",
"managedIdentity": {
"resource": "abc"
}
}
},
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/hubs/exampleHub/eventHandlers/exampleEventHandler",
"name": "exampleEventHandler"
}
},
"201": {
"body": {
"properties": {
"urlTemplate": "http://host.com",
"userEventPattern": "*",
"systemEvents": [
"connect",
"connected"
],
"auth": {
"type": "ManagedIdentity",
"managedIdentity": {
"resource": "abc"
}
}
},
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/hubs/exampleHub/eventHandlers/exampleEventHandler",
"name": "exampleEventHandler"
},
"headers": {
"Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...",
"Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus..."
}
}
}
}
20 changes: 20 additions & 0 deletions ...er/Microsoft.SignalRService/stable/2021-10-01/examples/WebPubSubEventHandlers_Delete.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
{
"parameters": {
"api-version": "2021-10-01",
"subscriptionId": "00000000-0000-0000-0000-000000000000",
"resourceGroupName": "myResourceGroup",
"resourceName": "myWebPubSubService",
"hubName": "exampleHub",
"eventHandlerName": "exampleEventHandler"
},
"responses": {
"200": {},
"202": {
"headers": {
"Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...",
"Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus..."
}
},
"204": {}
}
}
32 changes: 32 additions & 0 deletions ...nager/Microsoft.SignalRService/stable/2021-10-01/examples/WebPubSubEventHandlers_Get.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
{
"parameters": {
"api-version": "2021-10-01",
"subscriptionId": "00000000-0000-0000-0000-000000000000",
"resourceGroupName": "myResourceGroup",
"resourceName": "myWebPubSubService",
"hubName": "exampleHub",
"eventHandlerName": "exampleEventHandler"
},
"responses": {
"200": {
"body": {
"properties": {
"urlTemplate": "http://host.com",
"userEventPattern": "*",
"systemEvents": [
"connect",
"connected"
],
"auth": {
"type": "ManagedIdentity",
"managedIdentity": {
"resource": "abc"
}
}
},
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/hubs/exampleHub/eventHandlers/exampleEventHandler",
"name": "exampleEventHandler"
}
}
}
}
35 changes: 35 additions & 0 deletions ...ager/Microsoft.SignalRService/stable/2021-10-01/examples/WebPubSubEventHandlers_List.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
{
"parameters": {
"api-version": "2021-10-01",
"subscriptionId": "00000000-0000-0000-0000-000000000000",
"resourceGroupName": "myResourceGroup",
"resourceName": "myWebPubSubService",
"hubName": "exampleHub"
},
"responses": {
"200": {
"body": {
"value": [
{
"properties": {
"urlTemplate": "http://host.com",
"userEventPattern": "*",
"systemEvents": [
"connect",
"connected"
],
"auth": {
"type": "ManagedIdentity",
"managedIdentity": {
"resource": "abc"
}
}
},
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/hubs/exampleHub/eventHandlers/exampleEventHandler",
"name": "exampleEventHandler"
}
]
}
}
}
}
93 changes: 93 additions & 0 deletions ...ger/Microsoft.SignalRService/stable/2021-10-01/examples/WebPubSubHubs_CreateOrUpdate.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
{
"parameters": {
"parameters": {
"properties": {
"eventHandlers": [
{
"properties": {
"urlTemplate": "http://host.com",
"userEventPattern": "*",
"systemEvents": [
"connect",
"connected"
],
"auth": {
"type": "ManagedIdentity",
"managedIdentity": {
"resource": "abc"
}
}
}
}
]
Copy link
Contributor

@j5lim j5lim Sep 17, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nested resource must be created by its own PUT.

Copy link
Member Author

@zackliu zackliu Sep 18, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The eventHandler in a WebPubSubHub has order. Re-order or replace all the eventhandlers in the webpubsubhub will be easier in such design. I think it's not an implicitly creation. And we'd like to work as keyvault and accesspolicy. KeyVault also show the content of accesspolicy and can update accesspolicy in parent resource's operation. How can we also achieve that?

Copy link
Contributor

@j5lim j5lim Sep 20, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Then you should model event handlers as a property of webpubsubhub only not as a child resource. You can't have both.

The keyvault case is okay since access policies are a property of keyvault. (its PUT api does not comply to the RPC though).

Copy link
Member Author

@zackliu zackliu Sep 22, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So, if event handler is just a property, can we have an api to update one event handler's properties only. I mean does ARM have such an api guidance to achieve this? Why access policy is just a property but not a sub-resource?

Copy link
Contributor

@j5lim j5lim Sep 22, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PATCH is for partial update and it can update one event handler only.
https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/resource-api-reference.md#patch-resource
https://armwiki.azurewebsites.net/api_contracts/guidelines/rpc.html#rpc009-use-put-for-update-of-entire-resource-ie-replace-use-patch-only-for-partial-update-of-resource

You can't model a property of the parent resource as a child resource. They have different RBAC and you need to update the parent if a child resources are updated /deleted or vice versa.

Copy link
Member Author

@zackliu zackliu Sep 23, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After discussion, we decided not to introduce another subresource for event handler. We treat it as property only

}
},
"api-version": "2021-10-01",
"subscriptionId": "00000000-0000-0000-0000-000000000000",
"resourceGroupName": "myResourceGroup",
"resourceName": "myWebPubSubService",
"hubName": "exampleHub"
},
"responses": {
"200": {
"body": {
"properties": {
"eventHandlers": [
{
"properties": {
"urlTemplate": "http://host.com",
"userEventPattern": "*",
"systemEvents": [
"connect",
"connected"
],
"auth": {
"type": "ManagedIdentity",
"managedIdentity": {
"resource": "abc"
}
}
},
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/hubs/exampleHub/eventHandlers/exampleEventHandler",
"name": "exampleEventHandler"
}
]
},
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/hubs/exampleHub",
"name": "exampleHub"
}
},
"201": {
"body": {
"properties": {
"eventHandlers": [
{
"properties": {
"urlTemplate": "http://host.com",
"userEventPattern": "*",
"systemEvents": [
"connect",
"connected"
],
"auth": {
"type": "ManagedIdentity",
"managedIdentity": {
"resource": "abc"
}
}
},
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/hubs/exampleHub/eventHandlers/exampleEventHandler",
"name": "exampleEventHandler"
}
]
},
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/hubs/exampleHub",
"name": "exampleHub"
},
"headers": {
"Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...",
"Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus..."
}
}
}
}
19 changes: 19 additions & 0 deletions ...rce-manager/Microsoft.SignalRService/stable/2021-10-01/examples/WebPubSubHubs_Delete.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
{
"parameters": {
"api-version": "2021-10-01",
"subscriptionId": "00000000-0000-0000-0000-000000000000",
"resourceGroupName": "myResourceGroup",
"resourceName": "myWebPubSubService",
"hubName": "exampleHub"
},
"responses": {
"200": {},
"202": {
"headers": {
"Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...",
"Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus..."
}
},
"204": {}
}
}
39 changes: 39 additions & 0 deletions ...source-manager/Microsoft.SignalRService/stable/2021-10-01/examples/WebPubSubHubs_Get.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
{
"parameters": {
"api-version": "2021-10-01",
"subscriptionId": "00000000-0000-0000-0000-000000000000",
"resourceGroupName": "myResourceGroup",
"resourceName": "myWebPubSubService",
"hubName": "exampleHub"
},
"responses": {
"200": {
"body": {
"properties": {
"eventHandlers": [
{
"properties": {
"urlTemplate": "http://host.com",
"userEventPattern": "*",
"systemEvents": [
"connect",
"connected"
],
"auth": {
"type": "ManagedIdentity",
"managedIdentity": {
"resource": "abc"
}
}
},
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/hubs/exampleHub/eventHandlers/exampleEventHandler",
"name": "exampleEventHandler"
}
]
},
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/hubs/exampleHub",
"name": "exampleHub"
}
}
}
}
Loading