-
Couldn't load subscription status.
- Fork 5.5k
[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.
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
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
25 changes: 25 additions & 0 deletions
25
...resource-manager/Microsoft.SignalRService/stable/2021-10-01/examples/Operations_List.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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
36
...sub/resource-manager/Microsoft.SignalRService/stable/2021-10-01/examples/Usages_List.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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..." | ||
| } | ||
| } | ||
| } | ||
| } |
85 changes: 85 additions & 0 deletions
85
...ger/Microsoft.SignalRService/stable/2021-10-01/examples/WebPubSubHubs_CreateOrUpdate.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,85 @@ | ||
| { | ||
| "parameters": { | ||
| "parameters": { | ||
| "properties": { | ||
| "eventHandlers": [ | ||
| { | ||
| "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" | ||
| }, | ||
| "responses": { | ||
| "200": { | ||
| "body": { | ||
| "properties": { | ||
| "eventHandlers": [ | ||
| { | ||
| "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", | ||
| "name": "exampleHub", | ||
| "type": "Microsoft.SignalRService/SignalR/hubs" | ||
| } | ||
| }, | ||
| "201": { | ||
| "body": { | ||
| "properties": { | ||
| "eventHandlers": [ | ||
| { | ||
| "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", | ||
| "name": "exampleHub", | ||
| "type": "Microsoft.SignalRService/SignalR/hubs" | ||
| }, | ||
| "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
19
...rce-manager/Microsoft.SignalRService/stable/2021-10-01/examples/WebPubSubHubs_Delete.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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": {} | ||
| } | ||
| } |
36 changes: 36 additions & 0 deletions
36
...source-manager/Microsoft.SignalRService/stable/2021-10-01/examples/WebPubSubHubs_Get.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| { | ||
| "parameters": { | ||
| "api-version": "2021-10-01", | ||
| "subscriptionId": "00000000-0000-0000-0000-000000000000", | ||
| "resourceGroupName": "myResourceGroup", | ||
| "resourceName": "myWebPubSubService", | ||
| "hubName": "exampleHub" | ||
| }, | ||
| "responses": { | ||
| "200": { | ||
| "body": { | ||
| "properties": { | ||
| "eventHandlers": [ | ||
| { | ||
| "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", | ||
| "name": "exampleHub", | ||
| "type": "Microsoft.SignalRService/SignalR/hubs" | ||
| } | ||
| } | ||
| } | ||
| } |
39 changes: 39 additions & 0 deletions
39
...ource-manager/Microsoft.SignalRService/stable/2021-10-01/examples/WebPubSubHubs_List.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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" | ||
| }, | ||
| "responses": { | ||
| "200": { | ||
| "body": { | ||
| "value": [ | ||
| { | ||
| "properties": { | ||
| "eventHandlers": [ | ||
| { | ||
| "urlTemplate": "http://host.com", | ||
| "userEventPattern": "*", | ||
| "systemEvents": [ | ||
| "connect", | ||
| "connected" | ||
| ], | ||
| "auth": { | ||
| "type": "ManagedIdentity", | ||
| "managedIdentity": { | ||
| "resource": "abc" | ||
| } | ||
| } | ||
| } | ||
zackliu marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| ] | ||
| }, | ||
| "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/hubs/exampleHub", | ||
| "name": "exampleHub", | ||
| "type": "Microsoft.SignalRService/SignalR/hubs" | ||
| } | ||
| ] | ||
| } | ||
| } | ||
| } | ||
| } | ||
19 changes: 19 additions & 0 deletions
19
...SignalRService/stable/2021-10-01/examples/WebPubSubPrivateEndpointConnections_Delete.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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", | ||
| "privateEndpointConnectionName": "mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e" | ||
| }, | ||
| "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
39
...ft.SignalRService/stable/2021-10-01/examples/WebPubSubPrivateEndpointConnections_Get.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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", | ||
| "privateEndpointConnectionName": "mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e" | ||
| }, | ||
| "responses": { | ||
| "200": { | ||
| "body": { | ||
| "systemData": { | ||
| "createdBy": "string", | ||
| "createdByType": "User", | ||
| "createdAt": "2015-02-03T04:05:06Z", | ||
| "lastModifiedBy": "string", | ||
| "lastModifiedByType": "User", | ||
| "lastModifiedAt": "2015-02-03T04:05:06Z" | ||
| }, | ||
| "properties": { | ||
| "provisioningState": "Succeeded", | ||
| "privateEndpoint": { | ||
| "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" | ||
| }, | ||
| "groupIds": [ | ||
| "webpubsub" | ||
| ], | ||
| "privateLinkServiceConnectionState": { | ||
| "status": "Approved", | ||
| "actionsRequired": "None" | ||
| } | ||
| }, | ||
| "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/privateEndpointConnections/mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", | ||
| "name": "mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", | ||
| "type": "Microsoft.SignalRService/WebPubSub/privateEndpointConnections" | ||
| } | ||
| } | ||
| } | ||
| } |
42 changes: 42 additions & 0 deletions
42
...t.SignalRService/stable/2021-10-01/examples/WebPubSubPrivateEndpointConnections_List.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| { | ||
| "parameters": { | ||
| "api-version": "2021-10-01", | ||
| "subscriptionId": "00000000-0000-0000-0000-000000000000", | ||
| "resourceGroupName": "myResourceGroup", | ||
| "resourceName": "myWebPubSubService" | ||
| }, | ||
| "responses": { | ||
| "200": { | ||
| "body": { | ||
| "value": [ | ||
| { | ||
| "systemData": { | ||
| "createdBy": "string", | ||
| "createdByType": "User", | ||
| "createdAt": "2015-02-03T04:05:06Z", | ||
| "lastModifiedBy": "string", | ||
| "lastModifiedByType": "User", | ||
| "lastModifiedAt": "2015-02-03T04:05:06Z" | ||
| }, | ||
| "properties": { | ||
| "provisioningState": "Succeeded", | ||
| "privateEndpoint": { | ||
| "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" | ||
| }, | ||
| "groupIds": [ | ||
| "webpubsub" | ||
| ], | ||
| "privateLinkServiceConnectionState": { | ||
| "status": "Approved", | ||
| "actionsRequired": "None" | ||
| } | ||
| }, | ||
| "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/privateEndpointConnections/mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", | ||
| "name": "mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", | ||
| "type": "Microsoft.SignalRService/WebPubSub/privateEndpointConnections" | ||
| } | ||
| ] | ||
| } | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The
eventHandlerin aWebPubSubHubhas order. Re-order or replace all theeventhandlersin thewebpubsubhubwill 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?There was a problem hiding this comment.
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).
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
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