From edc6e6a8b4de49a78397162e7eb55b9c696c2d71 Mon Sep 17 00:00:00 2001 From: bjqian Date: Thu, 28 Nov 2024 12:28:01 +0800 Subject: [PATCH] Add api version 2024-10-01-preview for Azure SignalR and Azure Web PubSub (#31544) * Init from 2024-08-01-preview * Update to 2024-10-01-preview * Update readme * Remove swagger default --- .../examples/Operations_List.json | 25 + ...nalRCustomCertificates_CreateOrUpdate.json | 44 + .../SignalRCustomCertificates_Delete.json | 13 + .../SignalRCustomCertificates_Get.json | 24 + .../SignalRCustomCertificates_List.json | 28 + .../SignalRCustomDomains_CreateOrUpdate.json | 36 + .../examples/SignalRCustomDomains_Delete.json | 19 + .../examples/SignalRCustomDomains_Get.json | 24 + .../examples/SignalRCustomDomains_List.json | 28 + ...nalRPrivateEndpointConnections_Delete.json | 19 + ...SignalRPrivateEndpointConnections_Get.json | 39 + ...ignalRPrivateEndpointConnections_List.json | 42 + ...nalRPrivateEndpointConnections_Update.json | 52 + .../SignalRPrivateLinkResources_List.json | 57 + ...edPrivateLinkResources_CreateOrUpdate.json | 51 + ...ReplicaSharedPrivateLinkResources_Get.json | 26 + ...eplicaSharedPrivateLinkResources_List.json | 29 + .../SignalRReplicas_CreateOrUpdate.json | 89 + .../examples/SignalRReplicas_Delete.json | 13 + .../examples/SignalRReplicas_Get.json | 41 + .../examples/SignalRReplicas_List.json | 44 + .../examples/SignalRReplicas_Restart.json | 18 + .../examples/SignalRReplicas_Update.json | 89 + ...edPrivateLinkResources_CreateOrUpdate.json | 50 + ...nalRSharedPrivateLinkResources_Delete.json | 19 + ...SignalRSharedPrivateLinkResources_Get.json | 25 + ...ignalRSharedPrivateLinkResources_List.json | 28 + .../SignalR_CheckNameAvailability.json | 20 + .../examples/SignalR_CreateOrUpdate.json | 502 ++ .../examples/SignalR_Delete.json | 18 + .../examples/SignalR_Get.json | 203 + .../examples/SignalR_ListByResourceGroup.json | 206 + .../examples/SignalR_ListBySubscription.json | 205 + .../examples/SignalR_ListKeys.json | 13 + .../examples/SignalR_ListReplicaSkus.json | 101 + .../examples/SignalR_ListSkus.json | 100 + .../examples/SignalR_RegenerateKey.json | 23 + .../examples/SignalR_Restart.json | 17 + .../examples/SignalR_Update.json | 305 ++ .../examples/Usages_List.json | 36 + .../preview/2024-10-01-preview/signalr.json | 3944 +++++++++++++++ .../signalr/resource-manager/readme.go.md | 10 + .../signalr/resource-manager/readme.java.md | 14 + .../signalr/resource-manager/readme.md | 11 +- .../signalr/resource-manager/readme.ruby.md | 10 + .../examples/Operations_List.json | 25 + .../examples/Usages_List.json | 36 + ...bSubCustomCertificates_CreateOrUpdate.json | 44 + .../WebPubSubCustomCertificates_Delete.json | 13 + .../WebPubSubCustomCertificates_Get.json | 24 + .../WebPubSubCustomCertificates_List.json | 28 + ...WebPubSubCustomDomains_CreateOrUpdate.json | 36 + .../WebPubSubCustomDomains_Delete.json | 19 + .../examples/WebPubSubCustomDomains_Get.json | 24 + .../examples/WebPubSubCustomDomains_List.json | 28 + .../WebPubSubHubs_CreateOrUpdate.json | 142 + .../examples/WebPubSubHubs_Delete.json | 19 + .../examples/WebPubSubHubs_Get.json | 55 + .../examples/WebPubSubHubs_List.json | 58 + ...bSubPrivateEndpointConnections_Delete.json | 19 + ...bPubSubPrivateEndpointConnections_Get.json | 39 + ...PubSubPrivateEndpointConnections_List.json | 42 + ...bSubPrivateEndpointConnections_Update.json | 52 + .../WebPubSubPrivateLinkResources_List.json | 57 + ...edPrivateLinkResources_CreateOrUpdate.json | 51 + ...ReplicaSharedPrivateLinkResources_Get.json | 26 + ...eplicaSharedPrivateLinkResources_List.json | 29 + .../WebPubSubReplicas_CreateOrUpdate.json | 89 + .../examples/WebPubSubReplicas_Delete.json | 13 + .../examples/WebPubSubReplicas_Get.json | 41 + .../examples/WebPubSubReplicas_List.json | 44 + .../examples/WebPubSubReplicas_Restart.json | 18 + .../examples/WebPubSubReplicas_Update.json | 89 + ...edPrivateLinkResources_CreateOrUpdate.json | 50 + ...bSubSharedPrivateLinkResources_Delete.json | 19 + ...bPubSubSharedPrivateLinkResources_Get.json | 25 + ...PubSubSharedPrivateLinkResources_List.json | 28 + .../WebPubSub_CheckNameAvailability.json | 20 + .../examples/WebPubSub_CreateOrUpdate.json | 385 ++ .../examples/WebPubSub_Delete.json | 18 + .../examples/WebPubSub_Get.json | 167 + .../WebPubSub_ListByResourceGroup.json | 170 + .../WebPubSub_ListBySubscription.json | 169 + .../examples/WebPubSub_ListKeys.json | 13 + .../examples/WebPubSub_ListReplicaSkus.json | 101 + .../examples/WebPubSub_ListSkus.json | 100 + .../examples/WebPubSub_RegenerateKey.json | 23 + .../examples/WebPubSub_Restart.json | 17 + .../examples/WebPubSub_Update.json | 224 + .../preview/2024-10-01-preview/webpubsub.json | 4249 +++++++++++++++++ .../webpubsub/resource-manager/readme.go.md | 11 + .../webpubsub/resource-manager/readme.md | 11 +- .../webpubsub/resource-manager/readme.ruby.md | 11 + 93 files changed, 13679 insertions(+), 2 deletions(-) create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/Operations_List.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRCustomCertificates_CreateOrUpdate.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRCustomCertificates_Delete.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRCustomCertificates_Get.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRCustomCertificates_List.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRCustomDomains_CreateOrUpdate.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRCustomDomains_Delete.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRCustomDomains_Get.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRCustomDomains_List.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRPrivateEndpointConnections_Delete.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRPrivateEndpointConnections_Get.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRPrivateEndpointConnections_List.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRPrivateEndpointConnections_Update.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRPrivateLinkResources_List.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRReplicaSharedPrivateLinkResources_CreateOrUpdate.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRReplicaSharedPrivateLinkResources_Get.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRReplicaSharedPrivateLinkResources_List.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRReplicas_CreateOrUpdate.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRReplicas_Delete.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRReplicas_Get.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRReplicas_List.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRReplicas_Restart.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRReplicas_Update.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRSharedPrivateLinkResources_CreateOrUpdate.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRSharedPrivateLinkResources_Delete.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRSharedPrivateLinkResources_Get.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRSharedPrivateLinkResources_List.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalR_CheckNameAvailability.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalR_CreateOrUpdate.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalR_Delete.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalR_Get.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalR_ListByResourceGroup.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalR_ListBySubscription.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalR_ListKeys.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalR_ListReplicaSkus.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalR_ListSkus.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalR_RegenerateKey.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalR_Restart.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalR_Update.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/Usages_List.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/signalr.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/Operations_List.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/Usages_List.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubCustomCertificates_CreateOrUpdate.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubCustomCertificates_Delete.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubCustomCertificates_Get.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubCustomCertificates_List.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubCustomDomains_CreateOrUpdate.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubCustomDomains_Delete.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubCustomDomains_Get.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubCustomDomains_List.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubHubs_CreateOrUpdate.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubHubs_Delete.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubHubs_Get.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubHubs_List.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubPrivateEndpointConnections_Delete.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubPrivateEndpointConnections_Get.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubPrivateEndpointConnections_List.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubPrivateEndpointConnections_Update.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubPrivateLinkResources_List.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubReplicaSharedPrivateLinkResources_CreateOrUpdate.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubReplicaSharedPrivateLinkResources_Get.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubReplicaSharedPrivateLinkResources_List.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubReplicas_CreateOrUpdate.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubReplicas_Delete.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubReplicas_Get.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubReplicas_List.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubReplicas_Restart.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubReplicas_Update.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubSharedPrivateLinkResources_CreateOrUpdate.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubSharedPrivateLinkResources_Delete.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubSharedPrivateLinkResources_Get.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubSharedPrivateLinkResources_List.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSub_CheckNameAvailability.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSub_CreateOrUpdate.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSub_Delete.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSub_Get.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSub_ListByResourceGroup.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSub_ListBySubscription.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSub_ListKeys.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSub_ListReplicaSkus.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSub_ListSkus.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSub_RegenerateKey.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSub_Restart.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSub_Update.json create mode 100644 specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/webpubsub.json diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/Operations_List.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/Operations_List.json new file mode 100644 index 000000000000..73707de440bc --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/Operations_List.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.SignalRService/SignalR/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.SignalRService", + "resource": "SignalR", + "operation": "Manage SignalR (read-only)", + "description": "View the resource settings and configurations in the management portal or through API" + }, + "properties": {} + } + ], + "nextLink": "providers/Microsoft.SignalRService?$skipToken={opaqueString}" + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRCustomCertificates_CreateOrUpdate.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRCustomCertificates_CreateOrUpdate.json new file mode 100644 index 000000000000..e0a6c0f912dd --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRCustomCertificates_CreateOrUpdate.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "parameters": { + "properties": { + "keyVaultBaseUri": "https://myvault.keyvault.azure.net/", + "keyVaultSecretName": "mycert", + "keyVaultSecretVersion": "bb6a44b2743f47f68dad0d6cc9756432" + } + }, + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService", + "certificateName": "myCert" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "keyVaultBaseUri": "https://myvault.keyvault.azure.net/", + "keyVaultSecretName": "mycert", + "keyVaultSecretVersion": "bb6a44b2743f47f68dad0d6cc9756432" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/customCertificates/myCert", + "name": "myCert", + "type": "Microsoft.SignalRService/SignalR/customCertificates" + } + }, + "201": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "keyVaultBaseUri": "https://myvault.keyvault.azure.net/", + "keyVaultSecretName": "mycert", + "keyVaultSecretVersion": "bb6a44b2743f47f68dad0d6cc9756432" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/customCertificates/myCert", + "name": "myCert", + "type": "Microsoft.SignalRService/SignalR/customCertificates" + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRCustomCertificates_Delete.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRCustomCertificates_Delete.json new file mode 100644 index 000000000000..3382262171bd --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRCustomCertificates_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService", + "certificateName": "myCert" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRCustomCertificates_Get.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRCustomCertificates_Get.json new file mode 100644 index 000000000000..2c4af17e2f02 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRCustomCertificates_Get.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService", + "certificateName": "myCert" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "keyVaultBaseUri": "https://myvault.keyvault.azure.net/", + "keyVaultSecretName": "mycert", + "keyVaultSecretVersion": "bb6a44b2743f47f68dad0d6cc9756432" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/customCertificates/myCert", + "name": "myCert", + "type": "Microsoft.SignalRService/SignalR/customCertificates" + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRCustomCertificates_List.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRCustomCertificates_List.json new file mode 100644 index 000000000000..98e9653d7468 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRCustomCertificates_List.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService", + "certificateName": "myCert" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "keyVaultBaseUri": "https://myvault.keyvault.azure.net/", + "keyVaultSecretName": "mycert", + "keyVaultSecretVersion": "bb6a44b2743f47f68dad0d6cc9756432" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/customCertificates/myCert", + "name": "myCert", + "type": "Microsoft.SignalRService/SignalR/customCertificates" + } + ] + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRCustomDomains_CreateOrUpdate.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRCustomDomains_CreateOrUpdate.json new file mode 100644 index 000000000000..c5a75650b739 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRCustomDomains_CreateOrUpdate.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "parameters": { + "properties": { + "domainName": "example.com", + "customCertificate": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/customCertificates/myCert" + } + } + }, + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService", + "name": "myDomain" + }, + "responses": { + "201": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "domainName": "example.com", + "customCertificate": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/customCertificates/myCert" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/customDomains/myDomain", + "name": "myDomain" + }, + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult..." + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRCustomDomains_Delete.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRCustomDomains_Delete.json new file mode 100644 index 000000000000..b69e77729d6d --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRCustomDomains_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService", + "name": "example" + }, + "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/...pathToOperationResult..." + } + }, + "204": {} + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRCustomDomains_Get.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRCustomDomains_Get.json new file mode 100644 index 000000000000..5f13dffb5338 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRCustomDomains_Get.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService", + "name": "example" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "domainName": "example.com", + "customCertificate": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/customCertificates/myCert" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/customDomains/myDomain", + "name": "myDomain" + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRCustomDomains_List.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRCustomDomains_List.json new file mode 100644 index 000000000000..b411192b49f5 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRCustomDomains_List.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService", + "name": "myDomain" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "domainName": "example.com", + "customCertificate": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/customCertificates/myCert" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/customDomains/myDomain", + "name": "myDomain" + } + ] + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRPrivateEndpointConnections_Delete.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRPrivateEndpointConnections_Delete.json new file mode 100644 index 000000000000..0062f5444689 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRPrivateEndpointConnections_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService", + "privateEndpointConnectionName": "mysignalrservice.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/...pathToOperationResult..." + } + }, + "204": {} + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRPrivateEndpointConnections_Get.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRPrivateEndpointConnections_Get.json new file mode 100644 index 000000000000..d2a696a861d0 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRPrivateEndpointConnections_Get.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService", + "privateEndpointConnectionName": "mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "groupIds": [ + "signalr" + ], + "privateLinkServiceConnectionState": { + "status": "Approved", + "actionsRequired": "None" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/privateEndpointConnections/mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "name": "mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "type": "Microsoft.SignalRService/SignalR/privateEndpointConnections", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRPrivateEndpointConnections_List.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRPrivateEndpointConnections_List.json new file mode 100644 index 000000000000..fcff6f790928 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRPrivateEndpointConnections_List.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "groupIds": [ + "signalr" + ], + "privateLinkServiceConnectionState": { + "status": "Approved", + "actionsRequired": "None" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/privateEndpointConnections/mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "name": "mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "type": "Microsoft.SignalRService/SignalR/privateEndpointConnections", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + } + ] + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRPrivateEndpointConnections_Update.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRPrivateEndpointConnections_Update.json new file mode 100644 index 000000000000..4bef39f5e08e --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRPrivateEndpointConnections_Update.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "parameters": { + "properties": { + "privateEndpoint": {}, + "privateLinkServiceConnectionState": { + "status": "Approved", + "actionsRequired": "None" + } + } + }, + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService", + "privateEndpointConnectionName": "mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "groupIds": [ + "signalr" + ], + "privateLinkServiceConnectionState": { + "status": "Approved", + "actionsRequired": "None" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/privateEndpointConnections/mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "name": "mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "type": "Microsoft.SignalRService/SignalR/privateEndpointConnections", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + }, + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult..." + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRPrivateLinkResources_List.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRPrivateLinkResources_List.json new file mode 100644 index 000000000000..673b86908c61 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRPrivateLinkResources_List.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "groupId": "signalr", + "requiredMembers": [ + "signalr" + ], + "requiredZoneNames": [ + "privatelink.service.signalr.net" + ], + "shareablePrivateLinkResourceTypes": [ + { + "name": "site", + "properties": { + "description": "Azure App Service can be used as an upstream", + "groupId": "sites", + "type": "Microsoft.Web/sites" + } + }, + { + "name": "vault", + "properties": { + "description": "Azure Key Vault can be used as credentials store", + "groupId": "vault", + "type": "Microsoft.KeyVault/vaults" + } + }, + { + "name": "table", + "properties": { + "description": "Azure Storage Table can be used as message store", + "groupId": "table", + "type": "Microsoft.Storage/storageAccounts" + } + } + ] + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/privateLinkResources/myPrivateLink", + "name": "myPrivateLink", + "type": "privateLinkResources" + } + ], + "nextLink": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToMoreResults..." + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRReplicaSharedPrivateLinkResources_CreateOrUpdate.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRReplicaSharedPrivateLinkResources_CreateOrUpdate.json new file mode 100644 index 000000000000..a1881687c3e4 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRReplicaSharedPrivateLinkResources_CreateOrUpdate.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "parameters": { + "properties": { + "groupId": "sites", + "privateLinkResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Web/sites/myWebApp", + "requestMessage": "Please approve" + } + }, + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService", + "replicaName": "mySignalRService-eastus", + "sharedPrivateLinkResourceName": "upstream" + }, + "responses": { + "200": { + "body": { + "properties": { + "groupId": "sites", + "privateLinkResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Web/sites/myWebApp", + "provisioningState": "Succeeded", + "requestMessage": "Please approve", + "status": "Approved" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/privateEndpointConnections/upstream", + "name": "upstream", + "type": "Microsoft.SignalRService/SignalR/privateEndpointConnections" + } + }, + "201": { + "body": { + "properties": { + "groupId": "sites", + "privateLinkResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Web/sites/myWebApp", + "provisioningState": "Succeeded", + "requestMessage": "Please approve", + "status": "Approved" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/privateEndpointConnections/upstream", + "name": "upstream", + "type": "Microsoft.SignalRService/SignalR/privateEndpointConnections" + }, + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult..." + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRReplicaSharedPrivateLinkResources_Get.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRReplicaSharedPrivateLinkResources_Get.json new file mode 100644 index 000000000000..0f9057ffc637 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRReplicaSharedPrivateLinkResources_Get.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService", + "replicaName": "mySignalRService-eastus", + "sharedPrivateLinkResourceName": "upstream" + }, + "responses": { + "200": { + "body": { + "properties": { + "groupId": "sites", + "privateLinkResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Web/sites/myWebApp", + "provisioningState": "Succeeded", + "requestMessage": "Please approve", + "status": "Approved" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/privateEndpointConnections/upstream", + "name": "upstream", + "type": "Microsoft.SignalRService/SignalR/privateEndpointConnections" + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRReplicaSharedPrivateLinkResources_List.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRReplicaSharedPrivateLinkResources_List.json new file mode 100644 index 000000000000..6c68ccce8906 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRReplicaSharedPrivateLinkResources_List.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService", + "replicaName": "mySignalRService-eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "groupId": "sites", + "privateLinkResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Web/sites/myWebApp", + "provisioningState": "Succeeded", + "requestMessage": "Please approve", + "status": "Approved" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/privateEndpointConnections/upstream", + "name": "upstream", + "type": "Microsoft.SignalRService/SignalR/privateEndpointConnections" + } + ] + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRReplicas_CreateOrUpdate.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRReplicas_CreateOrUpdate.json new file mode 100644 index 000000000000..d9c4a133ec99 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRReplicas_CreateOrUpdate.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "parameters": { + "sku": { + "name": "Premium_P1", + "tier": "Premium", + "capacity": 1 + }, + "properties": { + "resourceStopped": "false" + }, + "location": "eastus", + "tags": { + "key1": "value1" + } + }, + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService", + "replicaName": "mySignalRService-eastus" + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Premium_P1", + "tier": "Premium", + "size": "P1", + "capacity": 1 + }, + "properties": { + "provisioningState": "Succeeded", + "regionEndpointEnabled": "Enabled", + "resourceStopped": "false" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/replicas/mySignalRService-eastus", + "name": "mySignalRService-eastus", + "type": "Microsoft.SignalRService/SignalR", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + } + }, + "201": { + "body": { + "sku": { + "name": "Premium_P1", + "tier": "Premium", + "size": "P1", + "capacity": 1 + }, + "properties": { + "provisioningState": "Succeeded", + "regionEndpointEnabled": "Enabled", + "resourceStopped": "false" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/replicas/mySignalRService-eastus", + "name": "mySignalRService-eastus", + "type": "Microsoft.SignalRService/SignalR", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + }, + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult..." + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRReplicas_Delete.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRReplicas_Delete.json new file mode 100644 index 000000000000..c9c8c71d528f --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRReplicas_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService", + "replicaName": "mySignalRService-eastus" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRReplicas_Get.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRReplicas_Get.json new file mode 100644 index 000000000000..8f7ea30ff8e0 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRReplicas_Get.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService", + "replicaName": "mySignalRService-eastus" + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Premium_P1", + "tier": "Premium", + "size": "P1", + "capacity": 1 + }, + "properties": { + "provisioningState": "Succeeded", + "regionEndpointEnabled": "Enabled", + "resourceStopped": "false" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/replicas/mySignalRService-eastus", + "name": "mySignalRService-eastus", + "type": "Microsoft.SignalRService/SignalR", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRReplicas_List.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRReplicas_List.json new file mode 100644 index 000000000000..dc5fca437f8f --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRReplicas_List.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "sku": { + "name": "Premium_P1", + "tier": "Premium", + "size": "P1", + "capacity": 1 + }, + "properties": { + "provisioningState": "Succeeded", + "regionEndpointEnabled": "Enabled", + "resourceStopped": "false" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/replicas/mySignalRService-eastus", + "name": "mySignalRService-eastus", + "type": "Microsoft.SignalRService/SignalR", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + } + ] + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRReplicas_Restart.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRReplicas_Restart.json new file mode 100644 index 000000000000..ee4700e80699 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRReplicas_Restart.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService", + "replicaName": "mySignalRService-eastus" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult..." + } + }, + "204": {} + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRReplicas_Update.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRReplicas_Update.json new file mode 100644 index 000000000000..1b1fb9695db7 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRReplicas_Update.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "parameters": { + "sku": { + "name": "Premium_P1", + "tier": "Premium", + "capacity": 1 + }, + "properties": { + "resourceStopped": "false" + }, + "location": "eastus", + "tags": { + "key1": "value1" + } + }, + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService", + "replicaName": "mySignalRService-eastus" + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Premium_P1", + "tier": "Premium", + "size": "P1", + "capacity": 1 + }, + "properties": { + "provisioningState": "Succeeded", + "regionEndpointEnabled": "Enabled", + "resourceStopped": "false" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/replicas/mySignalRService-eastus", + "name": "mySignalRService-eastus", + "type": "Microsoft.SignalRService/SignalR", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + } + }, + "202": { + "body": { + "sku": { + "name": "Premium_P1", + "tier": "Premium", + "size": "P1", + "capacity": 1 + }, + "properties": { + "provisioningState": "Succeeded", + "regionEndpointEnabled": "Enabled", + "resourceStopped": "false" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/replicas/mySignalRService-eastus", + "name": "mySignalRService-eastus", + "type": "Microsoft.SignalRService/SignalR", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + }, + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult..." + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRSharedPrivateLinkResources_CreateOrUpdate.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRSharedPrivateLinkResources_CreateOrUpdate.json new file mode 100644 index 000000000000..64586800eb9f --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRSharedPrivateLinkResources_CreateOrUpdate.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "parameters": { + "properties": { + "groupId": "sites", + "privateLinkResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Web/sites/myWebApp", + "requestMessage": "Please approve" + } + }, + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService", + "sharedPrivateLinkResourceName": "upstream" + }, + "responses": { + "200": { + "body": { + "properties": { + "groupId": "sites", + "privateLinkResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Web/sites/myWebApp", + "provisioningState": "Succeeded", + "requestMessage": "Please approve", + "status": "Approved" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/privateEndpointConnections/upstream", + "name": "upstream", + "type": "Microsoft.SignalRService/SignalR/privateEndpointConnections" + } + }, + "201": { + "body": { + "properties": { + "groupId": "sites", + "privateLinkResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Web/sites/myWebApp", + "provisioningState": "Succeeded", + "requestMessage": "Please approve", + "status": "Approved" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/privateEndpointConnections/upstream", + "name": "upstream", + "type": "Microsoft.SignalRService/SignalR/privateEndpointConnections" + }, + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult..." + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRSharedPrivateLinkResources_Delete.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRSharedPrivateLinkResources_Delete.json new file mode 100644 index 000000000000..41a795fd237b --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRSharedPrivateLinkResources_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService", + "sharedPrivateLinkResourceName": "upstream" + }, + "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/...pathToOperationResult..." + } + }, + "204": {} + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRSharedPrivateLinkResources_Get.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRSharedPrivateLinkResources_Get.json new file mode 100644 index 000000000000..cbbfd488fca6 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRSharedPrivateLinkResources_Get.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService", + "sharedPrivateLinkResourceName": "upstream" + }, + "responses": { + "200": { + "body": { + "properties": { + "groupId": "sites", + "privateLinkResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Web/sites/myWebApp", + "provisioningState": "Succeeded", + "requestMessage": "Please approve", + "status": "Approved" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/privateEndpointConnections/upstream", + "name": "upstream", + "type": "Microsoft.SignalRService/SignalR/privateEndpointConnections" + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRSharedPrivateLinkResources_List.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRSharedPrivateLinkResources_List.json new file mode 100644 index 000000000000..200ec55cea9c --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalRSharedPrivateLinkResources_List.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "groupId": "sites", + "privateLinkResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Web/sites/myWebApp", + "provisioningState": "Succeeded", + "requestMessage": "Please approve", + "status": "Approved" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/privateEndpointConnections/upstream", + "name": "upstream", + "type": "Microsoft.SignalRService/SignalR/privateEndpointConnections" + } + ] + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalR_CheckNameAvailability.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalR_CheckNameAvailability.json new file mode 100644 index 000000000000..dfce08ea6f3a --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalR_CheckNameAvailability.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "location": "eastus", + "parameters": { + "type": "Microsoft.SignalRService/SignalR", + "name": "mySignalRService" + }, + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "nameAvailable": false, + "reason": "AlreadyExists", + "message": "The name is already taken. Please try a different name." + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalR_CreateOrUpdate.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalR_CreateOrUpdate.json new file mode 100644 index 000000000000..d705f8744a8e --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalR_CreateOrUpdate.json @@ -0,0 +1,502 @@ +{ + "parameters": { + "parameters": { + "sku": { + "name": "Premium_P1", + "tier": "Premium", + "capacity": 1 + }, + "properties": { + "tls": { + "clientCertEnabled": false + }, + "features": [ + { + "flag": "ServiceMode", + "value": "Serverless", + "properties": {} + }, + { + "flag": "EnableConnectivityLogs", + "value": "True", + "properties": {} + }, + { + "flag": "EnableMessagingLogs", + "value": "False", + "properties": {} + }, + { + "flag": "EnableLiveTrace", + "value": "False", + "properties": {} + } + ], + "liveTraceConfiguration": { + "enabled": "false", + "categories": [ + { + "name": "ConnectivityLogs", + "enabled": "true" + } + ] + }, + "cors": { + "allowedOrigins": [ + "https://foo.com", + "https://bar.com" + ] + }, + "serverless": { + "connectionTimeoutInSeconds": 5, + "keepAliveIntervalInSeconds": 5 + }, + "upstream": { + "templates": [ + { + "hubPattern": "*", + "eventPattern": "connect,disconnect", + "categoryPattern": "*", + "urlTemplate": "https://example.com/chat/api/connect", + "auth": { + "type": "ManagedIdentity", + "managedIdentity": { + "resource": "api://example" + } + } + } + ] + }, + "networkACLs": { + "defaultAction": "Deny", + "publicNetwork": { + "allow": [ + "ClientConnection" + ] + }, + "privateEndpoints": [ + { + "name": "mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "allow": [ + "ServerConnection" + ] + } + ] + }, + "publicNetworkAccess": "Enabled", + "disableLocalAuth": false, + "disableAadAuth": false + }, + "kind": "SignalR", + "identity": { + "type": "SystemAssigned" + }, + "location": "eastus", + "tags": { + "key1": "value1" + } + }, + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService" + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Premium_P1", + "tier": "Premium", + "size": "P1", + "capacity": 1 + }, + "properties": { + "provisioningState": "Succeeded", + "externalIP": "10.0.0.1", + "hostName": "mysignalrservice.service.signalr.net", + "publicPort": 443, + "serverPort": 443, + "version": "1.0", + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "actionsRequired": "None" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/privateEndpointConnections/mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "name": "mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "type": "Microsoft.SignalRService/SignalR/privateEndpointConnections", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + } + ], + "tls": { + "clientCertEnabled": true + }, + "features": [ + { + "flag": "ServiceMode", + "value": "Serverless", + "properties": {} + }, + { + "flag": "EnableConnectivityLogs", + "value": "True", + "properties": {} + }, + { + "flag": "EnableMessagingLogs", + "value": "False", + "properties": {} + }, + { + "flag": "EnableLiveTrace", + "value": "False", + "properties": {} + } + ], + "liveTraceConfiguration": { + "enabled": "false", + "categories": [ + { + "name": "ConnectivityLogs", + "enabled": "true" + } + ] + }, + "resourceLogConfiguration": { + "categories": [ + { + "name": "ConnectivityLogs", + "enabled": "true" + } + ] + }, + "cors": { + "allowedOrigins": [ + "https://foo.com", + "https://bar.com" + ] + }, + "serverless": { + "connectionTimeoutInSeconds": 5, + "keepAliveIntervalInSeconds": 5 + }, + "upstream": { + "templates": [ + { + "urlTemplate": "http://foo.com" + } + ] + }, + "networkACLs": { + "defaultAction": "Deny", + "publicNetwork": { + "allow": [ + "ClientConnection" + ] + }, + "privateEndpoints": [ + { + "name": "mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "allow": [ + "ServerConnection" + ] + } + ], + "ipRules": [ + { + "value": "123.456.789.123/24", + "action": "Allow" + }, + { + "value": "123.456.789.123", + "action": "Allow" + }, + { + "value": "AppService", + "action": "Allow" + } + ] + }, + "applicationFirewall": { + "clientConnectionCountRules": [ + { + "type": "ThrottleByJwtSignatureRule", + "maxCount": 20 + }, + { + "type": "ThrottleByUserIdRule", + "maxCount": 20 + }, + { + "type": "ThrottleByJwtCustomClaimRule", + "claimName": "claimName", + "maxCount": 20 + } + ], + "clientTrafficControlRules": [ + { + "type": "TrafficThrottleByJwtSignatureRule", + "maxInboundMessageBytes": 1073741824, + "aggregationWindowInSeconds": 60 + }, + { + "type": "TrafficThrottleByUserIdRule", + "maxInboundMessageBytes": 1073741824, + "aggregationWindowInSeconds": 60 + }, + { + "type": "TrafficThrottleByJwtCustomClaimRule", + "claimName": "claimName", + "maxInboundMessageBytes": 1073741824, + "aggregationWindowInSeconds": 60 + } + ] + }, + "publicNetworkAccess": "Enabled", + "disableLocalAuth": false, + "disableAadAuth": false, + "regionEndpointEnabled": "Enabled", + "resourceStopped": "false" + }, + "kind": "SignalR", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService", + "name": "mySignalRService", + "type": "Microsoft.SignalRService/SignalR", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + } + }, + "201": { + "body": { + "sku": { + "name": "Premium_P1", + "tier": "Premium", + "size": "P1", + "capacity": 1 + }, + "properties": { + "provisioningState": "Succeeded", + "externalIP": "10.0.0.1", + "hostName": "mysignalrservice.service.signalr.net", + "publicPort": 443, + "serverPort": 443, + "version": "1.0", + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "actionsRequired": "None" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/privateEndpointConnections/mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "name": "mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "type": "Microsoft.SignalRService/SignalR/privateEndpointConnections", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + } + ], + "tls": { + "clientCertEnabled": true + }, + "features": [ + { + "flag": "ServiceMode", + "value": "Serverless", + "properties": {} + }, + { + "flag": "EnableConnectivityLogs", + "value": "True", + "properties": {} + }, + { + "flag": "EnableMessagingLogs", + "value": "False", + "properties": {} + }, + { + "flag": "EnableLiveTrace", + "value": "False", + "properties": {} + } + ], + "liveTraceConfiguration": { + "enabled": "false", + "categories": [ + { + "name": "ConnectivityLogs", + "enabled": "true" + } + ] + }, + "resourceLogConfiguration": { + "categories": [ + { + "name": "ConnectivityLogs", + "enabled": "true" + } + ] + }, + "cors": { + "allowedOrigins": [ + "https://foo.com", + "https://bar.com" + ] + }, + "serverless": { + "connectionTimeoutInSeconds": 5, + "keepAliveIntervalInSeconds": 5 + }, + "upstream": { + "templates": [ + { + "urlTemplate": "http://foo.com" + } + ] + }, + "networkACLs": { + "defaultAction": "Deny", + "publicNetwork": { + "allow": [ + "ClientConnection" + ] + }, + "privateEndpoints": [ + { + "name": "mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "allow": [ + "ServerConnection" + ] + } + ], + "ipRules": [ + { + "value": "123.456.789.123/24", + "action": "Allow" + }, + { + "value": "123.456.789.123", + "action": "Allow" + }, + { + "value": "AppService", + "action": "Allow" + } + ] + }, + "applicationFirewall": { + "clientConnectionCountRules": [ + { + "type": "ThrottleByJwtSignatureRule", + "maxCount": 20 + }, + { + "type": "ThrottleByUserIdRule", + "maxCount": 20 + }, + { + "type": "ThrottleByJwtCustomClaimRule", + "claimName": "claimName", + "maxCount": 20 + } + ], + "clientTrafficControlRules": [ + { + "type": "TrafficThrottleByJwtSignatureRule", + "maxInboundMessageBytes": 1073741824, + "aggregationWindowInSeconds": 60 + }, + { + "type": "TrafficThrottleByUserIdRule", + "maxInboundMessageBytes": 1073741824, + "aggregationWindowInSeconds": 60 + }, + { + "type": "TrafficThrottleByJwtCustomClaimRule", + "claimName": "claimName", + "maxInboundMessageBytes": 1073741824, + "aggregationWindowInSeconds": 60 + } + ] + }, + "publicNetworkAccess": "Enabled", + "disableLocalAuth": false, + "disableAadAuth": false, + "regionEndpointEnabled": "Enabled", + "resourceStopped": "false" + }, + "kind": "SignalR", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService", + "name": "mySignalRService", + "type": "Microsoft.SignalRService/SignalR", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + }, + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult..." + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult..." + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalR_Delete.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalR_Delete.json new file mode 100644 index 000000000000..13d9b60cf0bd --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalR_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService" + }, + "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/...pathToOperationResult..." + } + }, + "204": {} + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalR_Get.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalR_Get.json new file mode 100644 index 000000000000..55bd7d675680 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalR_Get.json @@ -0,0 +1,203 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService" + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Premium_P1", + "tier": "Premium", + "size": "P1", + "capacity": 1 + }, + "properties": { + "provisioningState": "Succeeded", + "externalIP": "10.0.0.1", + "hostName": "mysignalrservice.service.signalr.net", + "publicPort": 443, + "serverPort": 443, + "version": "1.0", + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "actionsRequired": "None" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/privateEndpointConnections/mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "name": "mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "type": "Microsoft.SignalRService/SignalR/privateEndpointConnections", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + } + ], + "tls": { + "clientCertEnabled": true + }, + "features": [ + { + "flag": "ServiceMode", + "value": "Serverless", + "properties": {} + }, + { + "flag": "EnableConnectivityLogs", + "value": "True", + "properties": {} + }, + { + "flag": "EnableMessagingLogs", + "value": "False", + "properties": {} + }, + { + "flag": "EnableLiveTrace", + "value": "False", + "properties": {} + } + ], + "liveTraceConfiguration": { + "enabled": "false", + "categories": [ + { + "name": "ConnectivityLogs", + "enabled": "true" + } + ] + }, + "resourceLogConfiguration": { + "categories": [ + { + "name": "ConnectivityLogs", + "enabled": "true" + } + ] + }, + "cors": { + "allowedOrigins": [ + "https://foo.com", + "https://bar.com" + ] + }, + "serverless": { + "connectionTimeoutInSeconds": 5, + "keepAliveIntervalInSeconds": 5 + }, + "upstream": { + "templates": [ + { + "urlTemplate": "http://foo.com" + } + ] + }, + "networkACLs": { + "defaultAction": "Deny", + "publicNetwork": { + "allow": [ + "ClientConnection" + ] + }, + "privateEndpoints": [ + { + "name": "mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "allow": [ + "ServerConnection" + ] + } + ], + "ipRules": [ + { + "value": "123.456.789.123/24", + "action": "Allow" + }, + { + "value": "123.456.789.123", + "action": "Allow" + }, + { + "value": "AppService", + "action": "Allow" + } + ] + }, + "applicationFirewall": { + "clientConnectionCountRules": [ + { + "type": "ThrottleByJwtSignatureRule", + "maxCount": 20 + }, + { + "type": "ThrottleByUserIdRule", + "maxCount": 20 + }, + { + "type": "ThrottleByJwtCustomClaimRule", + "claimName": "claimName", + "maxCount": 20 + } + ], + "clientTrafficControlRules": [ + { + "type": "TrafficThrottleByJwtSignatureRule", + "maxInboundMessageBytes": 1073741824, + "aggregationWindowInSeconds": 60 + }, + { + "type": "TrafficThrottleByUserIdRule", + "maxInboundMessageBytes": 1073741824, + "aggregationWindowInSeconds": 60 + }, + { + "type": "TrafficThrottleByJwtCustomClaimRule", + "claimName": "claimName", + "maxInboundMessageBytes": 1073741824, + "aggregationWindowInSeconds": 60 + } + ] + }, + "publicNetworkAccess": "Enabled", + "disableLocalAuth": false, + "disableAadAuth": false, + "regionEndpointEnabled": "Enabled", + "resourceStopped": "false" + }, + "kind": "SignalR", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService", + "name": "mySignalRService", + "type": "Microsoft.SignalRService/SignalR", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalR_ListByResourceGroup.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalR_ListByResourceGroup.json new file mode 100644 index 000000000000..34e9fb5f82e0 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalR_ListByResourceGroup.json @@ -0,0 +1,206 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "sku": { + "name": "Premium_P1", + "tier": "Premium", + "size": "P1", + "capacity": 1 + }, + "properties": { + "provisioningState": "Succeeded", + "externalIP": "10.0.0.1", + "hostName": "mysignalrservice.service.signalr.net", + "publicPort": 443, + "serverPort": 443, + "version": "1.0", + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "actionsRequired": "None" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/privateEndpointConnections/mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "name": "mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "type": "Microsoft.SignalRService/SignalR/privateEndpointConnections", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + } + ], + "tls": { + "clientCertEnabled": true + }, + "features": [ + { + "flag": "ServiceMode", + "value": "Serverless", + "properties": {} + }, + { + "flag": "EnableConnectivityLogs", + "value": "True", + "properties": {} + }, + { + "flag": "EnableMessagingLogs", + "value": "False", + "properties": {} + }, + { + "flag": "EnableLiveTrace", + "value": "False", + "properties": {} + } + ], + "liveTraceConfiguration": { + "enabled": "false", + "categories": [ + { + "name": "ConnectivityLogs", + "enabled": "true" + } + ] + }, + "resourceLogConfiguration": { + "categories": [ + { + "name": "ConnectivityLogs", + "enabled": "true" + } + ] + }, + "cors": { + "allowedOrigins": [ + "https://foo.com", + "https://bar.com" + ] + }, + "serverless": { + "connectionTimeoutInSeconds": 5, + "keepAliveIntervalInSeconds": 5 + }, + "upstream": { + "templates": [ + { + "urlTemplate": "http://foo.com" + } + ] + }, + "networkACLs": { + "defaultAction": "Deny", + "publicNetwork": { + "allow": [ + "ClientConnection" + ] + }, + "privateEndpoints": [ + { + "name": "mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "allow": [ + "ServerConnection" + ] + } + ], + "ipRules": [ + { + "value": "123.456.789.123/24", + "action": "Allow" + }, + { + "value": "123.456.789.123", + "action": "Allow" + }, + { + "value": "AppService", + "action": "Allow" + } + ] + }, + "applicationFirewall": { + "clientConnectionCountRules": [ + { + "type": "ThrottleByJwtSignatureRule", + "maxCount": 20 + }, + { + "type": "ThrottleByUserIdRule", + "maxCount": 20 + }, + { + "type": "ThrottleByJwtCustomClaimRule", + "claimName": "claimName", + "maxCount": 20 + } + ], + "clientTrafficControlRules": [ + { + "type": "TrafficThrottleByJwtSignatureRule", + "maxInboundMessageBytes": 1073741824, + "aggregationWindowInSeconds": 60 + }, + { + "type": "TrafficThrottleByUserIdRule", + "maxInboundMessageBytes": 1073741824, + "aggregationWindowInSeconds": 60 + }, + { + "type": "TrafficThrottleByJwtCustomClaimRule", + "claimName": "claimName", + "maxInboundMessageBytes": 1073741824, + "aggregationWindowInSeconds": 60 + } + ] + }, + "publicNetworkAccess": "Enabled", + "disableLocalAuth": false, + "disableAadAuth": false, + "regionEndpointEnabled": "Enabled", + "resourceStopped": "false" + }, + "kind": "SignalR", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService", + "name": "mySignalRService", + "type": "Microsoft.SignalRService/SignalR", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + } + ] + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalR_ListBySubscription.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalR_ListBySubscription.json new file mode 100644 index 000000000000..8ce6d8e240ca --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalR_ListBySubscription.json @@ -0,0 +1,205 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "sku": { + "name": "Premium_P1", + "tier": "Premium", + "size": "P1", + "capacity": 1 + }, + "properties": { + "provisioningState": "Succeeded", + "externalIP": "10.0.0.1", + "hostName": "mysignalrservice.service.signalr.net", + "publicPort": 443, + "serverPort": 443, + "version": "1.0", + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "actionsRequired": "None" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/privateEndpointConnections/mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "name": "mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "type": "Microsoft.SignalRService/SignalR/privateEndpointConnections", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + } + ], + "tls": { + "clientCertEnabled": true + }, + "features": [ + { + "flag": "ServiceMode", + "value": "Serverless", + "properties": {} + }, + { + "flag": "EnableConnectivityLogs", + "value": "True", + "properties": {} + }, + { + "flag": "EnableMessagingLogs", + "value": "False", + "properties": {} + }, + { + "flag": "EnableLiveTrace", + "value": "False", + "properties": {} + } + ], + "liveTraceConfiguration": { + "enabled": "false", + "categories": [ + { + "name": "ConnectivityLogs", + "enabled": "true" + } + ] + }, + "resourceLogConfiguration": { + "categories": [ + { + "name": "ConnectivityLogs", + "enabled": "true" + } + ] + }, + "cors": { + "allowedOrigins": [ + "https://foo.com", + "https://bar.com" + ] + }, + "serverless": { + "connectionTimeoutInSeconds": 5, + "keepAliveIntervalInSeconds": 5 + }, + "upstream": { + "templates": [ + { + "urlTemplate": "http://foo.com" + } + ] + }, + "networkACLs": { + "defaultAction": "Deny", + "publicNetwork": { + "allow": [ + "ClientConnection" + ] + }, + "privateEndpoints": [ + { + "name": "mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "allow": [ + "ServerConnection" + ] + } + ], + "ipRules": [ + { + "value": "123.456.789.123/24", + "action": "Allow" + }, + { + "value": "123.456.789.123", + "action": "Allow" + }, + { + "value": "AppService", + "action": "Allow" + } + ] + }, + "applicationFirewall": { + "clientConnectionCountRules": [ + { + "type": "ThrottleByJwtSignatureRule", + "maxCount": 20 + }, + { + "type": "ThrottleByUserIdRule", + "maxCount": 20 + }, + { + "type": "ThrottleByJwtCustomClaimRule", + "claimName": "claimName", + "maxCount": 20 + } + ], + "clientTrafficControlRules": [ + { + "type": "TrafficThrottleByJwtSignatureRule", + "maxInboundMessageBytes": 1073741824, + "aggregationWindowInSeconds": 60 + }, + { + "type": "TrafficThrottleByUserIdRule", + "maxInboundMessageBytes": 1073741824, + "aggregationWindowInSeconds": 60 + }, + { + "type": "TrafficThrottleByJwtCustomClaimRule", + "claimName": "claimName", + "maxInboundMessageBytes": 1073741824, + "aggregationWindowInSeconds": 60 + } + ] + }, + "publicNetworkAccess": "Enabled", + "disableLocalAuth": false, + "disableAadAuth": false, + "regionEndpointEnabled": "Enabled", + "resourceStopped": "false" + }, + "kind": "SignalR", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService", + "name": "mySignalRService", + "type": "Microsoft.SignalRService/SignalR", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + } + ] + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalR_ListKeys.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalR_ListKeys.json new file mode 100644 index 000000000000..5e85bc761202 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalR_ListKeys.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalR_ListReplicaSkus.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalR_ListReplicaSkus.json new file mode 100644 index 000000000000..f8c0ed9394f1 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalR_ListReplicaSkus.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService", + "replicaName": "mySignalRService-eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "Microsoft.SignalRService/SignalR/replicas", + "sku": { + "name": "Free_F1", + "tier": "Free" + }, + "capacity": { + "minimum": 0, + "maximum": 1, + "default": 1, + "allowedValues": [ + 1 + ], + "scaleType": "Manual" + } + }, + { + "resourceType": "Microsoft.SignalRService/SignalR/replicas", + "sku": { + "name": "Standard_S1", + "tier": "Standard" + }, + "capacity": { + "minimum": 0, + "maximum": 100, + "default": 1, + "allowedValues": [ + 1, + 2, + 3, + 4, + 5, + 6, + 7, + 8, + 9, + 10, + 20, + 30, + 40, + 50, + 60, + 70, + 80, + 90, + 100 + ], + "scaleType": "Manual" + } + }, + { + "resourceType": "Microsoft.SignalRService/SignalR/replicas", + "sku": { + "name": "Premium_P1", + "tier": "Standard" + }, + "capacity": { + "minimum": 0, + "maximum": 100, + "default": 1, + "allowedValues": [ + 1, + 2, + 3, + 4, + 5, + 6, + 7, + 8, + 9, + 10, + 20, + 30, + 40, + 50, + 60, + 70, + 80, + 90, + 100 + ], + "scaleType": "Automatic" + } + } + ] + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalR_ListSkus.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalR_ListSkus.json new file mode 100644 index 000000000000..9bfb4bdc8d88 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalR_ListSkus.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "Microsoft.SignalRService/SignalR", + "sku": { + "name": "Free_F1", + "tier": "Free" + }, + "capacity": { + "minimum": 0, + "maximum": 1, + "default": 1, + "allowedValues": [ + 1 + ], + "scaleType": "Manual" + } + }, + { + "resourceType": "Microsoft.SignalRService/SignalR", + "sku": { + "name": "Standard_S1", + "tier": "Standard" + }, + "capacity": { + "minimum": 0, + "maximum": 100, + "default": 1, + "allowedValues": [ + 1, + 2, + 3, + 4, + 5, + 6, + 7, + 8, + 9, + 10, + 20, + 30, + 40, + 50, + 60, + 70, + 80, + 90, + 100 + ], + "scaleType": "Manual" + } + }, + { + "resourceType": "Microsoft.SignalRService/SignalR/replicas", + "sku": { + "name": "Premium_P1", + "tier": "Standard" + }, + "capacity": { + "minimum": 0, + "maximum": 100, + "default": 1, + "allowedValues": [ + 1, + 2, + 3, + 4, + 5, + 6, + 7, + 8, + 9, + 10, + 20, + 30, + 40, + 50, + 60, + 70, + 80, + 90, + 100 + ], + "scaleType": "Automatic" + } + } + ] + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalR_RegenerateKey.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalR_RegenerateKey.json new file mode 100644 index 000000000000..a415340158ba --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalR_RegenerateKey.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "parameters": { + "keyType": "Primary" + }, + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService" + }, + "responses": { + "200": { + "body": {} + }, + "202": { + "body": {}, + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult..." + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalR_Restart.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalR_Restart.json new file mode 100644 index 000000000000..f1f784c7b8a6 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalR_Restart.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult..." + } + }, + "204": {} + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalR_Update.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalR_Update.json new file mode 100644 index 000000000000..3469f757fe31 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/SignalR_Update.json @@ -0,0 +1,305 @@ +{ + "parameters": { + "parameters": { + "sku": { + "name": "Premium_P1", + "tier": "Premium", + "capacity": 1 + }, + "properties": { + "tls": { + "clientCertEnabled": false + }, + "features": [ + { + "flag": "ServiceMode", + "value": "Serverless", + "properties": {} + }, + { + "flag": "EnableConnectivityLogs", + "value": "True", + "properties": {} + }, + { + "flag": "EnableMessagingLogs", + "value": "False", + "properties": {} + }, + { + "flag": "EnableLiveTrace", + "value": "False", + "properties": {} + } + ], + "liveTraceConfiguration": { + "enabled": "false", + "categories": [ + { + "name": "ConnectivityLogs", + "enabled": "true" + } + ] + }, + "cors": { + "allowedOrigins": [ + "https://foo.com", + "https://bar.com" + ] + }, + "serverless": { + "connectionTimeoutInSeconds": 5, + "keepAliveIntervalInSeconds": 5 + }, + "upstream": { + "templates": [ + { + "hubPattern": "*", + "eventPattern": "connect,disconnect", + "categoryPattern": "*", + "urlTemplate": "https://example.com/chat/api/connect", + "auth": { + "type": "ManagedIdentity", + "managedIdentity": { + "resource": "api://example" + } + } + } + ] + }, + "networkACLs": { + "defaultAction": "Deny", + "publicNetwork": { + "allow": [ + "ClientConnection" + ] + }, + "privateEndpoints": [ + { + "name": "mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "allow": [ + "ServerConnection" + ] + } + ] + }, + "publicNetworkAccess": "Enabled", + "disableLocalAuth": false, + "disableAadAuth": false + }, + "kind": "SignalR", + "identity": { + "type": "SystemAssigned" + }, + "location": "eastus", + "tags": { + "key1": "value1" + } + }, + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService" + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Premium_P1", + "tier": "Premium", + "size": "P1", + "capacity": 1 + }, + "properties": { + "provisioningState": "Succeeded", + "externalIP": "10.0.0.1", + "hostName": "mysignalrservice.service.signalr.net", + "publicPort": 443, + "serverPort": 443, + "version": "1.0", + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "actionsRequired": "None" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/privateEndpointConnections/mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "name": "mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "type": "Microsoft.SignalRService/SignalR/privateEndpointConnections", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + } + ], + "tls": { + "clientCertEnabled": true + }, + "features": [ + { + "flag": "ServiceMode", + "value": "Serverless", + "properties": {} + }, + { + "flag": "EnableConnectivityLogs", + "value": "True", + "properties": {} + }, + { + "flag": "EnableMessagingLogs", + "value": "False", + "properties": {} + }, + { + "flag": "EnableLiveTrace", + "value": "False", + "properties": {} + } + ], + "liveTraceConfiguration": { + "enabled": "false", + "categories": [ + { + "name": "ConnectivityLogs", + "enabled": "true" + } + ] + }, + "resourceLogConfiguration": { + "categories": [ + { + "name": "ConnectivityLogs", + "enabled": "true" + } + ] + }, + "cors": { + "allowedOrigins": [ + "https://foo.com", + "https://bar.com" + ] + }, + "serverless": { + "connectionTimeoutInSeconds": 5, + "keepAliveIntervalInSeconds": 5 + }, + "upstream": { + "templates": [ + { + "urlTemplate": "http://foo.com" + } + ] + }, + "networkACLs": { + "defaultAction": "Deny", + "publicNetwork": { + "allow": [ + "ClientConnection" + ] + }, + "privateEndpoints": [ + { + "name": "mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "allow": [ + "ServerConnection" + ] + } + ], + "ipRules": [ + { + "value": "123.456.789.123/24", + "action": "Allow" + }, + { + "value": "123.456.789.123", + "action": "Allow" + }, + { + "value": "AppService", + "action": "Allow" + } + ] + }, + "applicationFirewall": { + "clientConnectionCountRules": [ + { + "type": "ThrottleByJwtSignatureRule", + "maxCount": 20 + }, + { + "type": "ThrottleByUserIdRule", + "maxCount": 20 + }, + { + "type": "ThrottleByJwtCustomClaimRule", + "claimName": "claimName", + "maxCount": 20 + } + ], + "clientTrafficControlRules": [ + { + "type": "TrafficThrottleByJwtSignatureRule", + "maxInboundMessageBytes": 1073741824, + "aggregationWindowInSeconds": 60 + }, + { + "type": "TrafficThrottleByUserIdRule", + "maxInboundMessageBytes": 1073741824, + "aggregationWindowInSeconds": 60 + }, + { + "type": "TrafficThrottleByJwtCustomClaimRule", + "claimName": "claimName", + "maxInboundMessageBytes": 1073741824, + "aggregationWindowInSeconds": 60 + } + ] + }, + "publicNetworkAccess": "Enabled", + "disableLocalAuth": false, + "disableAadAuth": false, + "regionEndpointEnabled": "Enabled", + "resourceStopped": "false" + }, + "kind": "SignalR", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService", + "name": "mySignalRService", + "type": "Microsoft.SignalRService/SignalR", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult..." + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/Usages_List.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/Usages_List.json new file mode 100644 index 000000000000..2d7976abe06e --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/Usages_List.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "location": "eastus", + "api-version": "2024-10-01-preview", + "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..." + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/signalr.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/signalr.json new file mode 100644 index 000000000000..e606e77193fa --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/signalr.json @@ -0,0 +1,3944 @@ +{ + "swagger": "2.0", + "info": { + "title": "SignalRManagementClient", + "description": "REST API for Azure SignalR Service", + "version": "2024-10-01-preview" + }, + "paths": { + "/providers/Microsoft.SignalRService/operations": { + "get": { + "tags": [ + "SignalR" + ], + "description": "Lists all of the available REST API operations of the Microsoft.SignalRService provider.", + "operationId": "Operations_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of operations.", + "schema": { + "$ref": "#/definitions/OperationList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/Operations_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/locations/{location}/checkNameAvailability": { + "post": { + "tags": [ + "SignalR" + ], + "description": "Checks that the resource name is valid and is not already in use.", + "operationId": "SignalR_CheckNameAvailability", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "location", + "description": "The region", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "parameters", + "description": "Parameters supplied to the operation.", + "required": true, + "schema": { + "$ref": "#/definitions/NameAvailabilityParameters" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the name availability.", + "schema": { + "$ref": "#/definitions/NameAvailability" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SignalR_CheckNameAvailability": { + "$ref": "./examples/SignalR_CheckNameAvailability.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/locations/{location}/usages": { + "get": { + "tags": [ + "SignalR" + ], + "description": "List resource usage quotas by location.", + "operationId": "Usages_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "location", + "description": "the location like \"eastus\"", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describe the usage quotas of a subscription in specified region.", + "schema": { + "$ref": "#/definitions/SignalRUsageList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Usages_List": { + "$ref": "./examples/Usages_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/signalR": { + "get": { + "tags": [ + "SignalR" + ], + "description": "Handles requests to list all resources in a subscription.", + "operationId": "SignalR_ListBySubscription", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of resources in the subscription.", + "schema": { + "$ref": "#/definitions/SignalRResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SignalR_ListBySubscription": { + "$ref": "./examples/SignalR_ListBySubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR": { + "get": { + "tags": [ + "SignalR" + ], + "description": "Handles requests to list all resources in a resource group.", + "operationId": "SignalR_ListByResourceGroup", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of resources in a resourceGroup.", + "schema": { + "$ref": "#/definitions/SignalRResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SignalR_ListByResourceGroup": { + "$ref": "./examples/SignalR_ListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}": { + "get": { + "tags": [ + "SignalR" + ], + "description": "Get the resource and its properties.", + "operationId": "SignalR_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the corresponding resource.", + "schema": { + "$ref": "#/definitions/SignalRResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SignalR_Get": { + "$ref": "./examples/SignalR_Get.json" + } + } + }, + "put": { + "tags": [ + "SignalR" + ], + "description": "Create or update a resource.", + "operationId": "SignalR_CreateOrUpdate", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "parameters", + "description": "Parameters for the create or update operation", + "required": true, + "schema": { + "$ref": "#/definitions/SignalRResource" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes a resource.", + "schema": { + "$ref": "#/definitions/SignalRResource" + } + }, + "201": { + "description": "Created. The response describes the new resource and contains a Location header to query the operation result.", + "schema": { + "$ref": "#/definitions/SignalRResource" + } + }, + "202": { + "description": "Accepted. The response indicates the exiting resource is now updating and contains a Location header to query the operation result.." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "SignalR_CreateOrUpdate": { + "$ref": "./examples/SignalR_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "SignalR" + ], + "description": "Operation to delete a resource.", + "operationId": "SignalR_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response indicates the resource is already deleted." + }, + "202": { + "description": "Accepted. The response indicates the delete operation is performed in the background." + }, + "204": { + "description": "Success. The response indicates the resource is already deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "SignalR_Delete": { + "$ref": "./examples/SignalR_Delete.json" + } + } + }, + "patch": { + "tags": [ + "SignalR" + ], + "description": "Operation to update an exiting resource.", + "operationId": "SignalR_Update", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "parameters", + "description": "Parameters for the update operation", + "required": true, + "schema": { + "$ref": "#/definitions/SignalRResource" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes a resource.", + "schema": { + "$ref": "#/definitions/SignalRResource" + } + }, + "202": { + "description": "Accepted. The response indicates the exiting resource is now updating and contains a Location header to query the operation result..", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "SignalR_Update": { + "$ref": "./examples/SignalR_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/customCertificates": { + "get": { + "tags": [ + "SignalR" + ], + "description": "List all custom certificates.", + "operationId": "SignalRCustomCertificates_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes custom certificates of the resource.", + "schema": { + "$ref": "#/definitions/CustomCertificateList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SignalRCustomCertificates_List": { + "$ref": "./examples/SignalRCustomCertificates_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/customCertificates/{certificateName}": { + "get": { + "tags": [ + "SignalR" + ], + "description": "Get a custom certificate.", + "operationId": "SignalRCustomCertificates_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "in": "path", + "name": "certificateName", + "description": "Custom certificate name", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describe the corresponding custom certificate.", + "schema": { + "$ref": "#/definitions/CustomCertificate" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SignalRCustomCertificates_Get": { + "$ref": "./examples/SignalRCustomCertificates_Get.json" + } + } + }, + "put": { + "tags": [ + "SignalR" + ], + "description": "Create or update a custom certificate.", + "operationId": "SignalRCustomCertificates_CreateOrUpdate", + "consumes": [ + "application/json", + "text/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "in": "path", + "name": "certificateName", + "description": "Custom certificate name", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "", + "required": true, + "schema": { + "$ref": "#/definitions/CustomCertificate" + } + } + ], + "responses": { + "200": { + "description": "Success. The response describes the certificate.", + "schema": { + "$ref": "#/definitions/CustomCertificate" + } + }, + "201": { + "description": "Created. The response describes the certificate.", + "schema": { + "$ref": "#/definitions/CustomCertificate" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "SignalRCustomCertificates_CreateOrUpdate": { + "$ref": "./examples/SignalRCustomCertificates_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "SignalR" + ], + "description": "Delete a custom certificate.", + "operationId": "SignalRCustomCertificates_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "in": "path", + "name": "certificateName", + "description": "Custom certificate name", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success." + }, + "204": { + "description": "No Content." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SignalRCustomCertificates_Delete": { + "$ref": "./examples/SignalRCustomCertificates_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/customDomains": { + "get": { + "tags": [ + "SignalR" + ], + "description": "List all custom domains.", + "operationId": "SignalRCustomDomains_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes custom domains of the resource.", + "schema": { + "$ref": "#/definitions/CustomDomainList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SignalRCustomDomains_List": { + "$ref": "./examples/SignalRCustomDomains_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/customDomains/{name}": { + "get": { + "tags": [ + "SignalR" + ], + "description": "Get a custom domain.", + "operationId": "SignalRCustomDomains_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "in": "path", + "name": "name", + "description": "Custom domain name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describe the corresponding custom domain.", + "schema": { + "$ref": "#/definitions/CustomDomain" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SignalRCustomDomains_Get": { + "$ref": "./examples/SignalRCustomDomains_Get.json" + } + } + }, + "put": { + "tags": [ + "SignalR" + ], + "description": "Create or update a custom domain.", + "operationId": "SignalRCustomDomains_CreateOrUpdate", + "consumes": [ + "application/json", + "text/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "in": "path", + "name": "name", + "description": "Custom domain name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "", + "required": true, + "schema": { + "$ref": "#/definitions/CustomDomain" + } + } + ], + "responses": { + "201": { + "description": "Created. The response describes the custom domain and contains a Location header to query the operation result.", + "schema": { + "$ref": "#/definitions/CustomDomain" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "SignalRCustomDomains_CreateOrUpdate": { + "$ref": "./examples/SignalRCustomDomains_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "SignalR" + ], + "description": "Delete a custom domain.", + "operationId": "SignalRCustomDomains_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "in": "path", + "name": "name", + "description": "Custom domain name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response indicates the custom domain is deleted." + }, + "202": { + "description": "Accepted. The response indicates the operation is performed in the background." + }, + "204": { + "description": "Success. The response indicates the custom domain is deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "SignalRCustomDomains_Delete": { + "$ref": "./examples/SignalRCustomDomains_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/listKeys": { + "post": { + "tags": [ + "SignalR" + ], + "description": "Get the access keys of the resource.", + "operationId": "SignalR_ListKeys", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes access keys of the resource.", + "schema": { + "$ref": "#/definitions/SignalRKeys" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SignalR_ListKeys": { + "$ref": "./examples/SignalR_ListKeys.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/privateEndpointConnections": { + "get": { + "tags": [ + "SignalR" + ], + "description": "List private endpoint connections", + "operationId": "SignalRPrivateEndpointConnections_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes a list of private endpoint connections.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SignalRPrivateEndpointConnections_List": { + "$ref": "./examples/SignalRPrivateEndpointConnections_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "SignalR" + ], + "description": "Get the specified private endpoint connection", + "operationId": "SignalRPrivateEndpointConnections_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/privatelinks.json#/parameters/PrivateEndpointConnectionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes a private endpoint connection.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SignalRPrivateEndpointConnections_Get": { + "$ref": "./examples/SignalRPrivateEndpointConnections_Get.json" + } + } + }, + "put": { + "tags": [ + "SignalR" + ], + "description": "Update the state of specified private endpoint connection", + "operationId": "SignalRPrivateEndpointConnections_Update", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/privatelinks.json#/parameters/PrivateEndpointConnectionName" + }, + { + "in": "body", + "name": "parameters", + "description": "The resource of private endpoint and its properties", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "OK. The response indicates the private endpoint connection is updated successfully.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SignalRPrivateEndpointConnections_Update": { + "$ref": "./examples/SignalRPrivateEndpointConnections_Update.json" + } + } + }, + "delete": { + "tags": [ + "SignalR" + ], + "description": "Delete the specified private endpoint connection", + "operationId": "SignalRPrivateEndpointConnections_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/privatelinks.json#/parameters/PrivateEndpointConnectionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response indicates the resource is already deleted." + }, + "202": { + "description": "Accepted. The response indicates the delete operation is performed in the background." + }, + "204": { + "description": "Success. The response indicates the private endpoint connection is already deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "SignalRPrivateEndpointConnections_Delete": { + "$ref": "./examples/SignalRPrivateEndpointConnections_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/privateLinkResources": { + "get": { + "tags": [ + "SignalR" + ], + "description": "Get the private link resources that need to be created for a resource.", + "operationId": "SignalRPrivateLinkResources_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes a list of private link resources.", + "schema": { + "$ref": "#/definitions/PrivateLinkResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SignalRPrivateLinkResources_List": { + "$ref": "./examples/SignalRPrivateLinkResources_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/regenerateKey": { + "post": { + "tags": [ + "SignalR" + ], + "description": "Regenerate the access key for the resource. PrimaryKey and SecondaryKey cannot be regenerated at the same time.", + "operationId": "SignalR_RegenerateKey", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "parameters", + "description": "Parameter that describes the Regenerate Key Operation.", + "required": true, + "schema": { + "$ref": "#/definitions/RegenerateKeyParameters" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SignalRKeys" + } + }, + "202": { + "description": "Accepted and an async operation is executing in background to make the new key to take effect. The response contains new access keys and a Location header to query the async operation result.", + "schema": { + "$ref": "#/definitions/SignalRKeys" + }, + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "SignalR_RegenerateKey": { + "$ref": "./examples/SignalR_RegenerateKey.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/replicas": { + "get": { + "tags": [ + "SignalR" + ], + "description": "List all replicas belong to this resource", + "operationId": "SignalRReplicas_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes replicas of the resource.", + "schema": { + "$ref": "#/definitions/ReplicaList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SignalRReplicas_List": { + "$ref": "./examples/SignalRReplicas_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/replicas/{replicaName}": { + "get": { + "tags": [ + "SignalR" + ], + "description": "Get the replica and its properties.", + "operationId": "SignalRReplicas_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ReplicaName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the corresponding replica.", + "schema": { + "$ref": "#/definitions/Replica" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SignalRReplicas_Get": { + "$ref": "./examples/SignalRReplicas_Get.json" + } + } + }, + "put": { + "tags": [ + "SignalR" + ], + "description": "Create or update a replica.", + "operationId": "SignalRReplicas_CreateOrUpdate", + "consumes": [ + "application/json", + "text/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ReplicaName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "Parameters for the create or update operation", + "required": true, + "schema": { + "$ref": "#/definitions/Replica" + } + } + ], + "responses": { + "200": { + "description": "Updated. The response describes a replica.", + "schema": { + "$ref": "#/definitions/Replica" + } + }, + "201": { + "description": "Created. The response describes the new replica and contains a Location header to query the operation result.", + "schema": { + "$ref": "#/definitions/Replica" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "SignalRReplicas_CreateOrUpdate": { + "$ref": "./examples/SignalRReplicas_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "SignalR" + ], + "description": "Operation to delete a replica.", + "operationId": "SignalRReplicas_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ReplicaName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response indicates the replica is deleted." + }, + "204": { + "description": "Success. The response indicates the replica is deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SignalRReplicas_Delete": { + "$ref": "./examples/SignalRReplicas_Delete.json" + } + } + }, + "patch": { + "tags": [ + "SignalR" + ], + "description": "Operation to update an exiting replica.", + "operationId": "SignalRReplicas_Update", + "consumes": [ + "application/json", + "text/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ReplicaName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "Parameters for the update operation", + "required": true, + "schema": { + "$ref": "#/definitions/Replica" + } + } + ], + "responses": { + "200": { + "description": "Success. The response describes a replica.", + "schema": { + "$ref": "#/definitions/Replica" + } + }, + "202": { + "description": "Updated. The response describes the new replica and contains a Location header to query the operation result.", + "schema": { + "$ref": "#/definitions/Replica" + }, + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "SignalRReplicas_Update": { + "$ref": "./examples/SignalRReplicas_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/replicas/{replicaName}/restart": { + "post": { + "tags": [ + "SignalR" + ], + "description": "Operation to restart a replica.", + "operationId": "SignalRReplicas_Restart", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ReplicaName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted. The response indicates the restart operation is performed in the background.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Success. The response indicates the operation is successful and no content will be returned." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "SignalRReplicas_Restart": { + "$ref": "./examples/SignalRReplicas_Restart.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/replicas/{replicaName}/sharedPrivateLinkResources": { + "get": { + "tags": [ + "SignalR" + ], + "description": "List shared private link resources", + "operationId": "SignalRReplicaSharedPrivateLinkResources_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ReplicaName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes a list of shared private link resources.", + "schema": { + "$ref": "#/definitions/SharedPrivateLinkResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SignalRReplicaSharedPrivateLinkResources_List": { + "$ref": "./examples/SignalRReplicaSharedPrivateLinkResources_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/replicas/{replicaName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}": { + "get": { + "tags": [ + "SignalR" + ], + "description": "Get the specified shared private link resource", + "operationId": "SignalRReplicaSharedPrivateLinkResources_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ReplicaName" + }, + { + "$ref": "#/parameters/SharedPrivateLinkResourceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes a shared private link resource.", + "schema": { + "$ref": "#/definitions/SharedPrivateLinkResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SignalRReplicaSharedPrivateLinkResources_Get": { + "$ref": "./examples/SignalRReplicaSharedPrivateLinkResources_Get.json" + } + } + }, + "put": { + "tags": [ + "SignalR" + ], + "description": "Create or update a shared private link resource", + "operationId": "SignalRReplicaSharedPrivateLinkResources_CreateOrUpdate", + "consumes": [ + "application/json", + "text/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ReplicaName" + }, + { + "$ref": "#/parameters/SharedPrivateLinkResourceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "The shared private link resource", + "required": true, + "schema": { + "$ref": "#/definitions/SharedPrivateLinkResource" + } + } + ], + "responses": { + "200": { + "description": "OK. The response indicates the shared private link resource is updated.", + "schema": { + "$ref": "#/definitions/SharedPrivateLinkResource" + } + }, + "201": { + "description": "Created. The response indicates the shared private link resource is created.", + "schema": { + "$ref": "#/definitions/SharedPrivateLinkResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "SignalRReplicaSharedPrivateLinkResources_CreateOrUpdate": { + "$ref": "./examples/SignalRReplicaSharedPrivateLinkResources_CreateOrUpdate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/replicas/{replicaName}/skus": { + "get": { + "tags": [ + "SignalR" + ], + "description": "List all available skus of the replica resource.", + "operationId": "SignalR_ListReplicaSkus", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ReplicaName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes all available skus of the replica resource.", + "schema": { + "$ref": "#/definitions/SkuList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SignalR_ListReplicaSkus": { + "$ref": "./examples/SignalR_ListReplicaSkus.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/restart": { + "post": { + "tags": [ + "SignalR" + ], + "description": "Operation to restart a resource.", + "operationId": "SignalR_Restart", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "202": { + "description": "Accepted. The response indicates the restart operation is performed in the background.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Success. The response indicates the operation is successful and no content will be returned." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "SignalR_Restart": { + "$ref": "./examples/SignalR_Restart.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/sharedPrivateLinkResources": { + "get": { + "tags": [ + "SignalR" + ], + "description": "List shared private link resources", + "operationId": "SignalRSharedPrivateLinkResources_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes a list of shared private link resources.", + "schema": { + "$ref": "#/definitions/SharedPrivateLinkResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SignalRSharedPrivateLinkResources_List": { + "$ref": "./examples/SignalRSharedPrivateLinkResources_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}": { + "get": { + "tags": [ + "SignalR" + ], + "description": "Get the specified shared private link resource", + "operationId": "SignalRSharedPrivateLinkResources_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SharedPrivateLinkResourceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes a shared private link resource.", + "schema": { + "$ref": "#/definitions/SharedPrivateLinkResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SignalRSharedPrivateLinkResources_Get": { + "$ref": "./examples/SignalRSharedPrivateLinkResources_Get.json" + } + } + }, + "put": { + "tags": [ + "SignalR" + ], + "description": "Create or update a shared private link resource", + "operationId": "SignalRSharedPrivateLinkResources_CreateOrUpdate", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SharedPrivateLinkResourceName" + }, + { + "in": "body", + "name": "parameters", + "description": "The shared private link resource", + "required": true, + "schema": { + "$ref": "#/definitions/SharedPrivateLinkResource" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "OK. The response indicates the shared private link resource is updated.", + "schema": { + "$ref": "#/definitions/SharedPrivateLinkResource" + } + }, + "201": { + "description": "Created. The response indicates the shared private link resource is created.", + "schema": { + "$ref": "#/definitions/SharedPrivateLinkResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "SignalRSharedPrivateLinkResources_CreateOrUpdate": { + "$ref": "./examples/SignalRSharedPrivateLinkResources_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "SignalR" + ], + "description": "Delete the specified shared private link resource", + "operationId": "SignalRSharedPrivateLinkResources_Delete", + "parameters": [ + { + "$ref": "#/parameters/SharedPrivateLinkResourceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response indicates the resource is already deleted." + }, + "202": { + "description": "Accepted. The response indicates the delete operation is performed in the background." + }, + "204": { + "description": "Success. The response indicates the private endpoint connection is already deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "SignalRSharedPrivateLinkResources_Delete": { + "$ref": "./examples/SignalRSharedPrivateLinkResources_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/skus": { + "get": { + "tags": [ + "SignalR" + ], + "description": "List all available skus of the resource.", + "operationId": "SignalR_ListSkus", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes all available skus of the resource.", + "schema": { + "$ref": "#/definitions/SkuList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SignalR_ListSkus": { + "$ref": "./examples/SignalR_ListSkus.json" + } + } + } + } + }, + "definitions": { + "ACLAction": { + "description": "Azure Networking ACL Action.", + "enum": [ + "Allow", + "Deny" + ], + "type": "string", + "x-ms-enum": { + "name": "ACLAction", + "modelAsString": true + } + }, + "ApplicationFirewallSettings": { + "description": "Application firewall settings for the resource", + "type": "object", + "properties": { + "clientConnectionCountRules": { + "description": "Rules to control the client connection count", + "maxItems": 10, + "type": "array", + "items": { + "$ref": "#/definitions/ClientConnectionCountRule" + }, + "x-ms-identifiers": [] + }, + "clientTrafficControlRules": { + "description": "Rules to control the client traffic", + "maxItems": 10, + "type": "array", + "items": { + "$ref": "#/definitions/ClientTrafficControlRule" + }, + "x-ms-identifiers": [] + } + } + }, + "ClientConnectionCountRule": { + "description": "A base class for client connection count rules", + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "enum": [ + "ThrottleByJwtSignatureRule", + "ThrottleByUserIdRule", + "ThrottleByJwtCustomClaimRule" + ], + "type": "string", + "x-ms-enum": { + "name": "ClientConnectionCountRuleDiscriminator", + "modelAsString": true + } + } + }, + "discriminator": "type" + }, + "ClientTrafficControlRule": { + "description": "A base class for client traffic control rules", + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "enum": [ + "TrafficThrottleByJwtSignatureRule", + "TrafficThrottleByUserIdRule", + "TrafficThrottleByJwtCustomClaimRule" + ], + "type": "string", + "x-ms-enum": { + "name": "ClientTrafficControlRuleDiscriminator", + "modelAsString": true + } + } + }, + "discriminator": "type" + }, + "CustomCertificate": { + "description": "A custom certificate.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CustomCertificateProperties" + } + } + }, + "CustomCertificateList": { + "description": "Custom certificates list.", + "type": "object", + "properties": { + "value": { + "description": "List of custom certificates of this resource.", + "type": "array", + "items": { + "$ref": "#/definitions/CustomCertificate" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "CustomCertificateProperties": { + "description": "Custom certificate properties.", + "required": [ + "keyVaultBaseUri", + "keyVaultSecretName" + ], + "type": "object", + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "#/definitions/ProvisioningState" + }, + "keyVaultBaseUri": { + "description": "Base uri of the KeyVault that stores certificate.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "keyVaultSecretName": { + "description": "Certificate secret name.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "keyVaultSecretVersion": { + "description": "Certificate secret version.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "CustomDomain": { + "description": "A custom domain", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CustomDomainProperties" + } + } + }, + "CustomDomainList": { + "description": "Custom domains list", + "type": "object", + "properties": { + "value": { + "description": "List of custom domains that bind to this resource.", + "type": "array", + "items": { + "$ref": "#/definitions/CustomDomain" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "CustomDomainProperties": { + "description": "Properties of a custom domain.", + "required": [ + "customCertificate", + "domainName" + ], + "type": "object", + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "#/definitions/ProvisioningState" + }, + "domainName": { + "description": "The custom domain name.", + "type": "string" + }, + "customCertificate": { + "$ref": "#/definitions/ResourceReference" + } + } + }, + "Dimension": { + "description": "Specifications of the Dimension of metrics.", + "type": "object", + "properties": { + "name": { + "description": "The public facing name of the dimension.", + "type": "string" + }, + "displayName": { + "description": "Localized friendly display name of the dimension.", + "type": "string" + }, + "internalName": { + "description": "Name of the dimension as it appears in MDM.", + "type": "string" + }, + "toBeExportedForShoebox": { + "description": "A Boolean flag indicating whether this dimension should be included for the shoebox export scenario.", + "type": "boolean" + } + } + }, + "FeatureFlags": { + "description": "FeatureFlags is the supported features of Azure SignalR service.\r\n- ServiceMode: Flag for backend server for SignalR service. Values allowed: \"Default\": have your own backend server; \"Serverless\": your application doesn't have a backend server; \"Classic\": for backward compatibility. Support both Default and Serverless mode but not recommended; \"PredefinedOnly\": for future use.\r\n- EnableConnectivityLogs: \"true\"/\"false\", to enable/disable the connectivity log category respectively.\r\n- EnableMessagingLogs: \"true\"/\"false\", to enable/disable the connectivity log category respectively.\r\n- EnableLiveTrace: Live Trace allows you to know what's happening inside Azure SignalR service, it will give you live traces in real time, it will be helpful when you developing your own Azure SignalR based web application or self-troubleshooting some issues. Please note that live traces are counted as outbound messages that will be charged. Values allowed: \"true\"/\"false\", to enable/disable live trace feature.", + "enum": [ + "ServiceMode", + "EnableConnectivityLogs", + "EnableMessagingLogs", + "EnableLiveTrace" + ], + "type": "string", + "x-ms-enum": { + "name": "FeatureFlags", + "modelAsString": true + } + }, + "IPRule": { + "description": "An IP rule", + "type": "object", + "properties": { + "value": { + "description": "An IP or CIDR or ServiceTag", + "type": "string" + }, + "action": { + "$ref": "#/definitions/ACLAction" + } + } + }, + "KeyType": { + "description": "The type of access key.", + "enum": [ + "Primary", + "Secondary", + "Salt" + ], + "type": "string", + "x-ms-enum": { + "name": "KeyType", + "modelAsString": true + } + }, + "LiveTraceCategory": { + "description": "Live trace category configuration of a Microsoft.SignalRService resource.", + "type": "object", + "properties": { + "name": { + "description": "Gets or sets the live trace category's name.\r\nAvailable values: ConnectivityLogs, MessagingLogs.\r\nCase insensitive.", + "type": "string" + }, + "enabled": { + "description": "Indicates whether or the live trace category is enabled.\r\nAvailable values: true, false.\r\nCase insensitive.", + "type": "string" + } + } + }, + "LiveTraceConfiguration": { + "description": "Live trace configuration of a Microsoft.SignalRService resource.", + "type": "object", + "properties": { + "enabled": { + "description": "Indicates whether or not enable live trace.\r\nWhen it's set to true, live trace client can connect to the service.\r\nOtherwise, live trace client can't connect to the service, so that you are unable to receive any log, no matter what you configure in \"categories\".\r\nAvailable values: true, false.\r\nCase insensitive.", + "default": "false", + "type": "string" + }, + "categories": { + "description": "Gets or sets the list of category configurations.", + "type": "array", + "items": { + "$ref": "#/definitions/LiveTraceCategory" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "LogSpecification": { + "description": "Specifications of the Logs for Azure Monitoring.", + "type": "object", + "properties": { + "name": { + "description": "Name of the log.", + "type": "string" + }, + "displayName": { + "description": "Localized friendly display name of the log.", + "type": "string" + } + } + }, + "ManagedIdentity": { + "description": "A class represent managed identities used for request and response", + "type": "object", + "properties": { + "type": { + "$ref": "#/definitions/ManagedIdentityType" + }, + "userAssignedIdentities": { + "description": "Get or set the user assigned identities", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/UserAssignedIdentityProperty" + } + }, + "principalId": { + "description": "Get the principal id for the system assigned identity.\r\nOnly be used in response.", + "type": "string", + "readOnly": true + }, + "tenantId": { + "description": "Get the tenant id for the system assigned identity.\r\nOnly be used in response", + "type": "string", + "readOnly": true + } + } + }, + "ManagedIdentitySettings": { + "description": "Managed identity settings for upstream.", + "type": "object", + "properties": { + "resource": { + "description": "The Resource indicating the App ID URI of the target resource.\r\nIt also appears in the aud (audience) claim of the issued token.", + "type": "string" + } + } + }, + "ManagedIdentityType": { + "description": "Represents the identity type: systemAssigned, userAssigned, None", + "enum": [ + "None", + "SystemAssigned", + "UserAssigned" + ], + "type": "string", + "x-ms-enum": { + "name": "ManagedIdentityType", + "modelAsString": true + } + }, + "MetricSpecification": { + "description": "Specifications of the Metrics for Azure Monitoring.", + "type": "object", + "properties": { + "name": { + "description": "Name of the metric.", + "type": "string" + }, + "displayName": { + "description": "Localized friendly display name of the metric.", + "type": "string" + }, + "displayDescription": { + "description": "Localized friendly description of the metric.", + "type": "string" + }, + "unit": { + "description": "The unit that makes sense for the metric.", + "type": "string" + }, + "aggregationType": { + "description": "Only provide one value for this field. Valid values: Average, Minimum, Maximum, Total, Count.", + "type": "string" + }, + "fillGapWithZero": { + "description": "Optional. If set to true, then zero will be returned for time duration where no metric is emitted/published. \r\nEx. a metric that returns the number of times a particular error code was emitted. The error code may not appear \r\noften, instead of the RP publishing 0, Shoebox can auto fill in 0s for time periods where nothing was emitted.", + "type": "string" + }, + "category": { + "description": "The name of the metric category that the metric belongs to. A metric can only belong to a single category.", + "type": "string" + }, + "dimensions": { + "description": "The dimensions of the metrics.", + "type": "array", + "items": { + "$ref": "#/definitions/Dimension" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "NameAvailability": { + "description": "Result of the request to check name availability. It contains a flag and possible reason of failure.", + "type": "object", + "properties": { + "nameAvailable": { + "description": "Indicates whether the name is available or not.", + "type": "boolean" + }, + "reason": { + "description": "The reason of the availability. Required if name is not available.", + "type": "string" + }, + "message": { + "description": "The message of the operation.", + "type": "string" + } + } + }, + "NameAvailabilityParameters": { + "description": "Data POST-ed to the nameAvailability action", + "required": [ + "name", + "type" + ], + "type": "object", + "properties": { + "type": { + "description": "The resource type. Can be \"Microsoft.SignalRService/SignalR\", \"Microsoft.SignalRService/WebPubSub\", \"Microsoft.SignalRService/SignalR/replicas\" or \"Microsoft.SignalRService/WebPubSub/replicas\"", + "type": "string" + }, + "name": { + "description": "The resource name to validate. e.g.\"my-resource-name\"", + "type": "string" + } + } + }, + "NetworkACL": { + "description": "Network ACL", + "type": "object", + "properties": { + "allow": { + "description": "Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.", + "type": "array", + "items": { + "$ref": "#/definitions/SignalRRequestType" + }, + "x-ms-identifiers": [] + }, + "deny": { + "description": "Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.", + "type": "array", + "items": { + "$ref": "#/definitions/SignalRRequestType" + }, + "x-ms-identifiers": [] + } + } + }, + "Operation": { + "description": "REST API operation supported by resource provider.", + "type": "object", + "properties": { + "name": { + "description": "Name of the operation with format: {provider}/{resource}/{operation}", + "type": "string" + }, + "isDataAction": { + "description": "If the operation is a data action. (for data plane rbac)", + "type": "boolean" + }, + "display": { + "$ref": "#/definitions/OperationDisplay" + }, + "origin": { + "description": "Optional. The intended executor of the operation; governs the display of the operation in the RBAC UX and the audit logs UX.", + "type": "string" + }, + "properties": { + "x-ms-client-flatten": false, + "$ref": "#/definitions/OperationProperties" + } + } + }, + "OperationDisplay": { + "description": "The object that describes a operation.", + "type": "object", + "properties": { + "provider": { + "description": "Friendly name of the resource provider", + "type": "string" + }, + "resource": { + "description": "Resource type on which the operation is performed.", + "type": "string" + }, + "operation": { + "description": "The localized friendly name for the operation.", + "type": "string" + }, + "description": { + "description": "The localized friendly description for the operation", + "type": "string" + } + } + }, + "OperationList": { + "description": "Result of the request to list REST API operations. It contains a list of operations.", + "type": "object", + "properties": { + "value": { + "description": "List of operations supported by the resource provider.", + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "nextLink": { + "description": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "OperationProperties": { + "description": "Extra Operation properties.", + "type": "object", + "properties": { + "serviceSpecification": { + "$ref": "#/definitions/ServiceSpecification" + } + } + }, + "PrivateEndpoint": { + "description": "Private endpoint", + "type": "object", + "properties": { + "id": { + "description": "Full qualified Id of the private endpoint", + "type": "string" + } + } + }, + "PrivateEndpointACL": { + "description": "ACL for a private endpoint", + "required": [ + "name" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/NetworkACL" + } + ], + "properties": { + "name": { + "description": "Name of the private endpoint connection", + "type": "string" + } + } + }, + "PrivateEndpointConnection": { + "description": "A private endpoint connection to an azure resource", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PrivateEndpointConnectionProperties" + } + } + }, + "PrivateEndpointConnectionList": { + "description": "A list of private endpoint connections", + "type": "object", + "properties": { + "value": { + "description": "The list of the private endpoint connections", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "Request URL that can be used to query next page of private endpoint connections. Returned when the total number of requested private endpoint connections exceed maximum page size.", + "type": "string" + } + } + }, + "PrivateEndpointConnectionProperties": { + "description": "Private endpoint connection properties", + "type": "object", + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "#/definitions/ProvisioningState" + }, + "privateEndpoint": { + "$ref": "#/definitions/PrivateEndpoint" + }, + "groupIds": { + "description": "Group IDs", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/PrivateLinkServiceConnectionState" + } + } + }, + "PrivateLinkResource": { + "description": "Private link resource", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PrivateLinkResourceProperties" + } + } + }, + "PrivateLinkResourceList": { + "description": "Contains a list of PrivateLinkResource and a possible link to query more results", + "type": "object", + "properties": { + "value": { + "description": "List of PrivateLinkResource", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "PrivateLinkResourceProperties": { + "description": "Private link resource properties", + "type": "object", + "properties": { + "groupId": { + "description": "Group Id of the private link resource", + "type": "string" + }, + "requiredMembers": { + "description": "Required members of the private link resource", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "requiredZoneNames": { + "description": "Required private DNS zone names", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "shareablePrivateLinkResourceTypes": { + "description": "The list of resources that are onboarded to private link service", + "type": "array", + "items": { + "$ref": "#/definitions/ShareablePrivateLinkResourceType" + }, + "x-ms-identifiers": [] + } + } + }, + "PrivateLinkServiceConnectionState": { + "description": "Connection state of the private endpoint connection", + "type": "object", + "properties": { + "status": { + "$ref": "#/definitions/PrivateLinkServiceConnectionStatus" + }, + "description": { + "description": "The reason for approval/rejection of the connection.", + "type": "string" + }, + "actionsRequired": { + "description": "A message indicating if changes on the service provider require any updates on the consumer.", + "type": "string" + } + } + }, + "PrivateLinkServiceConnectionStatus": { + "description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.", + "enum": [ + "Pending", + "Approved", + "Rejected", + "Disconnected" + ], + "type": "string", + "x-ms-enum": { + "name": "PrivateLinkServiceConnectionStatus", + "modelAsString": true + } + }, + "ProvisioningState": { + "description": "Provisioning state of the resource.", + "enum": [ + "Unknown", + "Succeeded", + "Failed", + "Canceled", + "Running", + "Creating", + "Updating", + "Deleting", + "Moving" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "RegenerateKeyParameters": { + "description": "Parameters describes the request to regenerate access keys", + "type": "object", + "properties": { + "keyType": { + "$ref": "#/definitions/KeyType" + } + } + }, + "Replica": { + "description": "A class represent a replica resource.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "sku": { + "$ref": "#/definitions/ResourceSku" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ReplicaProperties" + } + } + }, + "ReplicaList": { + "type": "object", + "properties": { + "value": { + "description": "List of the replica", + "type": "array", + "items": { + "$ref": "#/definitions/Replica" + } + }, + "nextLink": { + "description": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "ReplicaProperties": { + "type": "object", + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "#/definitions/ProvisioningState" + }, + "regionEndpointEnabled": { + "description": "Enable or disable the regional endpoint. Default to \"Enabled\".\r\nWhen it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected.", + "default": "Enabled", + "type": "string" + }, + "resourceStopped": { + "description": "Stop or start the resource. Default to \"false\".\r\nWhen it's true, the data plane of the resource is shutdown.\r\nWhen it's false, the data plane of the resource is started.", + "default": "false", + "type": "string" + } + } + }, + "ResourceLogCategory": { + "description": "Resource log category configuration of a Microsoft.SignalRService resource.", + "type": "object", + "properties": { + "name": { + "description": "Gets or sets the resource log category's name.\r\nAvailable values: ConnectivityLogs, MessagingLogs.\r\nCase insensitive.", + "type": "string" + }, + "enabled": { + "description": "Indicates whether or the resource log category is enabled.\r\nAvailable values: true, false.\r\nCase insensitive.", + "type": "string" + } + } + }, + "ResourceLogConfiguration": { + "description": "Resource log configuration of a Microsoft.SignalRService resource.", + "type": "object", + "properties": { + "categories": { + "description": "Gets or sets the list of category configurations.", + "type": "array", + "items": { + "$ref": "#/definitions/ResourceLogCategory" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "ResourceReference": { + "description": "Reference to a resource.", + "type": "object", + "properties": { + "id": { + "description": "Resource ID.", + "type": "string" + } + } + }, + "ResourceSku": { + "description": "The billing information of the resource.", + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "description": "The name of the SKU. Required.\r\n\r\nAllowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2", + "type": "string" + }, + "tier": { + "$ref": "#/definitions/SignalRSkuTier" + }, + "size": { + "description": "Not used. Retained for future use.", + "type": "string", + "readOnly": true + }, + "family": { + "description": "Not used. Retained for future use.", + "type": "string", + "readOnly": true + }, + "capacity": { + "format": "int32", + "description": "Optional, integer. The unit count of the resource.\r\n1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default.\r\n\r\nIf present, following values are allowed:\r\n Free_F1: 1;\r\n Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\r\n Premium_P1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\r\n Premium_P2: 100,200,300,400,500,600,700,800,900,1000;", + "type": "integer" + } + } + }, + "ScaleType": { + "description": "The scale type applicable to the sku.", + "enum": [ + "None", + "Manual", + "Automatic" + ], + "type": "string", + "x-ms-enum": { + "name": "ScaleType", + "modelAsString": true + } + }, + "ServerlessSettings": { + "description": "Serverless settings.", + "type": "object", + "properties": { + "connectionTimeoutInSeconds": { + "format": "int32", + "description": "Gets or sets Client Connection Timeout. Optional to be set.\r\nValue in seconds.\r\nDefault value is 30 seconds.\r\nCustomer should set the timeout to a shorter period if messages are expected to be sent in shorter intervals,\r\nand want the client to disconnect more quickly after the last message is sent.\r\nYou can set the timeout to a longer period if messages are expected to be sent in longer intervals,\r\nand they want to keep the same client connection alive during this session.\r\nThe service considers the client disconnected if it hasn't received a message (including keep-alive) in this interval.", + "default": 30, + "maximum": 120, + "minimum": 1, + "type": "integer" + }, + "keepAliveIntervalInSeconds": { + "format": "int32", + "description": "Gets or sets the Keep-Alive Interval. Optional to set.\r\nValue is in seconds.\r\nThe default value is 15 seconds.\r\nCustomers should set this value to a shorter period if they want the service to send keep-alive messages more frequently, \r\nensuring timely checks of the connection status.\r\nConversely, customers can set this value to a longer period if they want the service to send keep-alive messages less frequently, \r\nreducing network traffic, but note that it may take longer to detect a disconnection.\r\nThis interval ensures that the connection is maintained by sending periodic keep-alive messages to the client.", + "maximum": 120, + "minimum": 1, + "type": "integer" + } + } + }, + "ServerlessUpstreamSettings": { + "description": "The settings for the Upstream when the service is in server-less mode.", + "type": "object", + "properties": { + "templates": { + "description": "Gets or sets the list of Upstream URL templates. Order matters, and the first matching template takes effects.", + "type": "array", + "items": { + "$ref": "#/definitions/UpstreamTemplate" + }, + "x-ms-identifiers": [] + } + } + }, + "ServiceKind": { + "description": "The kind of the service", + "enum": [ + "SignalR", + "RawWebSockets" + ], + "type": "string", + "x-ms-enum": { + "name": "ServiceKind", + "modelAsString": true + } + }, + "ServiceSpecification": { + "description": "An object that describes a specification.", + "type": "object", + "properties": { + "metricSpecifications": { + "description": "Specifications of the Metrics for Azure Monitoring.", + "type": "array", + "items": { + "$ref": "#/definitions/MetricSpecification" + }, + "x-ms-identifiers": [ + "name", + "unit" + ] + }, + "logSpecifications": { + "description": "Specifications of the Logs for Azure Monitoring.", + "type": "array", + "items": { + "$ref": "#/definitions/LogSpecification" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "ShareablePrivateLinkResourceProperties": { + "description": "Describes the properties of a resource type that has been onboarded to private link service", + "type": "object", + "properties": { + "description": { + "description": "The description of the resource type that has been onboarded to private link service", + "type": "string" + }, + "groupId": { + "description": "The resource provider group id for the resource that has been onboarded to private link service", + "type": "string" + }, + "type": { + "description": "The resource provider type for the resource that has been onboarded to private link service", + "type": "string" + } + } + }, + "ShareablePrivateLinkResourceType": { + "description": "Describes a resource type that has been onboarded to private link service", + "type": "object", + "properties": { + "name": { + "description": "The name of the resource type that has been onboarded to private link service", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/ShareablePrivateLinkResourceProperties" + } + } + }, + "SharedPrivateLinkResource": { + "description": "Describes a Shared Private Link Resource", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SharedPrivateLinkResourceProperties" + } + } + }, + "SharedPrivateLinkResourceList": { + "description": "A list of shared private link resources", + "type": "object", + "properties": { + "value": { + "description": "The list of the shared private link resources", + "type": "array", + "items": { + "$ref": "#/definitions/SharedPrivateLinkResource" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "Request URL that can be used to query next page of private endpoint connections. Returned when the total number of requested private endpoint connections exceed maximum page size.", + "type": "string" + } + } + }, + "SharedPrivateLinkResourceProperties": { + "description": "Describes the properties of an existing Shared Private Link Resource", + "required": [ + "groupId", + "privateLinkResourceId" + ], + "type": "object", + "properties": { + "groupId": { + "description": "The group id from the provider of resource the shared private link resource is for", + "type": "string" + }, + "privateLinkResourceId": { + "description": "The resource id of the resource the shared private link resource is for", + "type": "string" + }, + "provisioningState": { + "readOnly": true, + "$ref": "#/definitions/ProvisioningState" + }, + "requestMessage": { + "description": "The request message for requesting approval of the shared private link resource", + "type": "string" + }, + "fqdns": { + "description": "A list of FQDNs for third party private link service", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "status": { + "readOnly": true, + "$ref": "#/definitions/SharedPrivateLinkResourceStatus" + } + } + }, + "SharedPrivateLinkResourceStatus": { + "description": "Status of the shared private link resource", + "enum": [ + "Pending", + "Approved", + "Rejected", + "Disconnected", + "Timeout" + ], + "type": "string", + "x-ms-enum": { + "name": "SharedPrivateLinkResourceStatus", + "modelAsString": true + } + }, + "SignalRCorsSettings": { + "description": "Cross-Origin Resource Sharing (CORS) settings.", + "type": "object", + "properties": { + "allowedOrigins": { + "description": "Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use \"*\" to allow all. If omitted, allow all by default.", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + } + } + }, + "SignalRFeature": { + "description": "Feature of a resource, which controls the runtime behavior.", + "required": [ + "flag", + "value" + ], + "type": "object", + "properties": { + "flag": { + "$ref": "#/definitions/FeatureFlags" + }, + "value": { + "description": "Value of the feature flag. See Azure SignalR service document https://docs.microsoft.com/azure/azure-signalr/ for allowed values.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "properties": { + "description": "Optional properties related to this feature.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "SignalRKeys": { + "description": "A class represents the access keys of the resource.", + "type": "object", + "properties": { + "primaryKey": { + "description": "The primary access key.", + "type": "string", + "x-ms-secret": true + }, + "secondaryKey": { + "description": "The secondary access key.", + "type": "string", + "x-ms-secret": true + }, + "primaryConnectionString": { + "description": "Connection string constructed via the primaryKey", + "type": "string", + "x-ms-secret": true + }, + "secondaryConnectionString": { + "description": "Connection string constructed via the secondaryKey", + "type": "string", + "x-ms-secret": true + } + } + }, + "SignalRNetworkACLs": { + "description": "Network ACLs for the resource", + "type": "object", + "properties": { + "defaultAction": { + "$ref": "#/definitions/ACLAction" + }, + "publicNetwork": { + "$ref": "#/definitions/NetworkACL" + }, + "privateEndpoints": { + "description": "ACLs for requests from private endpoints", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointACL" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "ipRules": { + "description": "IP rules for filtering public traffic", + "maxItems": 30, + "type": "array", + "items": { + "$ref": "#/definitions/IPRule" + }, + "x-ms-identifiers": [] + } + } + }, + "SignalRProperties": { + "description": "A class that describes the properties of the resource", + "type": "object", + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "#/definitions/ProvisioningState" + }, + "externalIP": { + "description": "The publicly accessible IP of the resource.", + "type": "string", + "readOnly": true + }, + "hostName": { + "description": "FQDN of the service instance.", + "type": "string", + "readOnly": true + }, + "publicPort": { + "format": "int32", + "description": "The publicly accessible port of the resource which is designed for browser/client side usage.", + "type": "integer", + "readOnly": true + }, + "serverPort": { + "format": "int32", + "description": "The publicly accessible port of the resource which is designed for customer server side usage.", + "type": "integer", + "readOnly": true + }, + "version": { + "description": "Version of the resource. Probably you need the same or higher version of client SDKs.", + "type": "string", + "readOnly": true + }, + "privateEndpointConnections": { + "description": "Private endpoint connections to the resource.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "sharedPrivateLinkResources": { + "description": "The list of shared private link resources.", + "type": "array", + "items": { + "$ref": "#/definitions/SharedPrivateLinkResource" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "tls": { + "$ref": "#/definitions/SignalRTlsSettings" + }, + "hostNamePrefix": { + "description": "Deprecated.", + "type": "string", + "readOnly": true + }, + "features": { + "description": "List of the featureFlags.\r\n\r\nFeatureFlags that are not included in the parameters for the update operation will not be modified.\r\nAnd the response will only include featureFlags that are explicitly set. \r\nWhen a featureFlag is not explicitly set, its globally default value will be used\r\nBut keep in mind, the default value doesn't mean \"false\". It varies in terms of different FeatureFlags.", + "type": "array", + "items": { + "$ref": "#/definitions/SignalRFeature" + }, + "x-ms-identifiers": [] + }, + "liveTraceConfiguration": { + "$ref": "#/definitions/LiveTraceConfiguration" + }, + "resourceLogConfiguration": { + "$ref": "#/definitions/ResourceLogConfiguration" + }, + "cors": { + "$ref": "#/definitions/SignalRCorsSettings" + }, + "serverless": { + "$ref": "#/definitions/ServerlessSettings" + }, + "upstream": { + "$ref": "#/definitions/ServerlessUpstreamSettings" + }, + "networkACLs": { + "$ref": "#/definitions/SignalRNetworkACLs" + }, + "applicationFirewall": { + "$ref": "#/definitions/ApplicationFirewallSettings" + }, + "publicNetworkAccess": { + "description": "Enable or disable public network access. Default to \"Enabled\".\r\nWhen it's Enabled, network ACLs still apply.\r\nWhen it's Disabled, public network access is always disabled no matter what you set in network ACLs.", + "default": "Enabled", + "type": "string" + }, + "disableLocalAuth": { + "description": "DisableLocalAuth\r\nEnable or disable local auth with AccessKey\r\nWhen set as true, connection with AccessKey=xxx won't work.", + "default": false, + "type": "boolean" + }, + "disableAadAuth": { + "description": "DisableLocalAuth\r\nEnable or disable aad auth\r\nWhen set as true, connection with AuthType=aad won't work.", + "default": false, + "type": "boolean" + }, + "regionEndpointEnabled": { + "description": "Enable or disable the regional endpoint. Default to \"Enabled\".\r\nWhen it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected.\r\nThis property is replica specific. Disable the regional endpoint without replica is not allowed.", + "default": "Enabled", + "type": "string" + }, + "resourceStopped": { + "description": "Stop or start the resource. Default to \"False\".\r\nWhen it's true, the data plane of the resource is shutdown.\r\nWhen it's false, the data plane of the resource is started.", + "default": "false", + "type": "string" + } + } + }, + "SignalRRequestType": { + "description": "The incoming request type to the service", + "enum": [ + "ClientConnection", + "ServerConnection", + "RESTAPI", + "Trace" + ], + "type": "string", + "x-ms-enum": { + "name": "SignalRRequestType", + "modelAsString": true + } + }, + "SignalRResource": { + "description": "A class represent a resource.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "sku": { + "$ref": "#/definitions/ResourceSku" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SignalRProperties" + }, + "kind": { + "x-ms-mutability": [ + "read", + "create" + ], + "$ref": "#/definitions/ServiceKind" + }, + "identity": { + "$ref": "#/definitions/ManagedIdentity" + } + } + }, + "SignalRResourceList": { + "description": "Object that includes an array of resources and a possible link for next set.", + "type": "object", + "properties": { + "value": { + "description": "List of the resources", + "type": "array", + "items": { + "$ref": "#/definitions/SignalRResource" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "SignalRSkuTier": { + "description": "Optional tier of this particular SKU. 'Standard' or 'Free'. \r\n\r\n`Basic` is deprecated, use `Standard` instead.", + "enum": [ + "Free", + "Basic", + "Standard", + "Premium" + ], + "type": "string", + "x-ms-enum": { + "name": "SignalRSkuTier", + "modelAsString": true + } + }, + "SignalRTlsSettings": { + "description": "TLS settings for the resource", + "type": "object", + "properties": { + "clientCertEnabled": { + "description": "Request client certificate during TLS handshake if enabled. Not supported for free tier. Any input will be ignored for free tier.", + "default": false, + "type": "boolean" + } + } + }, + "SignalRUsage": { + "description": "Object that describes a specific usage of the resources.", + "type": "object", + "properties": { + "id": { + "description": "Fully qualified ARM resource id", + "type": "string" + }, + "currentValue": { + "format": "int64", + "description": "Current value for the usage quota.", + "type": "integer" + }, + "limit": { + "format": "int64", + "description": "The maximum permitted value for the usage quota. If there is no limit, this value will be -1.", + "type": "integer" + }, + "name": { + "$ref": "#/definitions/SignalRUsageName" + }, + "unit": { + "description": "Representing the units of the usage quota. Possible values are: Count, Bytes, Seconds, Percent, CountPerSecond, BytesPerSecond.", + "type": "string" + } + } + }, + "SignalRUsageList": { + "description": "Object that includes an array of the resource usages and a possible link for next set.", + "type": "object", + "properties": { + "value": { + "description": "List of the resource usages", + "type": "array", + "items": { + "$ref": "#/definitions/SignalRUsage" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "SignalRUsageName": { + "description": "Localizable String object containing the name and a localized value.", + "type": "object", + "properties": { + "value": { + "description": "The identifier of the usage.", + "type": "string" + }, + "localizedValue": { + "description": "Localized name of the usage.", + "type": "string" + } + } + }, + "Sku": { + "description": "Describes an available sku.\"", + "type": "object", + "properties": { + "resourceType": { + "description": "The resource type that this object applies to", + "type": "string", + "readOnly": true + }, + "sku": { + "readOnly": true, + "$ref": "#/definitions/ResourceSku" + }, + "capacity": { + "readOnly": true, + "$ref": "#/definitions/SkuCapacity" + } + } + }, + "SkuCapacity": { + "description": "Describes scaling information of a sku.", + "type": "object", + "properties": { + "minimum": { + "format": "int32", + "description": "The lowest permitted capacity for this resource", + "type": "integer", + "readOnly": true + }, + "maximum": { + "format": "int32", + "description": "The highest permitted capacity for this resource", + "type": "integer", + "readOnly": true + }, + "default": { + "format": "int32", + "description": "The default capacity.", + "type": "integer", + "readOnly": true + }, + "allowedValues": { + "description": "Allows capacity value list.", + "type": "array", + "items": { + "format": "int32", + "type": "integer" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "scaleType": { + "readOnly": true, + "$ref": "#/definitions/ScaleType" + } + } + }, + "SkuList": { + "description": "The list skus operation response", + "type": "object", + "properties": { + "value": { + "description": "The list of skus available for the resource.", + "type": "array", + "items": { + "$ref": "#/definitions/Sku" + }, + "readOnly": true, + "x-ms-identifiers": [ + "resourceType", + "/sku/name", + "/sku/tier" + ] + }, + "nextLink": { + "description": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string", + "readOnly": true + } + } + }, + "ThrottleByJwtCustomClaimRule": { + "description": "Throttle the client connection by a custom JWT claim", + "required": [ + "claimName" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ClientConnectionCountRule" + } + ], + "properties": { + "claimName": { + "description": "The name of the claim in the JWT token. The client connection with the same claim value will be aggregated. If the claim is not found in the token, the connection will be allowed.", + "type": "string" + }, + "maxCount": { + "format": "int32", + "description": "Maximum connection count allowed for the same Jwt claim value. Clients with the same Jwt claim will get rejected if the connection count exceeds this value. Default value is 20.", + "default": 20, + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + } + }, + "x-ms-discriminator-value": "ThrottleByJwtCustomClaimRule" + }, + "ThrottleByJwtSignatureRule": { + "description": "Throttle the client connection by the JWT signature", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ClientConnectionCountRule" + } + ], + "properties": { + "maxCount": { + "format": "int32", + "description": "Maximum connection count allowed for the same JWT signature. Clients with the same JWT signature will get rejected if the connection count exceeds this value. Default value is 20.", + "default": 20, + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + } + }, + "x-ms-discriminator-value": "ThrottleByJwtSignatureRule" + }, + "ThrottleByUserIdRule": { + "description": "Throttle the client connection by the user ID", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ClientConnectionCountRule" + } + ], + "properties": { + "maxCount": { + "format": "int32", + "description": "Maximum connection count allowed for the same user ID. Clients with the same user ID will get rejected if the connection count exceeds this value. Default value is 20.", + "default": 20, + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + } + }, + "x-ms-discriminator-value": "ThrottleByUserIdRule" + }, + "TrafficThrottleByJwtCustomClaimRule": { + "description": "Throttle the client traffic by a custom JWT claim", + "required": [ + "claimName" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ClientTrafficControlRule" + } + ], + "properties": { + "claimName": { + "description": "The name of the claim in the JWT token. The message bytes with the same claim value will be aggregated. If the claim is not found in the token, the rule will be skipped.", + "type": "string" + }, + "maxInboundMessageBytes": { + "format": "int64", + "description": "Maximum accumulated inbound message bytes allowed for the same JWT signature within a time window. Clients with the same JWT claim will get disconnected if the message bytes exceeds this value. Default value is 1GB.", + "minimum": 0, + "type": "integer" + }, + "aggregationWindowInSeconds": { + "format": "int32", + "description": "The aggregation window for the message bytes. The message bytes will be aggregated in this window and be reset after the window. Default value is 60 seconds.", + "default": 60, + "maximum": 3600, + "minimum": 10, + "type": "integer" + } + }, + "x-ms-discriminator-value": "TrafficThrottleByJwtCustomClaimRule" + }, + "TrafficThrottleByJwtSignatureRule": { + "description": "Throttle the client traffic by the JWT signature", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ClientTrafficControlRule" + } + ], + "properties": { + "maxInboundMessageBytes": { + "format": "int64", + "description": "Maximum accumulated inbound message bytes allowed for the same JWT signature within a time window. Clients with the same JWT signature will get disconnected if the message bytes exceeds this value. Default value is 1GB.", + "minimum": 0, + "type": "integer" + }, + "aggregationWindowInSeconds": { + "format": "int32", + "description": "The aggregation window for the message bytes. The message bytes will be aggregated in this window and be reset after the window. Default value is 60 seconds.", + "default": 60, + "maximum": 3600, + "minimum": 10, + "type": "integer" + } + }, + "x-ms-discriminator-value": "TrafficThrottleByJwtSignatureRule" + }, + "TrafficThrottleByUserIdRule": { + "description": "Throttle the client traffic by the user ID", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ClientTrafficControlRule" + } + ], + "properties": { + "maxInboundMessageBytes": { + "format": "int64", + "description": "Maximum accumulated inbound message bytes allowed for the same user ID within a time window. Clients with the same user ID will get disconnected if the message bytes exceeds this value. Default value is 1GB.", + "minimum": 0, + "type": "integer" + }, + "aggregationWindowInSeconds": { + "format": "int32", + "description": "The aggregation window for the message bytes. The message bytes will be aggregated in this window and be reset after the window. Default value is 60 seconds.", + "default": 60, + "maximum": 3600, + "minimum": 10, + "type": "integer" + } + }, + "x-ms-discriminator-value": "TrafficThrottleByUserIdRule" + }, + "UpstreamAuthSettings": { + "description": "Upstream auth settings. If not set, no auth is used for upstream messages.", + "type": "object", + "properties": { + "type": { + "$ref": "#/definitions/UpstreamAuthType" + }, + "managedIdentity": { + "$ref": "#/definitions/ManagedIdentitySettings" + } + } + }, + "UpstreamAuthType": { + "description": "Upstream auth type enum.", + "enum": [ + "None", + "ManagedIdentity" + ], + "type": "string", + "x-ms-enum": { + "name": "UpstreamAuthType", + "modelAsString": true + } + }, + "UpstreamTemplate": { + "description": "Upstream template item settings. It defines the Upstream URL of the incoming requests.\r\nThe template defines the pattern of the event, the hub or the category of the incoming request that matches current URL template.", + "required": [ + "urlTemplate" + ], + "type": "object", + "properties": { + "hubPattern": { + "description": "Gets or sets the matching pattern for hub names. If not set, it matches any hub.\r\nThere are 3 kind of patterns supported:\r\n 1. \"*\", it to matches any hub name.\r\n 2. Combine multiple hubs with \",\", for example \"hub1,hub2\", it matches \"hub1\" and \"hub2\".\r\n 3. The single hub name, for example, \"hub1\", it matches \"hub1\".", + "type": "string" + }, + "eventPattern": { + "description": "Gets or sets the matching pattern for event names. If not set, it matches any event.\r\nThere are 3 kind of patterns supported:\r\n 1. \"*\", it to matches any event name.\r\n 2. Combine multiple events with \",\", for example \"connect,disconnect\", it matches event \"connect\" and \"disconnect\".\r\n 3. The single event name, for example, \"connect\", it matches \"connect\".", + "type": "string" + }, + "categoryPattern": { + "description": "Gets or sets the matching pattern for category names. If not set, it matches any category.\r\nThere are 3 kind of patterns supported:\r\n 1. \"*\", it to matches any category name.\r\n 2. Combine multiple categories with \",\", for example \"connections,messages\", it matches category \"connections\" and \"messages\".\r\n 3. The single category name, for example, \"connections\", it matches the category \"connections\".", + "type": "string" + }, + "urlTemplate": { + "description": "Gets or sets the Upstream URL template. You can use 3 predefined parameters {hub}, {category} {event} inside the template, the value of the Upstream URL is dynamically calculated when the client request comes in.\r\nFor example, if the urlTemplate is `http://example.com/{hub}/api/{event}`, with a client request from hub `chat` connects, it will first POST to this URL: `http://example.com/chat/api/connect`.", + "type": "string" + }, + "auth": { + "$ref": "#/definitions/UpstreamAuthSettings" + } + } + }, + "UserAssignedIdentityProperty": { + "description": "Properties of user assigned identity.", + "type": "object", + "properties": { + "principalId": { + "description": "Get the principal id for the user assigned identity", + "type": "string", + "readOnly": true + }, + "clientId": { + "description": "Get the client id for the user assigned identity", + "type": "string", + "readOnly": true + } + } + } + }, + "parameters": { + "ResourceName": { + "in": "path", + "name": "resourceName", + "description": "The name of the resource.", + "required": true, + "maxLength": 63, + "minLength": 3, + "pattern": "^[a-zA-Z][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]$", + "type": "string", + "x-ms-parameter-location": "method" + }, + "ReplicaName": { + "in": "path", + "name": "replicaName", + "description": "The name of the replica.", + "required": true, + "maxLength": 63, + "minLength": 3, + "pattern": "^[a-zA-Z][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]$", + "type": "string", + "x-ms-parameter-location": "method" + }, + "SharedPrivateLinkResourceName": { + "in": "path", + "name": "sharedPrivateLinkResourceName", + "description": "The name of the shared private link resource.", + "required": true, + "maxLength": 63, + "minLength": 3, + "pattern": "^[a-zA-Z][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]$", + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "description": "Azure Active Directory OAuth2 Flow" + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "host": "management.azure.com", + "schemes": [ + "https" + ], + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] +} diff --git a/specification/signalr/resource-manager/readme.go.md b/specification/signalr/resource-manager/readme.go.md index eae1c7ab3ec9..362887972f7e 100644 --- a/specification/signalr/resource-manager/readme.go.md +++ b/specification/signalr/resource-manager/readme.go.md @@ -46,6 +46,7 @@ batch: - tag: package-2024-03-01 - tag: package-2024-04-01-preview - tag: package-2024-08-01-preview + - tag: package-2024-10-01-preview ``` ### Tag: package-2018-03-01-preview and go @@ -208,4 +209,13 @@ Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2024-10-01-preview' && $(go) +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2024-10-01-preview/$(namespace) ``` \ No newline at end of file diff --git a/specification/signalr/resource-manager/readme.java.md b/specification/signalr/resource-manager/readme.java.md index 9cb6bffee2f3..9ac0ad5814b6 100644 --- a/specification/signalr/resource-manager/readme.java.md +++ b/specification/signalr/resource-manager/readme.java.md @@ -34,6 +34,20 @@ batch: - tag: package-2024-03-01 - tag: package-2024-04-01-preview - tag: package-2024-08-01-preview + - tag: package-2024-10-01-preview +``` + +### Tag: package-2024-10-01-preview and java + +These settings apply only when `--tag=package-2024-10-01-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2024-10-01-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.signalr.v2024_10_01_preview + output-folder: $(azure-libraries-for-java-folder)/sdk/signalr/mgmt-v2024_10_01_preview +regenerate-manager: true +generate-interface: true ``` ### Tag: package-2024-08-01-preview and java diff --git a/specification/signalr/resource-manager/readme.md b/specification/signalr/resource-manager/readme.md index 2d763550c5d2..07e0f6f45442 100644 --- a/specification/signalr/resource-manager/readme.md +++ b/specification/signalr/resource-manager/readme.md @@ -26,7 +26,7 @@ These are the global settings for the SignalR API. ``` yaml openapi-type: arm -tag: package-2024-08-01-preview +tag: package-2024-10-01-preview ``` ### Suppression @@ -71,6 +71,15 @@ directive: reason: It can introduce a breaking change when updating parameter order, since SignalR service has already shipped public versions. ``` +### Tag: package-2024-10-01-preview + +These settings apply only when `--tag=package-2024-10-01-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2024-10-01-preview' +input-file: +- Microsoft.SignalRService/preview/2024-10-01-preview/signalr.json +``` + ### Tag: package-2024-08-01-preview These settings apply only when `--tag=package-2024-08-01-preview` is specified on the command line. diff --git a/specification/signalr/resource-manager/readme.ruby.md b/specification/signalr/resource-manager/readme.ruby.md index 1b652377bbab..ab9da2bd7b50 100644 --- a/specification/signalr/resource-manager/readme.ruby.md +++ b/specification/signalr/resource-manager/readme.ruby.md @@ -30,8 +30,18 @@ batch: - tag: package-2024-03-01 - tag: package-2024-04-01-preview - tag: package-2024-08-01-preview + - tag: package-2024-10-01-preview ``` +### Tag: package-2024-10-01-preview and ruby + +These settings apply only when `--tag=package-2024-10-01-preview --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2024-10-01-preview' && $(ruby) +namespace: "Azure::Signalr::Mgmt::V2024_10_01_preview" +output-f + ### Tag: package-2024-08-01-preview and ruby These settings apply only when `--tag=package-2024-08-01-preview --ruby` is specified on the command line. diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/Operations_List.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/Operations_List.json new file mode 100644 index 000000000000..8faf6e6b9856 --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/Operations_List.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview" + }, + "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}" + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/Usages_List.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/Usages_List.json new file mode 100644 index 000000000000..2d7976abe06e --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/Usages_List.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "location": "eastus", + "api-version": "2024-10-01-preview", + "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..." + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubCustomCertificates_CreateOrUpdate.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubCustomCertificates_CreateOrUpdate.json new file mode 100644 index 000000000000..2e9f872c6ca9 --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubCustomCertificates_CreateOrUpdate.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "parameters": { + "properties": { + "keyVaultBaseUri": "https://myvault.keyvault.azure.net/", + "keyVaultSecretName": "mycert", + "keyVaultSecretVersion": "bb6a44b2743f47f68dad0d6cc9756432" + } + }, + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService", + "certificateName": "myCert" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "keyVaultBaseUri": "https://myvault.keyvault.azure.net/", + "keyVaultSecretName": "mycert", + "keyVaultSecretVersion": "bb6a44b2743f47f68dad0d6cc9756432" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/customCertificates/myCert", + "name": "myCert", + "type": "Microsoft.SignalRService/WebPubSub/customCertificates" + } + }, + "201": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "keyVaultBaseUri": "https://myvault.keyvault.azure.net/", + "keyVaultSecretName": "mycert", + "keyVaultSecretVersion": "bb6a44b2743f47f68dad0d6cc9756432" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/customCertificates/myCert", + "name": "myCert", + "type": "Microsoft.SignalRService/WebPubSub/customCertificates" + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubCustomCertificates_Delete.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubCustomCertificates_Delete.json new file mode 100644 index 000000000000..4a529e9271fb --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubCustomCertificates_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService", + "certificateName": "myCert" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubCustomCertificates_Get.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubCustomCertificates_Get.json new file mode 100644 index 000000000000..fb39773b6e1c --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubCustomCertificates_Get.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService", + "certificateName": "myCert" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "keyVaultBaseUri": "https://myvault.keyvault.azure.net/", + "keyVaultSecretName": "mycert", + "keyVaultSecretVersion": "bb6a44b2743f47f68dad0d6cc9756432" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/customCertificates/myCert", + "name": "myCert", + "type": "Microsoft.SignalRService/WebPubSub/customCertificates" + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubCustomCertificates_List.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubCustomCertificates_List.json new file mode 100644 index 000000000000..46127c5fd572 --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubCustomCertificates_List.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService", + "certificateName": "myCert" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "keyVaultBaseUri": "https://myvault.keyvault.azure.net/", + "keyVaultSecretName": "mycert", + "keyVaultSecretVersion": "bb6a44b2743f47f68dad0d6cc9756432" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/customCertificates/myCert", + "name": "myCert", + "type": "Microsoft.SignalRService/WebPubSub/customCertificates" + } + ] + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubCustomDomains_CreateOrUpdate.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubCustomDomains_CreateOrUpdate.json new file mode 100644 index 000000000000..532cb5b1376b --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubCustomDomains_CreateOrUpdate.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "parameters": { + "properties": { + "domainName": "example.com", + "customCertificate": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/customCertificates/myCert" + } + } + }, + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService", + "name": "myDomain" + }, + "responses": { + "201": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "domainName": "example.com", + "customCertificate": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/customCertificates/myCert" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/customDomains/myDomain", + "name": "myDomain" + }, + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult..." + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubCustomDomains_Delete.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubCustomDomains_Delete.json new file mode 100644 index 000000000000..5533b7489171 --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubCustomDomains_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService", + "name": "example" + }, + "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/...pathToOperationResult..." + } + }, + "204": {} + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubCustomDomains_Get.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubCustomDomains_Get.json new file mode 100644 index 000000000000..1f03981fa910 --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubCustomDomains_Get.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService", + "name": "example" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "domainName": "example.com", + "customCertificate": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/customCertificates/myCert" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/customDomains/myDomain", + "name": "myDomain" + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubCustomDomains_List.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubCustomDomains_List.json new file mode 100644 index 000000000000..a980cb3b7044 --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubCustomDomains_List.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService", + "name": "myDomain" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "domainName": "example.com", + "customCertificate": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/customCertificates/myCert" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/customDomains/myDomain", + "name": "myDomain" + } + ] + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubHubs_CreateOrUpdate.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubHubs_CreateOrUpdate.json new file mode 100644 index 000000000000..467ee6775e07 --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubHubs_CreateOrUpdate.json @@ -0,0 +1,142 @@ +{ + "parameters": { + "parameters": { + "properties": { + "eventHandlers": [ + { + "urlTemplate": "http://host.com", + "userEventPattern": "*", + "systemEvents": [ + "connect", + "connected" + ], + "auth": { + "type": "ManagedIdentity", + "managedIdentity": { + "resource": "abc" + } + } + } + ], + "eventListeners": [ + { + "filter": { + "type": "EventName", + "systemEvents": [ + "connected", + "disconnected" + ], + "userEventPattern": "*" + }, + "endpoint": { + "type": "EventHub", + "fullyQualifiedNamespace": "example.servicebus.windows.net", + "eventHubName": "eventHubName1" + } + } + ], + "anonymousConnectPolicy": "allow", + "webSocketKeepAliveIntervalInSeconds": 50 + } + }, + "api-version": "2024-10-01-preview", + "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" + } + } + } + ], + "eventListeners": [ + { + "filter": { + "type": "EventName", + "systemEvents": [ + "connected", + "disconnected" + ], + "userEventPattern": "*" + }, + "endpoint": { + "type": "EventHub", + "fullyQualifiedNamespace": "example.servicebus.windows.net", + "eventHubName": "eventHubName1" + } + } + ], + "anonymousConnectPolicy": "allow", + "webSocketKeepAliveIntervalInSeconds": 50 + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/hubs/exampleHub", + "name": "exampleHub", + "type": "Microsoft.SignalRService/WebPubSub/hubs" + } + }, + "201": { + "body": { + "properties": { + "eventHandlers": [ + { + "urlTemplate": "http://host.com", + "userEventPattern": "*", + "systemEvents": [ + "connect", + "connected" + ], + "auth": { + "type": "ManagedIdentity", + "managedIdentity": { + "resource": "abc" + } + } + } + ], + "eventListeners": [ + { + "filter": { + "type": "EventName", + "systemEvents": [ + "connected", + "disconnected" + ], + "userEventPattern": "*" + }, + "endpoint": { + "type": "EventHub", + "fullyQualifiedNamespace": "example.servicebus.windows.net", + "eventHubName": "eventHubName1" + } + } + ], + "anonymousConnectPolicy": "allow", + "webSocketKeepAliveIntervalInSeconds": 50 + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/hubs/exampleHub", + "name": "exampleHub", + "type": "Microsoft.SignalRService/WebPubSub/hubs" + }, + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult..." + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubHubs_Delete.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubHubs_Delete.json new file mode 100644 index 000000000000..2c0281fafb65 --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubHubs_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "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/...pathToOperationResult..." + } + }, + "204": {} + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubHubs_Get.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubHubs_Get.json new file mode 100644 index 000000000000..66419e2fe24d --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubHubs_Get.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "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" + } + } + } + ], + "eventListeners": [ + { + "filter": { + "type": "EventName", + "systemEvents": [ + "connected", + "disconnected" + ], + "userEventPattern": "*" + }, + "endpoint": { + "type": "EventHub", + "fullyQualifiedNamespace": "example.servicebus.windows.net", + "eventHubName": "eventHubName1" + } + } + ], + "anonymousConnectPolicy": "allow", + "webSocketKeepAliveIntervalInSeconds": 50 + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/hubs/exampleHub", + "name": "exampleHub", + "type": "Microsoft.SignalRService/WebPubSub/hubs" + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubHubs_List.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubHubs_List.json new file mode 100644 index 000000000000..8a0a1af80313 --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubHubs_List.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "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" + } + } + } + ], + "eventListeners": [ + { + "filter": { + "type": "EventName", + "systemEvents": [ + "connected", + "disconnected" + ], + "userEventPattern": "*" + }, + "endpoint": { + "type": "EventHub", + "fullyQualifiedNamespace": "example.servicebus.windows.net", + "eventHubName": "eventHubName1" + } + } + ], + "anonymousConnectPolicy": "allow", + "webSocketKeepAliveIntervalInSeconds": 50 + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/hubs/exampleHub", + "name": "exampleHub", + "type": "Microsoft.SignalRService/WebPubSub/hubs" + } + ] + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubPrivateEndpointConnections_Delete.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubPrivateEndpointConnections_Delete.json new file mode 100644 index 000000000000..a0ec6dc4f496 --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubPrivateEndpointConnections_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "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/...pathToOperationResult..." + } + }, + "204": {} + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubPrivateEndpointConnections_Get.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubPrivateEndpointConnections_Get.json new file mode 100644 index 000000000000..c50340fac693 --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubPrivateEndpointConnections_Get.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService", + "privateEndpointConnectionName": "mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e" + }, + "responses": { + "200": { + "body": { + "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", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubPrivateEndpointConnections_List.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubPrivateEndpointConnections_List.json new file mode 100644 index 000000000000..8f1cd66969ef --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubPrivateEndpointConnections_List.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "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", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + } + ] + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubPrivateEndpointConnections_Update.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubPrivateEndpointConnections_Update.json new file mode 100644 index 000000000000..7648930360e8 --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubPrivateEndpointConnections_Update.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "parameters": { + "properties": { + "privateEndpoint": {}, + "privateLinkServiceConnectionState": { + "status": "Approved", + "actionsRequired": "None" + } + } + }, + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService", + "privateEndpointConnectionName": "mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e" + }, + "responses": { + "200": { + "body": { + "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", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + }, + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult..." + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubPrivateLinkResources_List.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubPrivateLinkResources_List.json new file mode 100644 index 000000000000..2781e9114ab7 --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubPrivateLinkResources_List.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "groupId": "webpubsub", + "requiredMembers": [ + "webpubsub" + ], + "requiredZoneNames": [ + "privatelink.webpubsub.azure.com" + ], + "shareablePrivateLinkResourceTypes": [ + { + "name": "site", + "properties": { + "description": "Azure App Service can be used as an upstream", + "groupId": "sites", + "type": "Microsoft.Web/sites" + } + }, + { + "name": "vault", + "properties": { + "description": "Azure Key Vault can be used as credentials store", + "groupId": "vault", + "type": "Microsoft.KeyVault/vaults" + } + }, + { + "name": "table", + "properties": { + "description": "Azure Storage Table can be used as message store", + "groupId": "table", + "type": "Microsoft.Storage/storageAccounts" + } + } + ] + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/privateLinkResources/myPrivateLink", + "name": "myPrivateLink", + "type": "privateLinkResources" + } + ], + "nextLink": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToMoreResults..." + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubReplicaSharedPrivateLinkResources_CreateOrUpdate.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubReplicaSharedPrivateLinkResources_CreateOrUpdate.json new file mode 100644 index 000000000000..e23c1ac382f8 --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubReplicaSharedPrivateLinkResources_CreateOrUpdate.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "parameters": { + "properties": { + "groupId": "sites", + "privateLinkResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Web/sites/myWebApp", + "requestMessage": "Please approve" + } + }, + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService", + "replicaName": "myWebPubSubService-eastus", + "sharedPrivateLinkResourceName": "upstream" + }, + "responses": { + "200": { + "body": { + "properties": { + "groupId": "sites", + "privateLinkResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Web/sites/myWebApp", + "provisioningState": "Succeeded", + "requestMessage": "Please approve", + "status": "Approved" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/privateEndpointConnections/upstream", + "name": "upstream", + "type": "Microsoft.SignalRService/WebPubSub/privateEndpointConnections" + } + }, + "201": { + "body": { + "properties": { + "groupId": "sites", + "privateLinkResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Web/sites/myWebApp", + "provisioningState": "Succeeded", + "requestMessage": "Please approve", + "status": "Approved" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/privateEndpointConnections/upstream", + "name": "upstream", + "type": "Microsoft.SignalRService/WebPubSub/privateEndpointConnections" + }, + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult..." + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubReplicaSharedPrivateLinkResources_Get.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubReplicaSharedPrivateLinkResources_Get.json new file mode 100644 index 000000000000..e6f68e02af1f --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubReplicaSharedPrivateLinkResources_Get.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService", + "replicaName": "myWebPubSubService-eastus", + "sharedPrivateLinkResourceName": "upstream" + }, + "responses": { + "200": { + "body": { + "properties": { + "groupId": "sites", + "privateLinkResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Web/sites/myWebApp", + "provisioningState": "Succeeded", + "requestMessage": "Please approve", + "status": "Approved" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/privateEndpointConnections/upstream", + "name": "upstream", + "type": "Microsoft.SignalRService/WebPubSub/privateEndpointConnections" + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubReplicaSharedPrivateLinkResources_List.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubReplicaSharedPrivateLinkResources_List.json new file mode 100644 index 000000000000..3bc33bdeb1f7 --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubReplicaSharedPrivateLinkResources_List.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService", + "replicaName": "myWebPubSubService-eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "groupId": "sites", + "privateLinkResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Web/sites/myWebApp", + "provisioningState": "Succeeded", + "requestMessage": "Please approve", + "status": "Approved" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/privateEndpointConnections/upstream", + "name": "upstream", + "type": "Microsoft.SignalRService/WebPubSub/privateEndpointConnections" + } + ] + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubReplicas_CreateOrUpdate.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubReplicas_CreateOrUpdate.json new file mode 100644 index 000000000000..9bfc4d36b683 --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubReplicas_CreateOrUpdate.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "parameters": { + "sku": { + "name": "Premium_P1", + "tier": "Premium", + "capacity": 1 + }, + "properties": { + "resourceStopped": "false" + }, + "location": "eastus", + "tags": { + "key1": "value1" + } + }, + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService", + "replicaName": "myWebPubSubService-eastus" + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Premium_P1", + "tier": "Premium", + "size": "P1", + "capacity": 1 + }, + "properties": { + "provisioningState": "Succeeded", + "regionEndpointEnabled": "Enabled", + "resourceStopped": "false" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/replicas/myWebPubSubService-eastus", + "name": "myWebPubSubService-eastus", + "type": "Microsoft.SignalRService/WebPubSub", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + } + }, + "201": { + "body": { + "sku": { + "name": "Premium_P1", + "tier": "Premium", + "size": "P1", + "capacity": 1 + }, + "properties": { + "provisioningState": "Succeeded", + "regionEndpointEnabled": "Enabled", + "resourceStopped": "false" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/replicas/myWebPubSubService-eastus", + "name": "myWebPubSubService-eastus", + "type": "Microsoft.SignalRService/WebPubSub", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + }, + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult..." + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubReplicas_Delete.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubReplicas_Delete.json new file mode 100644 index 000000000000..b0095b5af63f --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubReplicas_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService", + "replicaName": "myWebPubSubService-eastus" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubReplicas_Get.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubReplicas_Get.json new file mode 100644 index 000000000000..9523f0418353 --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubReplicas_Get.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService", + "replicaName": "myWebPubSubService-eastus" + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Premium_P1", + "tier": "Premium", + "size": "P1", + "capacity": 1 + }, + "properties": { + "provisioningState": "Succeeded", + "regionEndpointEnabled": "Enabled", + "resourceStopped": "false" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/replicas/myWebPubSubService-eastus", + "name": "myWebPubSubService-eastus", + "type": "Microsoft.SignalRService/WebPubSub", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubReplicas_List.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubReplicas_List.json new file mode 100644 index 000000000000..dc47a5b0595a --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubReplicas_List.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "sku": { + "name": "Premium_P1", + "tier": "Premium", + "size": "P1", + "capacity": 1 + }, + "properties": { + "provisioningState": "Succeeded", + "regionEndpointEnabled": "Enabled", + "resourceStopped": "false" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/replicas/myWebPubSubService-eastus", + "name": "myWebPubSubService-eastus", + "type": "Microsoft.SignalRService/WebPubSub", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + } + ] + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubReplicas_Restart.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubReplicas_Restart.json new file mode 100644 index 000000000000..d94530d4e741 --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubReplicas_Restart.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService", + "replicaName": "myWebPubSubService-eastus" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult..." + } + }, + "204": {} + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubReplicas_Update.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubReplicas_Update.json new file mode 100644 index 000000000000..bf6efd074cc7 --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubReplicas_Update.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "parameters": { + "sku": { + "name": "Premium_P1", + "tier": "Premium", + "capacity": 1 + }, + "properties": { + "resourceStopped": "false" + }, + "location": "eastus", + "tags": { + "key1": "value1" + } + }, + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService", + "replicaName": "myWebPubSubService-eastus" + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Premium_P1", + "tier": "Premium", + "size": "P1", + "capacity": 1 + }, + "properties": { + "provisioningState": "Succeeded", + "regionEndpointEnabled": "Enabled", + "resourceStopped": "false" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/replicas/myWebPubSubService-eastus", + "name": "myWebPubSubService-eastus", + "type": "Microsoft.SignalRService/WebPubSub", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + } + }, + "202": { + "body": { + "sku": { + "name": "Premium_P1", + "tier": "Premium", + "size": "P1", + "capacity": 1 + }, + "properties": { + "provisioningState": "Succeeded", + "regionEndpointEnabled": "Enabled", + "resourceStopped": "false" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/replicas/myWebPubSubService-eastus", + "name": "myWebPubSubService-eastus", + "type": "Microsoft.SignalRService/WebPubSub", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + }, + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult..." + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubSharedPrivateLinkResources_CreateOrUpdate.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubSharedPrivateLinkResources_CreateOrUpdate.json new file mode 100644 index 000000000000..7295ccc47dcf --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubSharedPrivateLinkResources_CreateOrUpdate.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "parameters": { + "properties": { + "groupId": "sites", + "privateLinkResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Web/sites/myWebApp", + "requestMessage": "Please approve" + } + }, + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService", + "sharedPrivateLinkResourceName": "upstream" + }, + "responses": { + "200": { + "body": { + "properties": { + "groupId": "sites", + "privateLinkResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Web/sites/myWebApp", + "provisioningState": "Succeeded", + "requestMessage": "Please approve", + "status": "Approved" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/privateEndpointConnections/upstream", + "name": "upstream", + "type": "Microsoft.SignalRService/WebPubSub/privateEndpointConnections" + } + }, + "201": { + "body": { + "properties": { + "groupId": "sites", + "privateLinkResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Web/sites/myWebApp", + "provisioningState": "Succeeded", + "requestMessage": "Please approve", + "status": "Approved" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/privateEndpointConnections/upstream", + "name": "upstream", + "type": "Microsoft.SignalRService/WebPubSub/privateEndpointConnections" + }, + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult..." + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubSharedPrivateLinkResources_Delete.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubSharedPrivateLinkResources_Delete.json new file mode 100644 index 000000000000..d08d3d17514f --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubSharedPrivateLinkResources_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService", + "sharedPrivateLinkResourceName": "upstream" + }, + "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/...pathToOperationResult..." + } + }, + "204": {} + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubSharedPrivateLinkResources_Get.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubSharedPrivateLinkResources_Get.json new file mode 100644 index 000000000000..bf8b6350c011 --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubSharedPrivateLinkResources_Get.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService", + "sharedPrivateLinkResourceName": "upstream" + }, + "responses": { + "200": { + "body": { + "properties": { + "groupId": "sites", + "privateLinkResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Web/sites/myWebApp", + "provisioningState": "Succeeded", + "requestMessage": "Please approve", + "status": "Approved" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/privateEndpointConnections/upstream", + "name": "upstream", + "type": "Microsoft.SignalRService/WebPubSub/privateEndpointConnections" + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubSharedPrivateLinkResources_List.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubSharedPrivateLinkResources_List.json new file mode 100644 index 000000000000..8caf692d540d --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSubSharedPrivateLinkResources_List.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "groupId": "sites", + "privateLinkResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Web/sites/myWebApp", + "provisioningState": "Succeeded", + "requestMessage": "Please approve", + "status": "Approved" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/privateEndpointConnections/upstream", + "name": "upstream", + "type": "Microsoft.SignalRService/WebPubSub/privateEndpointConnections" + } + ] + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSub_CheckNameAvailability.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSub_CheckNameAvailability.json new file mode 100644 index 000000000000..384b0afb43d5 --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSub_CheckNameAvailability.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "location": "eastus", + "parameters": { + "type": "Microsoft.SignalRService/WebPubSub", + "name": "myWebPubSubService" + }, + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "nameAvailable": false, + "reason": "AlreadyExists", + "message": "The name is already taken. Please try a different name." + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSub_CreateOrUpdate.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSub_CreateOrUpdate.json new file mode 100644 index 000000000000..fa065ab62cd5 --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSub_CreateOrUpdate.json @@ -0,0 +1,385 @@ +{ + "parameters": { + "parameters": { + "sku": { + "name": "Premium_P1", + "tier": "Premium", + "capacity": 1 + }, + "properties": { + "tls": { + "clientCertEnabled": false + }, + "liveTraceConfiguration": { + "enabled": "false", + "categories": [ + { + "name": "ConnectivityLogs", + "enabled": "true" + } + ] + }, + "networkACLs": { + "defaultAction": "Deny", + "publicNetwork": { + "allow": [ + "ClientConnection" + ] + }, + "privateEndpoints": [ + { + "name": "mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "allow": [ + "ServerConnection" + ] + } + ] + }, + "publicNetworkAccess": "Enabled", + "disableLocalAuth": false, + "disableAadAuth": false, + "socketIO": { + "serviceMode": "Serverless" + } + }, + "kind": "WebPubSub", + "identity": { + "type": "SystemAssigned" + }, + "location": "eastus", + "tags": { + "key1": "value1" + } + }, + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService" + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Premium_P1", + "tier": "Premium", + "size": "P1", + "capacity": 1 + }, + "properties": { + "provisioningState": "Succeeded", + "externalIP": "10.0.0.1", + "hostName": "mywebpubsubservice.webpubsub.azure.com", + "publicPort": 443, + "serverPort": 443, + "version": "1.0", + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "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", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + } + ], + "tls": { + "clientCertEnabled": true + }, + "liveTraceConfiguration": { + "enabled": "false", + "categories": [ + { + "name": "ConnectivityLogs", + "enabled": "true" + } + ] + }, + "resourceLogConfiguration": { + "categories": [ + { + "name": "ConnectivityLogs", + "enabled": "true" + } + ] + }, + "networkACLs": { + "defaultAction": "Deny", + "publicNetwork": { + "allow": [ + "ClientConnection" + ] + }, + "privateEndpoints": [ + { + "name": "mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "allow": [ + "ServerConnection" + ] + } + ], + "ipRules": [ + { + "value": "123.456.789.123/24", + "action": "Allow" + }, + { + "value": "123.456.789.123", + "action": "Allow" + }, + { + "value": "AppService", + "action": "Allow" + } + ] + }, + "applicationFirewall": { + "clientConnectionCountRules": [ + { + "type": "ThrottleByJwtSignatureRule", + "maxCount": 20 + }, + { + "type": "ThrottleByUserIdRule", + "maxCount": 20 + }, + { + "type": "ThrottleByJwtCustomClaimRule", + "claimName": "claimName", + "maxCount": 20 + } + ], + "clientTrafficControlRules": [ + { + "type": "TrafficThrottleByJwtSignatureRule", + "maxInboundMessageBytes": 1073741824, + "aggregationWindowInSeconds": 60 + }, + { + "type": "TrafficThrottleByUserIdRule", + "maxInboundMessageBytes": 1073741824, + "aggregationWindowInSeconds": 60 + }, + { + "type": "TrafficThrottleByJwtCustomClaimRule", + "claimName": "claimName", + "maxInboundMessageBytes": 1073741824, + "aggregationWindowInSeconds": 60 + } + ] + }, + "publicNetworkAccess": "Enabled", + "disableLocalAuth": false, + "disableAadAuth": false, + "regionEndpointEnabled": "Enabled", + "resourceStopped": "false", + "socketIO": { + "serviceMode": "Serverless" + } + }, + "kind": "WebPubSub", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService", + "name": "myWebPubSubService", + "type": "Microsoft.SignalRService/WebPubSub", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + } + }, + "201": { + "body": { + "sku": { + "name": "Premium_P1", + "tier": "Premium", + "size": "P1", + "capacity": 1 + }, + "properties": { + "provisioningState": "Succeeded", + "externalIP": "10.0.0.1", + "hostName": "mywebpubsubservice.webpubsub.azure.com", + "publicPort": 443, + "serverPort": 443, + "version": "1.0", + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "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", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + } + ], + "tls": { + "clientCertEnabled": true + }, + "liveTraceConfiguration": { + "enabled": "false", + "categories": [ + { + "name": "ConnectivityLogs", + "enabled": "true" + } + ] + }, + "resourceLogConfiguration": { + "categories": [ + { + "name": "ConnectivityLogs", + "enabled": "true" + } + ] + }, + "networkACLs": { + "defaultAction": "Deny", + "publicNetwork": { + "allow": [ + "ClientConnection" + ] + }, + "privateEndpoints": [ + { + "name": "mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "allow": [ + "ServerConnection" + ] + } + ], + "ipRules": [ + { + "value": "123.456.789.123/24", + "action": "Allow" + }, + { + "value": "123.456.789.123", + "action": "Allow" + }, + { + "value": "AppService", + "action": "Allow" + } + ] + }, + "applicationFirewall": { + "clientConnectionCountRules": [ + { + "type": "ThrottleByJwtSignatureRule", + "maxCount": 20 + }, + { + "type": "ThrottleByUserIdRule", + "maxCount": 20 + }, + { + "type": "ThrottleByJwtCustomClaimRule", + "claimName": "claimName", + "maxCount": 20 + } + ], + "clientTrafficControlRules": [ + { + "type": "TrafficThrottleByJwtSignatureRule", + "maxInboundMessageBytes": 1073741824, + "aggregationWindowInSeconds": 60 + }, + { + "type": "TrafficThrottleByUserIdRule", + "maxInboundMessageBytes": 1073741824, + "aggregationWindowInSeconds": 60 + }, + { + "type": "TrafficThrottleByJwtCustomClaimRule", + "claimName": "claimName", + "maxInboundMessageBytes": 1073741824, + "aggregationWindowInSeconds": 60 + } + ] + }, + "publicNetworkAccess": "Enabled", + "disableLocalAuth": false, + "disableAadAuth": false, + "regionEndpointEnabled": "Enabled", + "resourceStopped": "false", + "socketIO": { + "serviceMode": "Serverless" + } + }, + "kind": "WebPubSub", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService", + "name": "myWebPubSubService", + "type": "Microsoft.SignalRService/WebPubSub", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + }, + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult..." + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult..." + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSub_Delete.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSub_Delete.json new file mode 100644 index 000000000000..ad10fdab208d --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSub_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService" + }, + "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/...pathToOperationResult..." + } + }, + "204": {} + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSub_Get.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSub_Get.json new file mode 100644 index 000000000000..5a8a9ee66101 --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSub_Get.json @@ -0,0 +1,167 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService" + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Premium_P1", + "tier": "Premium", + "size": "P1", + "capacity": 1 + }, + "properties": { + "provisioningState": "Succeeded", + "externalIP": "10.0.0.1", + "hostName": "mywebpubsubservice.webpubsub.azure.com", + "publicPort": 443, + "serverPort": 443, + "version": "1.0", + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "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", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + } + ], + "tls": { + "clientCertEnabled": true + }, + "liveTraceConfiguration": { + "enabled": "false", + "categories": [ + { + "name": "ConnectivityLogs", + "enabled": "true" + } + ] + }, + "resourceLogConfiguration": { + "categories": [ + { + "name": "ConnectivityLogs", + "enabled": "true" + } + ] + }, + "networkACLs": { + "defaultAction": "Deny", + "publicNetwork": { + "allow": [ + "ClientConnection" + ] + }, + "privateEndpoints": [ + { + "name": "mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "allow": [ + "ServerConnection" + ] + } + ], + "ipRules": [ + { + "value": "123.456.789.123/24", + "action": "Allow" + }, + { + "value": "123.456.789.123", + "action": "Allow" + }, + { + "value": "AppService", + "action": "Allow" + } + ] + }, + "applicationFirewall": { + "clientConnectionCountRules": [ + { + "type": "ThrottleByJwtSignatureRule", + "maxCount": 20 + }, + { + "type": "ThrottleByUserIdRule", + "maxCount": 20 + }, + { + "type": "ThrottleByJwtCustomClaimRule", + "claimName": "claimName", + "maxCount": 20 + } + ], + "clientTrafficControlRules": [ + { + "type": "TrafficThrottleByJwtSignatureRule", + "maxInboundMessageBytes": 1073741824, + "aggregationWindowInSeconds": 60 + }, + { + "type": "TrafficThrottleByUserIdRule", + "maxInboundMessageBytes": 1073741824, + "aggregationWindowInSeconds": 60 + }, + { + "type": "TrafficThrottleByJwtCustomClaimRule", + "claimName": "claimName", + "maxInboundMessageBytes": 1073741824, + "aggregationWindowInSeconds": 60 + } + ] + }, + "publicNetworkAccess": "Enabled", + "disableLocalAuth": false, + "disableAadAuth": false, + "regionEndpointEnabled": "Enabled", + "resourceStopped": "false", + "socketIO": { + "serviceMode": "Serverless" + } + }, + "kind": "WebPubSub", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService", + "name": "myWebPubSubService", + "type": "Microsoft.SignalRService/WebPubSub", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSub_ListByResourceGroup.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSub_ListByResourceGroup.json new file mode 100644 index 000000000000..d6ab32d20b71 --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSub_ListByResourceGroup.json @@ -0,0 +1,170 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "sku": { + "name": "Premium_P1", + "tier": "Premium", + "size": "P1", + "capacity": 1 + }, + "properties": { + "provisioningState": "Succeeded", + "externalIP": "10.0.0.1", + "hostName": "mywebpubsubservice.webpubsub.azure.com", + "publicPort": 443, + "serverPort": 443, + "version": "1.0", + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "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", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + } + ], + "tls": { + "clientCertEnabled": true + }, + "liveTraceConfiguration": { + "enabled": "false", + "categories": [ + { + "name": "ConnectivityLogs", + "enabled": "true" + } + ] + }, + "resourceLogConfiguration": { + "categories": [ + { + "name": "ConnectivityLogs", + "enabled": "true" + } + ] + }, + "networkACLs": { + "defaultAction": "Deny", + "publicNetwork": { + "allow": [ + "ClientConnection" + ] + }, + "privateEndpoints": [ + { + "name": "mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "allow": [ + "ServerConnection" + ] + } + ], + "ipRules": [ + { + "value": "123.456.789.123/24", + "action": "Allow" + }, + { + "value": "123.456.789.123", + "action": "Allow" + }, + { + "value": "AppService", + "action": "Allow" + } + ] + }, + "applicationFirewall": { + "clientConnectionCountRules": [ + { + "type": "ThrottleByJwtSignatureRule", + "maxCount": 20 + }, + { + "type": "ThrottleByUserIdRule", + "maxCount": 20 + }, + { + "type": "ThrottleByJwtCustomClaimRule", + "claimName": "claimName", + "maxCount": 20 + } + ], + "clientTrafficControlRules": [ + { + "type": "TrafficThrottleByJwtSignatureRule", + "maxInboundMessageBytes": 1073741824, + "aggregationWindowInSeconds": 60 + }, + { + "type": "TrafficThrottleByUserIdRule", + "maxInboundMessageBytes": 1073741824, + "aggregationWindowInSeconds": 60 + }, + { + "type": "TrafficThrottleByJwtCustomClaimRule", + "claimName": "claimName", + "maxInboundMessageBytes": 1073741824, + "aggregationWindowInSeconds": 60 + } + ] + }, + "publicNetworkAccess": "Enabled", + "disableLocalAuth": false, + "disableAadAuth": false, + "regionEndpointEnabled": "Enabled", + "resourceStopped": "false", + "socketIO": { + "serviceMode": "Serverless" + } + }, + "kind": "WebPubSub", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService", + "name": "myWebPubSubService", + "type": "Microsoft.SignalRService/WebPubSub", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + } + ] + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSub_ListBySubscription.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSub_ListBySubscription.json new file mode 100644 index 000000000000..2d9e5605ee74 --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSub_ListBySubscription.json @@ -0,0 +1,169 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "sku": { + "name": "Premium_P1", + "tier": "Premium", + "size": "P1", + "capacity": 1 + }, + "properties": { + "provisioningState": "Succeeded", + "externalIP": "10.0.0.1", + "hostName": "mywebpubsubservice.webpubsub.azure.com", + "publicPort": 443, + "serverPort": 443, + "version": "1.0", + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "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", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + } + ], + "tls": { + "clientCertEnabled": true + }, + "liveTraceConfiguration": { + "enabled": "false", + "categories": [ + { + "name": "ConnectivityLogs", + "enabled": "true" + } + ] + }, + "resourceLogConfiguration": { + "categories": [ + { + "name": "ConnectivityLogs", + "enabled": "true" + } + ] + }, + "networkACLs": { + "defaultAction": "Deny", + "publicNetwork": { + "allow": [ + "ClientConnection" + ] + }, + "privateEndpoints": [ + { + "name": "mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "allow": [ + "ServerConnection" + ] + } + ], + "ipRules": [ + { + "value": "123.456.789.123/24", + "action": "Allow" + }, + { + "value": "123.456.789.123", + "action": "Allow" + }, + { + "value": "AppService", + "action": "Allow" + } + ] + }, + "applicationFirewall": { + "clientConnectionCountRules": [ + { + "type": "ThrottleByJwtSignatureRule", + "maxCount": 20 + }, + { + "type": "ThrottleByUserIdRule", + "maxCount": 20 + }, + { + "type": "ThrottleByJwtCustomClaimRule", + "claimName": "claimName", + "maxCount": 20 + } + ], + "clientTrafficControlRules": [ + { + "type": "TrafficThrottleByJwtSignatureRule", + "maxInboundMessageBytes": 1073741824, + "aggregationWindowInSeconds": 60 + }, + { + "type": "TrafficThrottleByUserIdRule", + "maxInboundMessageBytes": 1073741824, + "aggregationWindowInSeconds": 60 + }, + { + "type": "TrafficThrottleByJwtCustomClaimRule", + "claimName": "claimName", + "maxInboundMessageBytes": 1073741824, + "aggregationWindowInSeconds": 60 + } + ] + }, + "publicNetworkAccess": "Enabled", + "disableLocalAuth": false, + "disableAadAuth": false, + "regionEndpointEnabled": "Enabled", + "resourceStopped": "false", + "socketIO": { + "serviceMode": "Serverless" + } + }, + "kind": "WebPubSub", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService", + "name": "myWebPubSubService", + "type": "Microsoft.SignalRService/WebPubSub", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + } + ] + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSub_ListKeys.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSub_ListKeys.json new file mode 100644 index 000000000000..a9ea6856861f --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSub_ListKeys.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSub_ListReplicaSkus.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSub_ListReplicaSkus.json new file mode 100644 index 000000000000..f2a459e86daf --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSub_ListReplicaSkus.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService", + "replicaName": "myWebPubSubService-eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "Microsoft.SignalRService/WebPubSub/replicas", + "sku": { + "name": "Free_F1", + "tier": "Free" + }, + "capacity": { + "minimum": 0, + "maximum": 1, + "default": 1, + "allowedValues": [ + 1 + ], + "scaleType": "Manual" + } + }, + { + "resourceType": "Microsoft.SignalRService/WebPubSub/replicas", + "sku": { + "name": "Standard_S1", + "tier": "Standard" + }, + "capacity": { + "minimum": 0, + "maximum": 100, + "default": 1, + "allowedValues": [ + 1, + 2, + 3, + 4, + 5, + 6, + 7, + 8, + 9, + 10, + 20, + 30, + 40, + 50, + 60, + 70, + 80, + 90, + 100 + ], + "scaleType": "Manual" + } + }, + { + "resourceType": "Microsoft.SignalRService/WebPubSub/replicas", + "sku": { + "name": "Premium_P1", + "tier": "Standard" + }, + "capacity": { + "minimum": 0, + "maximum": 100, + "default": 1, + "allowedValues": [ + 1, + 2, + 3, + 4, + 5, + 6, + 7, + 8, + 9, + 10, + 20, + 30, + 40, + 50, + 60, + 70, + 80, + 90, + 100 + ], + "scaleType": "Automatic" + } + } + ] + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSub_ListSkus.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSub_ListSkus.json new file mode 100644 index 000000000000..9ea2c2a7230d --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSub_ListSkus.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "Microsoft.SignalRService/WebPubSub", + "sku": { + "name": "Free_F1", + "tier": "Free" + }, + "capacity": { + "minimum": 0, + "maximum": 1, + "default": 1, + "allowedValues": [ + 1 + ], + "scaleType": "Manual" + } + }, + { + "resourceType": "Microsoft.SignalRService/WebPubSub", + "sku": { + "name": "Standard_S1", + "tier": "Standard" + }, + "capacity": { + "minimum": 0, + "maximum": 100, + "default": 1, + "allowedValues": [ + 1, + 2, + 3, + 4, + 5, + 6, + 7, + 8, + 9, + 10, + 20, + 30, + 40, + 50, + 60, + 70, + 80, + 90, + 100 + ], + "scaleType": "Manual" + } + }, + { + "resourceType": "Microsoft.SignalRService/WebPubSub/replicas", + "sku": { + "name": "Premium_P1", + "tier": "Standard" + }, + "capacity": { + "minimum": 0, + "maximum": 100, + "default": 1, + "allowedValues": [ + 1, + 2, + 3, + 4, + 5, + 6, + 7, + 8, + 9, + 10, + 20, + 30, + 40, + 50, + 60, + 70, + 80, + 90, + 100 + ], + "scaleType": "Automatic" + } + } + ] + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSub_RegenerateKey.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSub_RegenerateKey.json new file mode 100644 index 000000000000..4edb4b1a0dd0 --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSub_RegenerateKey.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "parameters": { + "keyType": "Primary" + }, + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService" + }, + "responses": { + "200": { + "body": {} + }, + "202": { + "body": {}, + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult..." + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSub_Restart.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSub_Restart.json new file mode 100644 index 000000000000..4c47e42d796b --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSub_Restart.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult..." + } + }, + "204": {} + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSub_Update.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSub_Update.json new file mode 100644 index 000000000000..c3c7fb8979df --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/examples/WebPubSub_Update.json @@ -0,0 +1,224 @@ +{ + "parameters": { + "parameters": { + "sku": { + "name": "Premium_P1", + "tier": "Premium", + "capacity": 1 + }, + "properties": { + "tls": { + "clientCertEnabled": false + }, + "liveTraceConfiguration": { + "enabled": "false", + "categories": [ + { + "name": "ConnectivityLogs", + "enabled": "true" + } + ] + }, + "networkACLs": { + "defaultAction": "Deny", + "publicNetwork": { + "allow": [ + "ClientConnection" + ] + }, + "privateEndpoints": [ + { + "name": "mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "allow": [ + "ServerConnection" + ] + } + ] + }, + "publicNetworkAccess": "Enabled", + "disableLocalAuth": false, + "disableAadAuth": false, + "socketIO": { + "serviceMode": "Serverless" + } + }, + "kind": "WebPubSub", + "identity": { + "type": "SystemAssigned" + }, + "location": "eastus", + "tags": { + "key1": "value1" + } + }, + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService" + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Premium_P1", + "tier": "Premium", + "size": "P1", + "capacity": 1 + }, + "properties": { + "provisioningState": "Succeeded", + "externalIP": "10.0.0.1", + "hostName": "mywebpubsubservice.webpubsub.azure.com", + "publicPort": 443, + "serverPort": 443, + "version": "1.0", + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "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", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + } + ], + "tls": { + "clientCertEnabled": true + }, + "liveTraceConfiguration": { + "enabled": "false", + "categories": [ + { + "name": "ConnectivityLogs", + "enabled": "true" + } + ] + }, + "resourceLogConfiguration": { + "categories": [ + { + "name": "ConnectivityLogs", + "enabled": "true" + } + ] + }, + "networkACLs": { + "defaultAction": "Deny", + "publicNetwork": { + "allow": [ + "ClientConnection" + ] + }, + "privateEndpoints": [ + { + "name": "mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "allow": [ + "ServerConnection" + ] + } + ], + "ipRules": [ + { + "value": "123.456.789.123/24", + "action": "Allow" + }, + { + "value": "123.456.789.123", + "action": "Allow" + }, + { + "value": "AppService", + "action": "Allow" + } + ] + }, + "applicationFirewall": { + "clientConnectionCountRules": [ + { + "type": "ThrottleByJwtSignatureRule", + "maxCount": 20 + }, + { + "type": "ThrottleByUserIdRule", + "maxCount": 20 + }, + { + "type": "ThrottleByJwtCustomClaimRule", + "claimName": "claimName", + "maxCount": 20 + } + ], + "clientTrafficControlRules": [ + { + "type": "TrafficThrottleByJwtSignatureRule", + "maxInboundMessageBytes": 1073741824, + "aggregationWindowInSeconds": 60 + }, + { + "type": "TrafficThrottleByUserIdRule", + "maxInboundMessageBytes": 1073741824, + "aggregationWindowInSeconds": 60 + }, + { + "type": "TrafficThrottleByJwtCustomClaimRule", + "claimName": "claimName", + "maxInboundMessageBytes": 1073741824, + "aggregationWindowInSeconds": 60 + } + ] + }, + "publicNetworkAccess": "Enabled", + "disableLocalAuth": false, + "disableAadAuth": false, + "regionEndpointEnabled": "Enabled", + "resourceStopped": "false", + "socketIO": { + "serviceMode": "Serverless" + } + }, + "kind": "WebPubSub", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService", + "name": "myWebPubSubService", + "type": "Microsoft.SignalRService/WebPubSub", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult..." + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/webpubsub.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/webpubsub.json new file mode 100644 index 000000000000..7e9e3032e3e3 --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2024-10-01-preview/webpubsub.json @@ -0,0 +1,4249 @@ +{ + "swagger": "2.0", + "info": { + "title": "WebPubSubManagementClient", + "description": "REST API for Azure WebPubSub Service", + "version": "2024-10-01-preview" + }, + "paths": { + "/providers/Microsoft.SignalRService/operations": { + "get": { + "tags": [ + "WebPubSub" + ], + "description": "Lists all of the available REST API operations of the Microsoft.SignalRService provider.", + "operationId": "Operations_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of operations.", + "schema": { + "$ref": "#/definitions/OperationList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/Operations_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/locations/{location}/checkNameAvailability": { + "post": { + "tags": [ + "WebPubSub" + ], + "description": "Checks that the resource name is valid and is not already in use.", + "operationId": "WebPubSub_CheckNameAvailability", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "location", + "description": "The region", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "parameters", + "description": "Parameters supplied to the operation.", + "required": true, + "schema": { + "$ref": "#/definitions/NameAvailabilityParameters" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the name availability.", + "schema": { + "$ref": "#/definitions/NameAvailability" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebPubSub_CheckNameAvailability": { + "$ref": "./examples/WebPubSub_CheckNameAvailability.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/locations/{location}/usages": { + "get": { + "tags": [ + "WebPubSub" + ], + "description": "List resource usage quotas by location.", + "operationId": "Usages_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "location", + "description": "the location like \"eastus\"", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describe the usage quotas of a subscription in specified region.", + "schema": { + "$ref": "#/definitions/SignalRServiceUsageList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Usages_List": { + "$ref": "./examples/Usages_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/webPubSub": { + "get": { + "tags": [ + "WebPubSub" + ], + "description": "Handles requests to list all resources in a subscription.", + "operationId": "WebPubSub_ListBySubscription", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of resources in the subscription.", + "schema": { + "$ref": "#/definitions/WebPubSubResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "WebPubSub_ListBySubscription": { + "$ref": "./examples/WebPubSub_ListBySubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub": { + "get": { + "tags": [ + "WebPubSub" + ], + "description": "Handles requests to list all resources in a resource group.", + "operationId": "WebPubSub_ListByResourceGroup", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of resources in a resourceGroup.", + "schema": { + "$ref": "#/definitions/WebPubSubResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "WebPubSub_ListByResourceGroup": { + "$ref": "./examples/WebPubSub_ListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}": { + "get": { + "tags": [ + "WebPubSub" + ], + "description": "Get the resource and its properties.", + "operationId": "WebPubSub_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the corresponding resource.", + "schema": { + "$ref": "#/definitions/WebPubSubResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebPubSub_Get": { + "$ref": "./examples/WebPubSub_Get.json" + } + } + }, + "put": { + "tags": [ + "WebPubSub" + ], + "description": "Create or update a resource.", + "operationId": "WebPubSub_CreateOrUpdate", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "parameters", + "description": "Parameters for the create or update operation", + "required": true, + "schema": { + "$ref": "#/definitions/WebPubSubResource" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes a resource.", + "schema": { + "$ref": "#/definitions/WebPubSubResource" + } + }, + "201": { + "description": "Created. The response describes the new resource and contains a Location header to query the operation result.", + "schema": { + "$ref": "#/definitions/WebPubSubResource" + } + }, + "202": { + "description": "Accepted. The response indicates the exiting resource is now updating and contains a Location header to query the operation result.." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "WebPubSub_CreateOrUpdate": { + "$ref": "./examples/WebPubSub_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "WebPubSub" + ], + "description": "Operation to delete a resource.", + "operationId": "WebPubSub_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response indicates the resource is already deleted." + }, + "202": { + "description": "Accepted. The response indicates the delete operation is performed in the background." + }, + "204": { + "description": "Success. The response indicates the resource is already deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "WebPubSub_Delete": { + "$ref": "./examples/WebPubSub_Delete.json" + } + } + }, + "patch": { + "tags": [ + "WebPubSub" + ], + "description": "Operation to update an exiting resource.", + "operationId": "WebPubSub_Update", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "parameters", + "description": "Parameters for the update operation", + "required": true, + "schema": { + "$ref": "#/definitions/WebPubSubResource" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes a resource.", + "schema": { + "$ref": "#/definitions/WebPubSubResource" + } + }, + "202": { + "description": "Accepted. The response indicates the exiting resource is now updating and contains a Location header to query the operation result..", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "WebPubSub_Update": { + "$ref": "./examples/WebPubSub_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/customCertificates": { + "get": { + "tags": [ + "WebPubSub" + ], + "description": "List all custom certificates.", + "operationId": "WebPubSubCustomCertificates_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes custom certificates of the resource.", + "schema": { + "$ref": "#/definitions/CustomCertificateList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "WebPubSubCustomCertificates_List": { + "$ref": "./examples/WebPubSubCustomCertificates_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/customCertificates/{certificateName}": { + "get": { + "tags": [ + "WebPubSub" + ], + "description": "Get a custom certificate.", + "operationId": "WebPubSubCustomCertificates_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "in": "path", + "name": "certificateName", + "description": "Custom certificate name", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describe the corresponding custom certificate.", + "schema": { + "$ref": "#/definitions/CustomCertificate" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebPubSubCustomCertificates_Get": { + "$ref": "./examples/WebPubSubCustomCertificates_Get.json" + } + } + }, + "put": { + "tags": [ + "WebPubSub" + ], + "description": "Create or update a custom certificate.", + "operationId": "WebPubSubCustomCertificates_CreateOrUpdate", + "consumes": [ + "application/json", + "text/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "in": "path", + "name": "certificateName", + "description": "Custom certificate name", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "", + "required": true, + "schema": { + "$ref": "#/definitions/CustomCertificate" + } + } + ], + "responses": { + "200": { + "description": "Success. The response describes the certificate.", + "schema": { + "$ref": "#/definitions/CustomCertificate" + } + }, + "201": { + "description": "Created. The response describes the certificate.", + "schema": { + "$ref": "#/definitions/CustomCertificate" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "WebPubSubCustomCertificates_CreateOrUpdate": { + "$ref": "./examples/WebPubSubCustomCertificates_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "WebPubSub" + ], + "description": "Delete a custom certificate.", + "operationId": "WebPubSubCustomCertificates_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "in": "path", + "name": "certificateName", + "description": "Custom certificate name", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success." + }, + "204": { + "description": "No Content." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebPubSubCustomCertificates_Delete": { + "$ref": "./examples/WebPubSubCustomCertificates_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/customDomains": { + "get": { + "tags": [ + "WebPubSub" + ], + "description": "List all custom domains.", + "operationId": "WebPubSubCustomDomains_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes custom domains of the resource.", + "schema": { + "$ref": "#/definitions/CustomDomainList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "WebPubSubCustomDomains_List": { + "$ref": "./examples/WebPubSubCustomDomains_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/customDomains/{name}": { + "get": { + "tags": [ + "WebPubSub" + ], + "description": "Get a custom domain.", + "operationId": "WebPubSubCustomDomains_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "in": "path", + "name": "name", + "description": "Custom domain name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describe the corresponding custom domain.", + "schema": { + "$ref": "#/definitions/CustomDomain" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebPubSubCustomDomains_Get": { + "$ref": "./examples/WebPubSubCustomDomains_Get.json" + } + } + }, + "put": { + "tags": [ + "WebPubSub" + ], + "description": "Create or update a custom domain.", + "operationId": "WebPubSubCustomDomains_CreateOrUpdate", + "consumes": [ + "application/json", + "text/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "in": "path", + "name": "name", + "description": "Custom domain name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "", + "required": true, + "schema": { + "$ref": "#/definitions/CustomDomain" + } + } + ], + "responses": { + "201": { + "description": "Created. The response describes the custom domain and contains a Location header to query the operation result.", + "schema": { + "$ref": "#/definitions/CustomDomain" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "WebPubSubCustomDomains_CreateOrUpdate": { + "$ref": "./examples/WebPubSubCustomDomains_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "WebPubSub" + ], + "description": "Delete a custom domain.", + "operationId": "WebPubSubCustomDomains_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "in": "path", + "name": "name", + "description": "Custom domain name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response indicates the custom domain is deleted." + }, + "202": { + "description": "Accepted. The response indicates the operation is performed in the background." + }, + "204": { + "description": "Success. The response indicates the custom domain is deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "WebPubSubCustomDomains_Delete": { + "$ref": "./examples/WebPubSubCustomDomains_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/hubs": { + "get": { + "tags": [ + "WebPubSub" + ], + "description": "List hub settings.", + "operationId": "WebPubSubHubs_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes hub settings of the resource.", + "schema": { + "$ref": "#/definitions/WebPubSubHubList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "WebPubSubHubs_List": { + "$ref": "./examples/WebPubSubHubs_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/hubs/{hubName}": { + "get": { + "tags": [ + "WebPubSub" + ], + "description": "Get a hub setting.", + "operationId": "WebPubSubHubs_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "hubName", + "description": "The hub name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describe the corresponding hub setting.", + "schema": { + "$ref": "#/definitions/WebPubSubHub" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebPubSubHubs_Get": { + "$ref": "./examples/WebPubSubHubs_Get.json" + } + } + }, + "put": { + "tags": [ + "WebPubSub" + ], + "description": "Create or update a hub setting.", + "operationId": "WebPubSubHubs_CreateOrUpdate", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "hubName", + "description": "The hub name.", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "parameters", + "description": "The resource of WebPubSubHub and its properties", + "required": true, + "schema": { + "$ref": "#/definitions/WebPubSubHub" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "OK.The request makes no change. The response describes the existing hub setting.", + "schema": { + "$ref": "#/definitions/WebPubSubHub" + } + }, + "201": { + "description": "Created. The response describes the hub setting and contains a Location header to query the operation result.", + "schema": { + "$ref": "#/definitions/WebPubSubHub" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "WebPubSubHubs_CreateOrUpdate": { + "$ref": "./examples/WebPubSubHubs_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "WebPubSub" + ], + "description": "Delete a hub setting.", + "operationId": "WebPubSubHubs_Delete", + "parameters": [ + { + "in": "path", + "name": "hubName", + "description": "The hub name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "202": { + "description": "Accepted. The response indicates the delete operation is performed in the background." + }, + "204": { + "description": "Success. The response indicates the hub setting is already deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "WebPubSubHubs_Delete": { + "$ref": "./examples/WebPubSubHubs_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/listKeys": { + "post": { + "tags": [ + "WebPubSub" + ], + "description": "Get the access keys of the resource.", + "operationId": "WebPubSub_ListKeys", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes access keys of the resource.", + "schema": { + "$ref": "#/definitions/WebPubSubKeys" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebPubSub_ListKeys": { + "$ref": "./examples/WebPubSub_ListKeys.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/privateEndpointConnections": { + "get": { + "tags": [ + "WebPubSub" + ], + "description": "List private endpoint connections", + "operationId": "WebPubSubPrivateEndpointConnections_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes a list of private endpoint connections.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "WebPubSubPrivateEndpointConnections_List": { + "$ref": "./examples/WebPubSubPrivateEndpointConnections_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "WebPubSub" + ], + "description": "Get the specified private endpoint connection", + "operationId": "WebPubSubPrivateEndpointConnections_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/privatelinks.json#/parameters/PrivateEndpointConnectionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes a private endpoint connection.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebPubSubPrivateEndpointConnections_Get": { + "$ref": "./examples/WebPubSubPrivateEndpointConnections_Get.json" + } + } + }, + "put": { + "tags": [ + "WebPubSub" + ], + "description": "Update the state of specified private endpoint connection", + "operationId": "WebPubSubPrivateEndpointConnections_Update", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/privatelinks.json#/parameters/PrivateEndpointConnectionName" + }, + { + "in": "body", + "name": "parameters", + "description": "The resource of private endpoint and its properties", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "OK. The response indicates the private endpoint connection is updated successfully.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebPubSubPrivateEndpointConnections_Update": { + "$ref": "./examples/WebPubSubPrivateEndpointConnections_Update.json" + } + } + }, + "delete": { + "tags": [ + "WebPubSub" + ], + "description": "Delete the specified private endpoint connection", + "operationId": "WebPubSubPrivateEndpointConnections_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/privatelinks.json#/parameters/PrivateEndpointConnectionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response indicates the resource is already deleted." + }, + "202": { + "description": "Accepted. The response indicates the delete operation is performed in the background." + }, + "204": { + "description": "Success. The response indicates the private endpoint connection is already deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "WebPubSubPrivateEndpointConnections_Delete": { + "$ref": "./examples/WebPubSubPrivateEndpointConnections_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/privateLinkResources": { + "get": { + "tags": [ + "WebPubSub" + ], + "description": "Get the private link resources that need to be created for a resource.", + "operationId": "WebPubSubPrivateLinkResources_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes a list of private link resources.", + "schema": { + "$ref": "#/definitions/PrivateLinkResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "WebPubSubPrivateLinkResources_List": { + "$ref": "./examples/WebPubSubPrivateLinkResources_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/regenerateKey": { + "post": { + "tags": [ + "WebPubSub" + ], + "description": "Regenerate the access key for the resource. PrimaryKey and SecondaryKey cannot be regenerated at the same time.", + "operationId": "WebPubSub_RegenerateKey", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "parameters", + "description": "Parameter that describes the Regenerate Key Operation.", + "required": true, + "schema": { + "$ref": "#/definitions/RegenerateKeyParameters" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/WebPubSubKeys" + } + }, + "202": { + "description": "Accepted and an async operation is executing in background to make the new key to take effect. The response contains new access keys and a Location header to query the async operation result.", + "schema": { + "$ref": "#/definitions/WebPubSubKeys" + }, + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "WebPubSub_RegenerateKey": { + "$ref": "./examples/WebPubSub_RegenerateKey.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/replicas": { + "get": { + "tags": [ + "WebPubSub" + ], + "description": "List all replicas belong to this resource", + "operationId": "WebPubSubReplicas_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes replicas of the resource.", + "schema": { + "$ref": "#/definitions/ReplicaList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "WebPubSubReplicas_List": { + "$ref": "./examples/WebPubSubReplicas_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/replicas/{replicaName}": { + "get": { + "tags": [ + "WebPubSub" + ], + "description": "Get the replica and its properties.", + "operationId": "WebPubSubReplicas_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ReplicaName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the corresponding replica.", + "schema": { + "$ref": "#/definitions/Replica" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebPubSubReplicas_Get": { + "$ref": "./examples/WebPubSubReplicas_Get.json" + } + } + }, + "put": { + "tags": [ + "WebPubSub" + ], + "description": "Create or update a replica.", + "operationId": "WebPubSubReplicas_CreateOrUpdate", + "consumes": [ + "application/json", + "text/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ReplicaName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "Parameters for the create or update operation", + "required": true, + "schema": { + "$ref": "#/definitions/Replica" + } + } + ], + "responses": { + "200": { + "description": "Updated. The response describes a replica.", + "schema": { + "$ref": "#/definitions/Replica" + } + }, + "201": { + "description": "Created. The response describes the new replica and contains a Location header to query the operation result.", + "schema": { + "$ref": "#/definitions/Replica" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "WebPubSubReplicas_CreateOrUpdate": { + "$ref": "./examples/WebPubSubReplicas_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "WebPubSub" + ], + "description": "Operation to delete a replica.", + "operationId": "WebPubSubReplicas_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ReplicaName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response indicates the replica is deleted." + }, + "204": { + "description": "Success. The response indicates the replica is deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebPubSubReplicas_Delete": { + "$ref": "./examples/WebPubSubReplicas_Delete.json" + } + } + }, + "patch": { + "tags": [ + "WebPubSub" + ], + "description": "Operation to update an exiting replica.", + "operationId": "WebPubSubReplicas_Update", + "consumes": [ + "application/json", + "text/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ReplicaName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "Parameters for the update operation", + "required": true, + "schema": { + "$ref": "#/definitions/Replica" + } + } + ], + "responses": { + "200": { + "description": "Success. The response describes a replica.", + "schema": { + "$ref": "#/definitions/Replica" + } + }, + "202": { + "description": "Updated. The response describes the new replica and contains a Location header to query the operation result.", + "schema": { + "$ref": "#/definitions/Replica" + }, + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "WebPubSubReplicas_Update": { + "$ref": "./examples/WebPubSubReplicas_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/replicas/{replicaName}/restart": { + "post": { + "tags": [ + "WebPubSub" + ], + "description": "Operation to restart a replica.", + "operationId": "WebPubSubReplicas_Restart", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ReplicaName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted. The response indicates the restart operation is performed in the background.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Success. The response indicates the operation is successful and no content will be returned." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "WebPubSubReplicas_Restart": { + "$ref": "./examples/WebPubSubReplicas_Restart.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/replicas/{replicaName}/sharedPrivateLinkResources": { + "get": { + "tags": [ + "WebPubSub" + ], + "description": "List shared private link resources", + "operationId": "WebPubSubReplicaSharedPrivateLinkResources_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ReplicaName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes a list of shared private link resources.", + "schema": { + "$ref": "#/definitions/SharedPrivateLinkResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "WebPubSubReplicaSharedPrivateLinkResources_List": { + "$ref": "./examples/WebPubSubReplicaSharedPrivateLinkResources_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/replicas/{replicaName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}": { + "get": { + "tags": [ + "WebPubSub" + ], + "description": "Get the specified shared private link resource", + "operationId": "WebPubSubReplicaSharedPrivateLinkResources_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ReplicaName" + }, + { + "$ref": "#/parameters/SharedPrivateLinkResourceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes a shared private link resource.", + "schema": { + "$ref": "#/definitions/SharedPrivateLinkResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebPubSubReplicaSharedPrivateLinkResources_Get": { + "$ref": "./examples/WebPubSubReplicaSharedPrivateLinkResources_Get.json" + } + } + }, + "put": { + "tags": [ + "WebPubSub" + ], + "description": "Create or update a shared private link resource", + "operationId": "WebPubSubReplicaSharedPrivateLinkResources_CreateOrUpdate", + "consumes": [ + "application/json", + "text/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ReplicaName" + }, + { + "$ref": "#/parameters/SharedPrivateLinkResourceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "The shared private link resource", + "required": true, + "schema": { + "$ref": "#/definitions/SharedPrivateLinkResource" + } + } + ], + "responses": { + "200": { + "description": "OK. The response indicates the shared private link resource is updated.", + "schema": { + "$ref": "#/definitions/SharedPrivateLinkResource" + } + }, + "201": { + "description": "Created. The response indicates the shared private link resource is created.", + "schema": { + "$ref": "#/definitions/SharedPrivateLinkResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "WebPubSubReplicaSharedPrivateLinkResources_CreateOrUpdate": { + "$ref": "./examples/WebPubSubReplicaSharedPrivateLinkResources_CreateOrUpdate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/replicas/{replicaName}/skus": { + "get": { + "tags": [ + "WebPubSub" + ], + "description": "List all available skus of the replica resource.", + "operationId": "WebPubSub_ListReplicaSkus", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ReplicaName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes all available skus of the replica resource.", + "schema": { + "$ref": "#/definitions/SkuList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebPubSub_ListReplicaSkus": { + "$ref": "./examples/WebPubSub_ListReplicaSkus.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/restart": { + "post": { + "tags": [ + "WebPubSub" + ], + "description": "Operation to restart a resource.", + "operationId": "WebPubSub_Restart", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "202": { + "description": "Accepted. The response indicates the restart operation is performed in the background.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Success. The response indicates the operation is successful and no content will be returned." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "WebPubSub_Restart": { + "$ref": "./examples/WebPubSub_Restart.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/sharedPrivateLinkResources": { + "get": { + "tags": [ + "WebPubSub" + ], + "description": "List shared private link resources", + "operationId": "WebPubSubSharedPrivateLinkResources_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes a list of shared private link resources.", + "schema": { + "$ref": "#/definitions/SharedPrivateLinkResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "WebPubSubSharedPrivateLinkResources_List": { + "$ref": "./examples/WebPubSubSharedPrivateLinkResources_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}": { + "get": { + "tags": [ + "WebPubSub" + ], + "description": "Get the specified shared private link resource", + "operationId": "WebPubSubSharedPrivateLinkResources_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SharedPrivateLinkResourceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes a shared private link resource.", + "schema": { + "$ref": "#/definitions/SharedPrivateLinkResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebPubSubSharedPrivateLinkResources_Get": { + "$ref": "./examples/WebPubSubSharedPrivateLinkResources_Get.json" + } + } + }, + "put": { + "tags": [ + "WebPubSub" + ], + "description": "Create or update a shared private link resource", + "operationId": "WebPubSubSharedPrivateLinkResources_CreateOrUpdate", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SharedPrivateLinkResourceName" + }, + { + "in": "body", + "name": "parameters", + "description": "The shared private link resource", + "required": true, + "schema": { + "$ref": "#/definitions/SharedPrivateLinkResource" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "OK. The response indicates the shared private link resource is updated.", + "schema": { + "$ref": "#/definitions/SharedPrivateLinkResource" + } + }, + "201": { + "description": "Created. The response indicates the shared private link resource is created.", + "schema": { + "$ref": "#/definitions/SharedPrivateLinkResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "WebPubSubSharedPrivateLinkResources_CreateOrUpdate": { + "$ref": "./examples/WebPubSubSharedPrivateLinkResources_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "WebPubSub" + ], + "description": "Delete the specified shared private link resource", + "operationId": "WebPubSubSharedPrivateLinkResources_Delete", + "parameters": [ + { + "$ref": "#/parameters/SharedPrivateLinkResourceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response indicates the resource is already deleted." + }, + "202": { + "description": "Accepted. The response indicates the delete operation is performed in the background." + }, + "204": { + "description": "Success. The response indicates the private endpoint connection is already deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "WebPubSubSharedPrivateLinkResources_Delete": { + "$ref": "./examples/WebPubSubSharedPrivateLinkResources_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/skus": { + "get": { + "tags": [ + "WebPubSub" + ], + "description": "List all available skus of the resource.", + "operationId": "WebPubSub_ListSkus", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes all available skus of the resource.", + "schema": { + "$ref": "#/definitions/SkuList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebPubSub_ListSkus": { + "$ref": "./examples/WebPubSub_ListSkus.json" + } + } + } + } + }, + "definitions": { + "ACLAction": { + "description": "Azure Networking ACL Action.", + "enum": [ + "Allow", + "Deny" + ], + "type": "string", + "x-ms-enum": { + "name": "ACLAction", + "modelAsString": true + } + }, + "ApplicationFirewallSettings": { + "description": "Application firewall settings for the resource", + "type": "object", + "properties": { + "clientConnectionCountRules": { + "description": "Rules to control the client connection count", + "maxItems": 10, + "type": "array", + "items": { + "$ref": "#/definitions/ClientConnectionCountRule" + }, + "x-ms-identifiers": [] + }, + "clientTrafficControlRules": { + "description": "Rules to control the client traffic", + "maxItems": 10, + "type": "array", + "items": { + "$ref": "#/definitions/ClientTrafficControlRule" + }, + "x-ms-identifiers": [] + } + } + }, + "ClientConnectionCountRule": { + "description": "A base class for client connection count rules", + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "enum": [ + "ThrottleByJwtSignatureRule", + "ThrottleByUserIdRule", + "ThrottleByJwtCustomClaimRule" + ], + "type": "string", + "x-ms-enum": { + "name": "ClientConnectionCountRuleDiscriminator", + "modelAsString": true + } + } + }, + "discriminator": "type" + }, + "ClientTrafficControlRule": { + "description": "A base class for client traffic control rules", + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "enum": [ + "TrafficThrottleByJwtSignatureRule", + "TrafficThrottleByUserIdRule", + "TrafficThrottleByJwtCustomClaimRule" + ], + "type": "string", + "x-ms-enum": { + "name": "ClientTrafficControlRuleDiscriminator", + "modelAsString": true + } + } + }, + "discriminator": "type" + }, + "CustomCertificate": { + "description": "A custom certificate.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CustomCertificateProperties" + } + } + }, + "CustomCertificateList": { + "description": "Custom certificates list.", + "type": "object", + "properties": { + "value": { + "description": "List of custom certificates of this resource.", + "type": "array", + "items": { + "$ref": "#/definitions/CustomCertificate" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "CustomCertificateProperties": { + "description": "Custom certificate properties.", + "required": [ + "keyVaultBaseUri", + "keyVaultSecretName" + ], + "type": "object", + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "#/definitions/ProvisioningState" + }, + "keyVaultBaseUri": { + "description": "Base uri of the KeyVault that stores certificate.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "keyVaultSecretName": { + "description": "Certificate secret name.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "keyVaultSecretVersion": { + "description": "Certificate secret version.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "CustomDomain": { + "description": "A custom domain", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CustomDomainProperties" + } + } + }, + "CustomDomainList": { + "description": "Custom domains list", + "type": "object", + "properties": { + "value": { + "description": "List of custom domains that bind to this resource.", + "type": "array", + "items": { + "$ref": "#/definitions/CustomDomain" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "CustomDomainProperties": { + "description": "Properties of a custom domain.", + "required": [ + "customCertificate", + "domainName" + ], + "type": "object", + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "#/definitions/ProvisioningState" + }, + "domainName": { + "description": "The custom domain name.", + "type": "string" + }, + "customCertificate": { + "$ref": "#/definitions/ResourceReference" + } + } + }, + "Dimension": { + "description": "Specifications of the Dimension of metrics.", + "type": "object", + "properties": { + "name": { + "description": "The public facing name of the dimension.", + "type": "string" + }, + "displayName": { + "description": "Localized friendly display name of the dimension.", + "type": "string" + }, + "internalName": { + "description": "Name of the dimension as it appears in MDM.", + "type": "string" + }, + "toBeExportedForShoebox": { + "description": "A Boolean flag indicating whether this dimension should be included for the shoebox export scenario.", + "type": "boolean" + } + } + }, + "EventHandler": { + "description": "Properties of event handler.", + "required": [ + "urlTemplate" + ], + "type": "object", + "properties": { + "urlTemplate": { + "description": "Gets or sets the URL template for the event handler. The actual URL is calculated when the corresponding event is triggered. \r\nThe template supports predefined parameters syntax: `{event}`, `{hub}`, and KeyVault reference syntax `{@Microsoft.KeyVault(SecretUri=_your_secret_identifier_)}` \r\nFor example, if the template is `http://example.com/api/{event}`, when `connect` event is triggered, a POST request will be sent to the URL `http://example.com/chat/api/connect`.\r\nNote: Parameters are not allowed in the hostname of the URL, and curly brackets `{}` are reserved for parameter syntax only. If your URL path contains literal curly brackets, please URL-encode them to ensure proper handling.", + "type": "string" + }, + "userEventPattern": { + "description": "Gets or sets the matching pattern for event names.\r\nThere are 3 kinds of patterns supported:\r\n 1. \"*\", it matches any event name\r\n 2. Combine multiple events with \",\", for example \"event1,event2\", it matches event \"event1\" and \"event2\"\r\n 3. A single event name, for example, \"event1\", it matches \"event1\"", + "type": "string" + }, + "systemEvents": { + "description": "Gets or sets the list of system events.", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "auth": { + "$ref": "#/definitions/UpstreamAuthSettings" + } + } + }, + "EventHubEndpoint": { + "description": "An Event Hub endpoint. \r\nThe managed identity of Web PubSub service must be enabled, and the identity should have the \"Azure Event Hubs Data sender\" role to access Event Hub.", + "required": [ + "eventHubName", + "fullyQualifiedNamespace" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EventListenerEndpoint" + } + ], + "properties": { + "fullyQualifiedNamespace": { + "description": "The fully qualified namespace name of the Event Hub resource.", + "type": "string" + }, + "eventHubName": { + "description": "The name of the Event Hub.", + "type": "string" + } + }, + "x-ms-discriminator-value": "EventHub" + }, + "EventListener": { + "description": "A setting defines which kinds of events should be sent to which endpoint.", + "required": [ + "endpoint", + "filter" + ], + "type": "object", + "properties": { + "filter": { + "$ref": "#/definitions/EventListenerFilter" + }, + "endpoint": { + "$ref": "#/definitions/EventListenerEndpoint" + } + } + }, + "EventListenerEndpoint": { + "description": "An endpoint specifying where Web PubSub should send events to.", + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "enum": [ + "EventHub" + ], + "type": "string", + "x-ms-enum": { + "name": "EventListenerEndpointDiscriminator", + "modelAsString": true + } + } + }, + "discriminator": "type" + }, + "EventListenerFilter": { + "description": "A base class for event filter which determines whether an event should be sent to an event listener.", + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "enum": [ + "EventName" + ], + "type": "string", + "x-ms-enum": { + "name": "EventListenerFilterDiscriminator", + "modelAsString": true + } + } + }, + "discriminator": "type" + }, + "EventNameFilter": { + "description": "Filter events by their name.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EventListenerFilter" + } + ], + "properties": { + "systemEvents": { + "description": "Gets or sets a list of system events. Supported events: \"connected\" and \"disconnected\". Blocking event \"connect\" is not supported because it requires a response.", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "userEventPattern": { + "description": "Gets or sets a matching pattern for event names.\r\nThere are 3 kinds of patterns supported:\r\n 1. \"*\", it matches any event name\r\n 2. Combine multiple events with \",\", for example \"event1,event2\", it matches events \"event1\" and \"event2\"\r\n 3. A single event name, for example, \"event1\", it matches \"event1\"", + "type": "string" + } + }, + "x-ms-discriminator-value": "EventName" + }, + "IPRule": { + "description": "An IP rule", + "type": "object", + "properties": { + "value": { + "description": "An IP or CIDR or ServiceTag", + "type": "string" + }, + "action": { + "$ref": "#/definitions/ACLAction" + } + } + }, + "KeyType": { + "description": "The type of access key.", + "enum": [ + "Primary", + "Secondary", + "Salt" + ], + "type": "string", + "x-ms-enum": { + "name": "KeyType", + "modelAsString": true + } + }, + "LiveTraceCategory": { + "description": "Live trace category configuration of a Microsoft.SignalRService resource.", + "type": "object", + "properties": { + "name": { + "description": "Gets or sets the live trace category's name.\r\nAvailable values: ConnectivityLogs, MessagingLogs.\r\nCase insensitive.", + "type": "string" + }, + "enabled": { + "description": "Indicates whether or the live trace category is enabled.\r\nAvailable values: true, false.\r\nCase insensitive.", + "type": "string" + } + } + }, + "LiveTraceConfiguration": { + "description": "Live trace configuration of a Microsoft.SignalRService resource.", + "type": "object", + "properties": { + "enabled": { + "description": "Indicates whether or not enable live trace.\r\nWhen it's set to true, live trace client can connect to the service.\r\nOtherwise, live trace client can't connect to the service, so that you are unable to receive any log, no matter what you configure in \"categories\".\r\nAvailable values: true, false.\r\nCase insensitive.", + "default": "false", + "type": "string" + }, + "categories": { + "description": "Gets or sets the list of category configurations.", + "type": "array", + "items": { + "$ref": "#/definitions/LiveTraceCategory" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "LogSpecification": { + "description": "Specifications of the Logs for Azure Monitoring.", + "type": "object", + "properties": { + "name": { + "description": "Name of the log.", + "type": "string" + }, + "displayName": { + "description": "Localized friendly display name of the log.", + "type": "string" + } + } + }, + "ManagedIdentity": { + "description": "A class represent managed identities used for request and response", + "type": "object", + "properties": { + "type": { + "$ref": "#/definitions/ManagedIdentityType" + }, + "userAssignedIdentities": { + "description": "Get or set the user assigned identities", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/UserAssignedIdentityProperty" + } + }, + "principalId": { + "description": "Get the principal id for the system assigned identity.\r\nOnly be used in response.", + "type": "string", + "readOnly": true + }, + "tenantId": { + "description": "Get the tenant id for the system assigned identity.\r\nOnly be used in response", + "type": "string", + "readOnly": true + } + } + }, + "ManagedIdentitySettings": { + "description": "Managed identity settings for upstream.", + "type": "object", + "properties": { + "resource": { + "description": "The Resource indicating the App ID URI of the target resource.\r\nIt also appears in the aud (audience) claim of the issued token.", + "type": "string" + } + } + }, + "ManagedIdentityType": { + "description": "Represents the identity type: systemAssigned, userAssigned, None", + "enum": [ + "None", + "SystemAssigned", + "UserAssigned" + ], + "type": "string", + "x-ms-enum": { + "name": "ManagedIdentityType", + "modelAsString": true + } + }, + "MetricSpecification": { + "description": "Specifications of the Metrics for Azure Monitoring.", + "type": "object", + "properties": { + "name": { + "description": "Name of the metric.", + "type": "string" + }, + "displayName": { + "description": "Localized friendly display name of the metric.", + "type": "string" + }, + "displayDescription": { + "description": "Localized friendly description of the metric.", + "type": "string" + }, + "unit": { + "description": "The unit that makes sense for the metric.", + "type": "string" + }, + "aggregationType": { + "description": "Only provide one value for this field. Valid values: Average, Minimum, Maximum, Total, Count.", + "type": "string" + }, + "fillGapWithZero": { + "description": "Optional. If set to true, then zero will be returned for time duration where no metric is emitted/published. \r\nEx. a metric that returns the number of times a particular error code was emitted. The error code may not appear \r\noften, instead of the RP publishing 0, Shoebox can auto fill in 0s for time periods where nothing was emitted.", + "type": "string" + }, + "category": { + "description": "The name of the metric category that the metric belongs to. A metric can only belong to a single category.", + "type": "string" + }, + "dimensions": { + "description": "The dimensions of the metrics.", + "type": "array", + "items": { + "$ref": "#/definitions/Dimension" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "NameAvailability": { + "description": "Result of the request to check name availability. It contains a flag and possible reason of failure.", + "type": "object", + "properties": { + "nameAvailable": { + "description": "Indicates whether the name is available or not.", + "type": "boolean" + }, + "reason": { + "description": "The reason of the availability. Required if name is not available.", + "type": "string" + }, + "message": { + "description": "The message of the operation.", + "type": "string" + } + } + }, + "NameAvailabilityParameters": { + "description": "Data POST-ed to the nameAvailability action", + "required": [ + "name", + "type" + ], + "type": "object", + "properties": { + "type": { + "description": "The resource type. Can be \"Microsoft.SignalRService/SignalR\", \"Microsoft.SignalRService/WebPubSub\", \"Microsoft.SignalRService/SignalR/replicas\" or \"Microsoft.SignalRService/WebPubSub/replicas\"", + "type": "string" + }, + "name": { + "description": "The resource name to validate. e.g.\"my-resource-name\"", + "type": "string" + } + } + }, + "NetworkACL": { + "description": "Network ACL", + "type": "object", + "properties": { + "allow": { + "description": "Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.", + "type": "array", + "items": { + "$ref": "#/definitions/WebPubSubRequestType" + }, + "x-ms-identifiers": [] + }, + "deny": { + "description": "Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.", + "type": "array", + "items": { + "$ref": "#/definitions/WebPubSubRequestType" + }, + "x-ms-identifiers": [] + } + } + }, + "Operation": { + "description": "REST API operation supported by resource provider.", + "type": "object", + "properties": { + "name": { + "description": "Name of the operation with format: {provider}/{resource}/{operation}", + "type": "string" + }, + "isDataAction": { + "description": "If the operation is a data action. (for data plane rbac)", + "type": "boolean" + }, + "display": { + "$ref": "#/definitions/OperationDisplay" + }, + "origin": { + "description": "Optional. The intended executor of the operation; governs the display of the operation in the RBAC UX and the audit logs UX.", + "type": "string" + }, + "properties": { + "x-ms-client-flatten": false, + "$ref": "#/definitions/OperationProperties" + } + } + }, + "OperationDisplay": { + "description": "The object that describes a operation.", + "type": "object", + "properties": { + "provider": { + "description": "Friendly name of the resource provider", + "type": "string" + }, + "resource": { + "description": "Resource type on which the operation is performed.", + "type": "string" + }, + "operation": { + "description": "The localized friendly name for the operation.", + "type": "string" + }, + "description": { + "description": "The localized friendly description for the operation", + "type": "string" + } + } + }, + "OperationList": { + "description": "Result of the request to list REST API operations. It contains a list of operations.", + "type": "object", + "properties": { + "value": { + "description": "List of operations supported by the resource provider.", + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "nextLink": { + "description": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "OperationProperties": { + "description": "Extra Operation properties.", + "type": "object", + "properties": { + "serviceSpecification": { + "$ref": "#/definitions/ServiceSpecification" + } + } + }, + "PrivateEndpoint": { + "description": "Private endpoint", + "type": "object", + "properties": { + "id": { + "description": "Full qualified Id of the private endpoint", + "type": "string" + } + } + }, + "PrivateEndpointACL": { + "description": "ACL for a private endpoint", + "required": [ + "name" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/NetworkACL" + } + ], + "properties": { + "name": { + "description": "Name of the private endpoint connection", + "type": "string" + } + } + }, + "PrivateEndpointConnection": { + "description": "A private endpoint connection to an azure resource", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PrivateEndpointConnectionProperties" + } + } + }, + "PrivateEndpointConnectionList": { + "description": "A list of private endpoint connections", + "type": "object", + "properties": { + "value": { + "description": "The list of the private endpoint connections", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "Request URL that can be used to query next page of private endpoint connections. Returned when the total number of requested private endpoint connections exceed maximum page size.", + "type": "string" + } + } + }, + "PrivateEndpointConnectionProperties": { + "description": "Private endpoint connection properties", + "type": "object", + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "#/definitions/ProvisioningState" + }, + "privateEndpoint": { + "$ref": "#/definitions/PrivateEndpoint" + }, + "groupIds": { + "description": "Group IDs", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/PrivateLinkServiceConnectionState" + } + } + }, + "PrivateLinkResource": { + "description": "Private link resource", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PrivateLinkResourceProperties" + } + } + }, + "PrivateLinkResourceList": { + "description": "Contains a list of PrivateLinkResource and a possible link to query more results", + "type": "object", + "properties": { + "value": { + "description": "List of PrivateLinkResource", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "PrivateLinkResourceProperties": { + "description": "Private link resource properties", + "type": "object", + "properties": { + "groupId": { + "description": "Group Id of the private link resource", + "type": "string" + }, + "requiredMembers": { + "description": "Required members of the private link resource", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "requiredZoneNames": { + "description": "Required private DNS zone names", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "shareablePrivateLinkResourceTypes": { + "description": "The list of resources that are onboarded to private link service", + "type": "array", + "items": { + "$ref": "#/definitions/ShareablePrivateLinkResourceType" + }, + "x-ms-identifiers": [] + } + } + }, + "PrivateLinkServiceConnectionState": { + "description": "Connection state of the private endpoint connection", + "type": "object", + "properties": { + "status": { + "$ref": "#/definitions/PrivateLinkServiceConnectionStatus" + }, + "description": { + "description": "The reason for approval/rejection of the connection.", + "type": "string" + }, + "actionsRequired": { + "description": "A message indicating if changes on the service provider require any updates on the consumer.", + "type": "string" + } + } + }, + "PrivateLinkServiceConnectionStatus": { + "description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.", + "enum": [ + "Pending", + "Approved", + "Rejected", + "Disconnected" + ], + "type": "string", + "x-ms-enum": { + "name": "PrivateLinkServiceConnectionStatus", + "modelAsString": true + } + }, + "ProvisioningState": { + "description": "Provisioning state of the resource.", + "enum": [ + "Unknown", + "Succeeded", + "Failed", + "Canceled", + "Running", + "Creating", + "Updating", + "Deleting", + "Moving" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "RegenerateKeyParameters": { + "description": "Parameters describes the request to regenerate access keys", + "type": "object", + "properties": { + "keyType": { + "$ref": "#/definitions/KeyType" + } + } + }, + "Replica": { + "description": "A class represent a replica resource.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "sku": { + "$ref": "#/definitions/ResourceSku" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ReplicaProperties" + } + } + }, + "ReplicaList": { + "type": "object", + "properties": { + "value": { + "description": "List of the replica", + "type": "array", + "items": { + "$ref": "#/definitions/Replica" + } + }, + "nextLink": { + "description": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "ReplicaProperties": { + "type": "object", + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "#/definitions/ProvisioningState" + }, + "regionEndpointEnabled": { + "description": "Enable or disable the regional endpoint. Default to \"Enabled\".\r\nWhen it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected.", + "default": "Enabled", + "type": "string" + }, + "resourceStopped": { + "description": "Stop or start the resource. Default to \"false\".\r\nWhen it's true, the data plane of the resource is shutdown.\r\nWhen it's false, the data plane of the resource is started.", + "default": "false", + "type": "string" + } + } + }, + "ResourceLogCategory": { + "description": "Resource log category configuration of a Microsoft.SignalRService resource.", + "type": "object", + "properties": { + "name": { + "description": "Gets or sets the resource log category's name.\r\nAvailable values: ConnectivityLogs, MessagingLogs.\r\nCase insensitive.", + "type": "string" + }, + "enabled": { + "description": "Indicates whether or the resource log category is enabled.\r\nAvailable values: true, false.\r\nCase insensitive.", + "type": "string" + } + } + }, + "ResourceLogConfiguration": { + "description": "Resource log configuration of a Microsoft.SignalRService resource.", + "type": "object", + "properties": { + "categories": { + "description": "Gets or sets the list of category configurations.", + "type": "array", + "items": { + "$ref": "#/definitions/ResourceLogCategory" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "ResourceReference": { + "description": "Reference to a resource.", + "type": "object", + "properties": { + "id": { + "description": "Resource ID.", + "type": "string" + } + } + }, + "ResourceSku": { + "description": "The billing information of the resource.", + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "description": "The name of the SKU. Required.\r\n\r\nAllowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2", + "type": "string" + }, + "tier": { + "$ref": "#/definitions/WebPubSubSkuTier" + }, + "size": { + "description": "Not used. Retained for future use.", + "type": "string", + "readOnly": true + }, + "family": { + "description": "Not used. Retained for future use.", + "type": "string", + "readOnly": true + }, + "capacity": { + "format": "int32", + "description": "Optional, integer. The unit count of the resource.\r\n1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default.\r\n\r\nIf present, following values are allowed:\r\n Free_F1: 1;\r\n Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\r\n Premium_P1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\r\n Premium_P2: 100,200,300,400,500,600,700,800,900,1000;", + "type": "integer" + } + } + }, + "ScaleType": { + "description": "The scale type applicable to the sku.", + "enum": [ + "None", + "Manual", + "Automatic" + ], + "type": "string", + "x-ms-enum": { + "name": "ScaleType", + "modelAsString": true + } + }, + "ServiceKind": { + "description": "The kind of the service", + "enum": [ + "WebPubSub", + "SocketIO" + ], + "type": "string", + "x-ms-enum": { + "name": "ServiceKind", + "modelAsString": true + } + }, + "ServiceSpecification": { + "description": "An object that describes a specification.", + "type": "object", + "properties": { + "metricSpecifications": { + "description": "Specifications of the Metrics for Azure Monitoring.", + "type": "array", + "items": { + "$ref": "#/definitions/MetricSpecification" + }, + "x-ms-identifiers": [ + "name", + "unit" + ] + }, + "logSpecifications": { + "description": "Specifications of the Logs for Azure Monitoring.", + "type": "array", + "items": { + "$ref": "#/definitions/LogSpecification" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "ShareablePrivateLinkResourceProperties": { + "description": "Describes the properties of a resource type that has been onboarded to private link service", + "type": "object", + "properties": { + "description": { + "description": "The description of the resource type that has been onboarded to private link service", + "type": "string" + }, + "groupId": { + "description": "The resource provider group id for the resource that has been onboarded to private link service", + "type": "string" + }, + "type": { + "description": "The resource provider type for the resource that has been onboarded to private link service", + "type": "string" + } + } + }, + "ShareablePrivateLinkResourceType": { + "description": "Describes a resource type that has been onboarded to private link service", + "type": "object", + "properties": { + "name": { + "description": "The name of the resource type that has been onboarded to private link service", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/ShareablePrivateLinkResourceProperties" + } + } + }, + "SharedPrivateLinkResource": { + "description": "Describes a Shared Private Link Resource", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SharedPrivateLinkResourceProperties" + } + } + }, + "SharedPrivateLinkResourceList": { + "description": "A list of shared private link resources", + "type": "object", + "properties": { + "value": { + "description": "The list of the shared private link resources", + "type": "array", + "items": { + "$ref": "#/definitions/SharedPrivateLinkResource" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "Request URL that can be used to query next page of private endpoint connections. Returned when the total number of requested private endpoint connections exceed maximum page size.", + "type": "string" + } + } + }, + "SharedPrivateLinkResourceProperties": { + "description": "Describes the properties of an existing Shared Private Link Resource", + "required": [ + "groupId", + "privateLinkResourceId" + ], + "type": "object", + "properties": { + "groupId": { + "description": "The group id from the provider of resource the shared private link resource is for", + "type": "string" + }, + "privateLinkResourceId": { + "description": "The resource id of the resource the shared private link resource is for", + "type": "string" + }, + "provisioningState": { + "readOnly": true, + "$ref": "#/definitions/ProvisioningState" + }, + "requestMessage": { + "description": "The request message for requesting approval of the shared private link resource", + "type": "string" + }, + "fqdns": { + "description": "A list of FQDNs for third party private link service", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "status": { + "readOnly": true, + "$ref": "#/definitions/SharedPrivateLinkResourceStatus" + } + } + }, + "SharedPrivateLinkResourceStatus": { + "description": "Status of the shared private link resource", + "enum": [ + "Pending", + "Approved", + "Rejected", + "Disconnected", + "Timeout" + ], + "type": "string", + "x-ms-enum": { + "name": "SharedPrivateLinkResourceStatus", + "modelAsString": true + } + }, + "SignalRServiceUsage": { + "description": "Object that describes a specific usage of the resources.", + "type": "object", + "properties": { + "id": { + "description": "Fully qualified ARM resource id", + "type": "string" + }, + "currentValue": { + "format": "int64", + "description": "Current value for the usage quota.", + "type": "integer" + }, + "limit": { + "format": "int64", + "description": "The maximum permitted value for the usage quota. If there is no limit, this value will be -1.", + "type": "integer" + }, + "name": { + "$ref": "#/definitions/SignalRServiceUsageName" + }, + "unit": { + "description": "Representing the units of the usage quota. Possible values are: Count, Bytes, Seconds, Percent, CountPerSecond, BytesPerSecond.", + "type": "string" + } + } + }, + "SignalRServiceUsageList": { + "description": "Object that includes an array of the resource usages and a possible link for next set.", + "type": "object", + "properties": { + "value": { + "description": "List of the resource usages", + "type": "array", + "items": { + "$ref": "#/definitions/SignalRServiceUsage" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "SignalRServiceUsageName": { + "description": "Localizable String object containing the name and a localized value.", + "type": "object", + "properties": { + "value": { + "description": "The identifier of the usage.", + "type": "string" + }, + "localizedValue": { + "description": "Localized name of the usage.", + "type": "string" + } + } + }, + "Sku": { + "description": "Describes an available sku.\"", + "type": "object", + "properties": { + "resourceType": { + "description": "The resource type that this object applies to", + "type": "string", + "readOnly": true + }, + "sku": { + "readOnly": true, + "$ref": "#/definitions/ResourceSku" + }, + "capacity": { + "readOnly": true, + "$ref": "#/definitions/SkuCapacity" + } + } + }, + "SkuCapacity": { + "description": "Describes scaling information of a sku.", + "type": "object", + "properties": { + "minimum": { + "format": "int32", + "description": "The lowest permitted capacity for this resource", + "type": "integer", + "readOnly": true + }, + "maximum": { + "format": "int32", + "description": "The highest permitted capacity for this resource", + "type": "integer", + "readOnly": true + }, + "default": { + "format": "int32", + "description": "The default capacity.", + "type": "integer", + "readOnly": true + }, + "allowedValues": { + "description": "Allows capacity value list.", + "type": "array", + "items": { + "format": "int32", + "type": "integer" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "scaleType": { + "readOnly": true, + "$ref": "#/definitions/ScaleType" + } + } + }, + "SkuList": { + "description": "The list skus operation response", + "type": "object", + "properties": { + "value": { + "description": "The list of skus available for the resource.", + "type": "array", + "items": { + "$ref": "#/definitions/Sku" + }, + "readOnly": true, + "x-ms-identifiers": [ + "resourceType", + "/sku/name", + "/sku/tier" + ] + }, + "nextLink": { + "description": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string", + "readOnly": true + } + } + }, + "ThrottleByJwtCustomClaimRule": { + "description": "Throttle the client connection by a custom JWT claim", + "required": [ + "claimName" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ClientConnectionCountRule" + } + ], + "properties": { + "claimName": { + "description": "The name of the claim in the JWT token. The client connection with the same claim value will be aggregated. If the claim is not found in the token, the connection will be allowed.", + "type": "string" + }, + "maxCount": { + "format": "int32", + "description": "Maximum connection count allowed for the same Jwt claim value. Clients with the same Jwt claim will get rejected if the connection count exceeds this value. Default value is 20.", + "default": 20, + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + } + }, + "x-ms-discriminator-value": "ThrottleByJwtCustomClaimRule" + }, + "ThrottleByJwtSignatureRule": { + "description": "Throttle the client connection by the JWT signature", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ClientConnectionCountRule" + } + ], + "properties": { + "maxCount": { + "format": "int32", + "description": "Maximum connection count allowed for the same JWT signature. Clients with the same JWT signature will get rejected if the connection count exceeds this value. Default value is 20.", + "default": 20, + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + } + }, + "x-ms-discriminator-value": "ThrottleByJwtSignatureRule" + }, + "ThrottleByUserIdRule": { + "description": "Throttle the client connection by the user ID", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ClientConnectionCountRule" + } + ], + "properties": { + "maxCount": { + "format": "int32", + "description": "Maximum connection count allowed for the same user ID. Clients with the same user ID will get rejected if the connection count exceeds this value. Default value is 20.", + "default": 20, + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + } + }, + "x-ms-discriminator-value": "ThrottleByUserIdRule" + }, + "TrafficThrottleByJwtCustomClaimRule": { + "description": "Throttle the client traffic by a custom JWT claim", + "required": [ + "claimName" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ClientTrafficControlRule" + } + ], + "properties": { + "claimName": { + "description": "The name of the claim in the JWT token. The message bytes with the same claim value will be aggregated. If the claim is not found in the token, the rule will be skipped.", + "type": "string" + }, + "maxInboundMessageBytes": { + "format": "int64", + "description": "Maximum accumulated inbound message bytes allowed for the same JWT signature within a time window. Clients with the same JWT claim will get disconnected if the message bytes exceeds this value. Default value is 1GB.", + "minimum": 0, + "type": "integer" + }, + "aggregationWindowInSeconds": { + "format": "int32", + "description": "The aggregation window for the message bytes. The message bytes will be aggregated in this window and be reset after the window. Default value is 60 seconds.", + "default": 60, + "maximum": 3600, + "minimum": 10, + "type": "integer" + } + }, + "x-ms-discriminator-value": "TrafficThrottleByJwtCustomClaimRule" + }, + "TrafficThrottleByJwtSignatureRule": { + "description": "Throttle the client traffic by the JWT signature", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ClientTrafficControlRule" + } + ], + "properties": { + "maxInboundMessageBytes": { + "format": "int64", + "description": "Maximum accumulated inbound message bytes allowed for the same JWT signature within a time window. Clients with the same JWT signature will get disconnected if the message bytes exceeds this value. Default value is 1GB.", + "minimum": 0, + "type": "integer" + }, + "aggregationWindowInSeconds": { + "format": "int32", + "description": "The aggregation window for the message bytes. The message bytes will be aggregated in this window and be reset after the window. Default value is 60 seconds.", + "default": 60, + "maximum": 3600, + "minimum": 10, + "type": "integer" + } + }, + "x-ms-discriminator-value": "TrafficThrottleByJwtSignatureRule" + }, + "TrafficThrottleByUserIdRule": { + "description": "Throttle the client traffic by the user ID", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ClientTrafficControlRule" + } + ], + "properties": { + "maxInboundMessageBytes": { + "format": "int64", + "description": "Maximum accumulated inbound message bytes allowed for the same user ID within a time window. Clients with the same user ID will get disconnected if the message bytes exceeds this value. Default value is 1GB.", + "minimum": 0, + "type": "integer" + }, + "aggregationWindowInSeconds": { + "format": "int32", + "description": "The aggregation window for the message bytes. The message bytes will be aggregated in this window and be reset after the window. Default value is 60 seconds.", + "default": 60, + "maximum": 3600, + "minimum": 10, + "type": "integer" + } + }, + "x-ms-discriminator-value": "TrafficThrottleByUserIdRule" + }, + "UpstreamAuthSettings": { + "description": "Upstream auth settings. If not set, no auth is used for upstream messages.", + "type": "object", + "properties": { + "type": { + "$ref": "#/definitions/UpstreamAuthType" + }, + "managedIdentity": { + "$ref": "#/definitions/ManagedIdentitySettings" + } + } + }, + "UpstreamAuthType": { + "description": "Upstream auth type enum.", + "enum": [ + "None", + "ManagedIdentity" + ], + "type": "string", + "x-ms-enum": { + "name": "UpstreamAuthType", + "modelAsString": true + } + }, + "UserAssignedIdentityProperty": { + "description": "Properties of user assigned identity.", + "type": "object", + "properties": { + "principalId": { + "description": "Get the principal id for the user assigned identity", + "type": "string", + "readOnly": true + }, + "clientId": { + "description": "Get the client id for the user assigned identity", + "type": "string", + "readOnly": true + } + } + }, + "WebPubSubHub": { + "description": "A hub setting", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/WebPubSubHubProperties" + } + } + }, + "WebPubSubHubList": { + "description": "Hub setting list", + "type": "object", + "properties": { + "value": { + "description": "List of hub settings to this resource.", + "type": "array", + "items": { + "$ref": "#/definitions/WebPubSubHub" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string", + "readOnly": true + } + } + }, + "WebPubSubHubProperties": { + "description": "Properties of a hub.", + "type": "object", + "properties": { + "eventHandlers": { + "description": "Event handler of a hub.", + "type": "array", + "items": { + "$ref": "#/definitions/EventHandler" + }, + "x-ms-identifiers": [] + }, + "eventListeners": { + "description": "Event listener settings for forwarding your client events to listeners.\r\nEvent listener is transparent to Web PubSub clients, and it doesn't return any result to clients nor interrupt the lifetime of clients.\r\nOne event can be sent to multiple listeners, as long as it matches the filters in those listeners. The order of the array elements doesn't matter.\r\nMaximum count of event listeners among all hubs is 10.", + "type": "array", + "items": { + "$ref": "#/definitions/EventListener" + }, + "x-ms-identifiers": [] + }, + "anonymousConnectPolicy": { + "description": "The settings for configuring if anonymous connections are allowed for this hub: \"allow\" or \"deny\". Default to \"deny\".", + "default": "deny", + "type": "string" + }, + "webSocketKeepAliveIntervalInSeconds": { + "format": "int32", + "description": "The settings for configuring the WebSocket ping-pong interval in seconds for all clients in the hub. Valid range: 1 to 120. Default to 20 seconds.", + "default": 20, + "maximum": 120, + "minimum": 1, + "type": "integer" + } + } + }, + "WebPubSubKeys": { + "description": "A class represents the access keys of the resource.", + "type": "object", + "properties": { + "primaryKey": { + "description": "The primary access key.", + "type": "string", + "x-ms-secret": true + }, + "secondaryKey": { + "description": "The secondary access key.", + "type": "string", + "x-ms-secret": true + }, + "primaryConnectionString": { + "description": "Connection string constructed via the primaryKey", + "type": "string", + "x-ms-secret": true + }, + "secondaryConnectionString": { + "description": "Connection string constructed via the secondaryKey", + "type": "string", + "x-ms-secret": true + } + } + }, + "WebPubSubNetworkACLs": { + "description": "Network ACLs for the resource", + "type": "object", + "properties": { + "defaultAction": { + "$ref": "#/definitions/ACLAction" + }, + "publicNetwork": { + "$ref": "#/definitions/NetworkACL" + }, + "privateEndpoints": { + "description": "ACLs for requests from private endpoints", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointACL" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "ipRules": { + "description": "IP rules for filtering public traffic", + "maxItems": 30, + "type": "array", + "items": { + "$ref": "#/definitions/IPRule" + }, + "x-ms-identifiers": [] + } + } + }, + "WebPubSubProperties": { + "description": "A class that describes the properties of the resource", + "type": "object", + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "#/definitions/ProvisioningState" + }, + "externalIP": { + "description": "The publicly accessible IP of the resource.", + "type": "string", + "readOnly": true + }, + "hostName": { + "description": "FQDN of the service instance.", + "type": "string", + "readOnly": true + }, + "publicPort": { + "format": "int32", + "description": "The publicly accessible port of the resource which is designed for browser/client side usage.", + "type": "integer", + "readOnly": true + }, + "serverPort": { + "format": "int32", + "description": "The publicly accessible port of the resource which is designed for customer server side usage.", + "type": "integer", + "readOnly": true + }, + "version": { + "description": "Version of the resource. Probably you need the same or higher version of client SDKs.", + "type": "string", + "readOnly": true + }, + "privateEndpointConnections": { + "description": "Private endpoint connections to the resource.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "sharedPrivateLinkResources": { + "description": "The list of shared private link resources.", + "type": "array", + "items": { + "$ref": "#/definitions/SharedPrivateLinkResource" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "tls": { + "$ref": "#/definitions/WebPubSubTlsSettings" + }, + "hostNamePrefix": { + "description": "Deprecated.", + "type": "string", + "readOnly": true + }, + "liveTraceConfiguration": { + "$ref": "#/definitions/LiveTraceConfiguration" + }, + "resourceLogConfiguration": { + "$ref": "#/definitions/ResourceLogConfiguration" + }, + "networkACLs": { + "$ref": "#/definitions/WebPubSubNetworkACLs" + }, + "applicationFirewall": { + "$ref": "#/definitions/ApplicationFirewallSettings" + }, + "publicNetworkAccess": { + "description": "Enable or disable public network access. Default to \"Enabled\".\r\nWhen it's Enabled, network ACLs still apply.\r\nWhen it's Disabled, public network access is always disabled no matter what you set in network ACLs.", + "default": "Enabled", + "type": "string" + }, + "disableLocalAuth": { + "description": "DisableLocalAuth\r\nEnable or disable local auth with AccessKey\r\nWhen set as true, connection with AccessKey=xxx won't work.", + "default": false, + "type": "boolean" + }, + "disableAadAuth": { + "description": "DisableLocalAuth\r\nEnable or disable aad auth\r\nWhen set as true, connection with AuthType=aad won't work.", + "default": false, + "type": "boolean" + }, + "regionEndpointEnabled": { + "description": "Enable or disable the regional endpoint. Default to \"Enabled\".\r\nWhen it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected.\r\nThis property is replica specific. Disable the regional endpoint without replica is not allowed.", + "default": "Enabled", + "type": "string" + }, + "resourceStopped": { + "description": "Stop or start the resource. Default to \"False\".\r\nWhen it's true, the data plane of the resource is shutdown.\r\nWhen it's false, the data plane of the resource is started.", + "default": "false", + "type": "string" + }, + "socketIO": { + "$ref": "#/definitions/WebPubSubSocketIOSettings" + } + } + }, + "WebPubSubRequestType": { + "description": "The incoming request type to the service", + "enum": [ + "ClientConnection", + "ServerConnection", + "RESTAPI", + "Trace" + ], + "type": "string", + "x-ms-enum": { + "name": "WebPubSubRequestType", + "modelAsString": true + } + }, + "WebPubSubResource": { + "description": "A class represent a resource.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "sku": { + "$ref": "#/definitions/ResourceSku" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/WebPubSubProperties" + }, + "kind": { + "x-ms-mutability": [ + "read", + "create" + ], + "$ref": "#/definitions/ServiceKind" + }, + "identity": { + "$ref": "#/definitions/ManagedIdentity" + } + } + }, + "WebPubSubResourceList": { + "description": "Object that includes an array of resources and a possible link for next set.", + "type": "object", + "properties": { + "value": { + "description": "List of the resources", + "type": "array", + "items": { + "$ref": "#/definitions/WebPubSubResource" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "WebPubSubSkuTier": { + "description": "Optional tier of this particular SKU. 'Standard' or 'Free'. \r\n\r\n`Basic` is deprecated, use `Standard` instead.", + "enum": [ + "Free", + "Basic", + "Standard", + "Premium" + ], + "type": "string", + "x-ms-enum": { + "name": "WebPubSubSkuTier", + "modelAsString": true + } + }, + "WebPubSubSocketIOSettings": { + "description": "SocketIO settings for the resource", + "type": "object", + "properties": { + "serviceMode": { + "description": "The service mode of Web PubSub for Socket.IO. Values allowed: \r\n\"Default\": have your own backend Socket.IO server\r\n\"Serverless\": your application doesn't have a backend server", + "type": "string" + } + } + }, + "WebPubSubTlsSettings": { + "description": "TLS settings for the resource", + "type": "object", + "properties": { + "clientCertEnabled": { + "description": "Request client certificate during TLS handshake if enabled. Not supported for free tier. Any input will be ignored for free tier.", + "default": false, + "type": "boolean" + } + } + } + }, + "parameters": { + "ResourceName": { + "in": "path", + "name": "resourceName", + "description": "The name of the resource.", + "required": true, + "maxLength": 63, + "minLength": 3, + "pattern": "^[a-zA-Z][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]$", + "type": "string", + "x-ms-parameter-location": "method" + }, + "ReplicaName": { + "in": "path", + "name": "replicaName", + "description": "The name of the replica.", + "required": true, + "maxLength": 63, + "minLength": 3, + "pattern": "^[a-zA-Z][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]$", + "type": "string", + "x-ms-parameter-location": "method" + }, + "SharedPrivateLinkResourceName": { + "in": "path", + "name": "sharedPrivateLinkResourceName", + "description": "The name of the shared private link resource.", + "required": true, + "maxLength": 63, + "minLength": 3, + "pattern": "^[a-zA-Z][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]$", + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "description": "Azure Active Directory OAuth2 Flow" + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "host": "management.azure.com", + "schemes": [ + "https" + ], + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] +} diff --git a/specification/webpubsub/resource-manager/readme.go.md b/specification/webpubsub/resource-manager/readme.go.md index a9ac9c397fd6..7553f583f800 100644 --- a/specification/webpubsub/resource-manager/readme.go.md +++ b/specification/webpubsub/resource-manager/readme.go.md @@ -41,6 +41,7 @@ batch: - tag: package-2024-03-01 - tag: package-2024-04-01-preview - tag: package-2024-08-01-preview + - tag: package-2024-10-01-preview ``` ### Tag: package-2021-04-01-preview and go @@ -159,3 +160,13 @@ Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2024-10-01-preview' && $(go) +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2024-10-01-preview/$(namespace) +``` \ No newline at end of file diff --git a/specification/webpubsub/resource-manager/readme.md b/specification/webpubsub/resource-manager/readme.md index 1b6f77e49586..ca542b263d85 100644 --- a/specification/webpubsub/resource-manager/readme.md +++ b/specification/webpubsub/resource-manager/readme.md @@ -26,7 +26,7 @@ These are the global settings for the WebPubSub API. ``` yaml openapi-type: arm -tag: package-2024-08-01-preview +tag: package-2024-10-01-preview ``` ### Suppression @@ -188,6 +188,15 @@ input-file: - Microsoft.SignalRService/preview/2024-08-01-preview/webpubsub.json ``` +### Tag: package-2024-10-01-preview + +These settings apply only when `--tag=package-2024-10-01-preview` is specified on the command line. + +```yaml $(tag) == 'package-2024-10-01-preview' +input-file: +- Microsoft.SignalRService/preview/2024-10-01-preview/webpubsub.json +``` + --- # Code Generation diff --git a/specification/webpubsub/resource-manager/readme.ruby.md b/specification/webpubsub/resource-manager/readme.ruby.md index 35d95a432eff..7ce96dacdf11 100644 --- a/specification/webpubsub/resource-manager/readme.ruby.md +++ b/specification/webpubsub/resource-manager/readme.ruby.md @@ -25,6 +25,7 @@ batch: - tag: package-2024-03-01 - tag: package-2024-04-01-preview - tag: package-2024-08-01-preview + - tag: package-2024-10-01-preview ``` ### Tag: package-2021-04-01-preview and ruby @@ -155,4 +156,14 @@ Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2024-10-01-preview' && $(ruby) +namespace: "Azure::WebPubSub::Mgmt::V2024_10_01_preview" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_webpubsub/lib ``` \ No newline at end of file