From e8f40511ece7e41358e13b784a4205bb081a28b1 Mon Sep 17 00:00:00 2001 From: cgerrettMSFT <139756492+cgerrettMSFT@users.noreply.github.com> Date: Mon, 30 Oct 2023 19:42:01 +0000 Subject: [PATCH] [Hub Generated] Publish private branch 'voiceservices/2023-09-01-public-publish' (#26394) * Base Commit - Publish Voiceservices 2023-09-01 * Introducing 2023-09-01 changes --- ...CommunicationsGateways_CreateOrUpdate.json | 234 +++ .../CommunicationsGateways_Delete.json | 20 + .../examples/CommunicationsGateways_Get.json | 102 ++ ...nicationsGateways_ListByResourceGroup.json | 70 + ...unicationsGateways_ListBySubscription.json | 69 + .../CommunicationsGateways_Update.json | 103 ++ .../examples/NameAvailability_CheckLocal.json | 22 + .../2023-09-01/examples/Operations_List.json | 25 + .../examples/TestLines_CreateOrUpdate.json | 45 + .../2023-09-01/examples/TestLines_Delete.json | 22 + .../2023-09-01/examples/TestLines_Get.json | 26 + ...TestLines_ListByCommunicationsGateway.json | 28 + .../2023-09-01/examples/TestLines_Update.json | 28 + .../stable/2023-09-01/voiceservices.json | 1617 +++++++++++++++++ .../voiceservices/resource-manager/readme.md | 11 +- 15 files changed, 2421 insertions(+), 1 deletion(-) create mode 100644 specification/voiceservices/resource-manager/Microsoft.VoiceServices/stable/2023-09-01/examples/CommunicationsGateways_CreateOrUpdate.json create mode 100644 specification/voiceservices/resource-manager/Microsoft.VoiceServices/stable/2023-09-01/examples/CommunicationsGateways_Delete.json create mode 100644 specification/voiceservices/resource-manager/Microsoft.VoiceServices/stable/2023-09-01/examples/CommunicationsGateways_Get.json create mode 100644 specification/voiceservices/resource-manager/Microsoft.VoiceServices/stable/2023-09-01/examples/CommunicationsGateways_ListByResourceGroup.json create mode 100644 specification/voiceservices/resource-manager/Microsoft.VoiceServices/stable/2023-09-01/examples/CommunicationsGateways_ListBySubscription.json create mode 100644 specification/voiceservices/resource-manager/Microsoft.VoiceServices/stable/2023-09-01/examples/CommunicationsGateways_Update.json create mode 100644 specification/voiceservices/resource-manager/Microsoft.VoiceServices/stable/2023-09-01/examples/NameAvailability_CheckLocal.json create mode 100644 specification/voiceservices/resource-manager/Microsoft.VoiceServices/stable/2023-09-01/examples/Operations_List.json create mode 100644 specification/voiceservices/resource-manager/Microsoft.VoiceServices/stable/2023-09-01/examples/TestLines_CreateOrUpdate.json create mode 100644 specification/voiceservices/resource-manager/Microsoft.VoiceServices/stable/2023-09-01/examples/TestLines_Delete.json create mode 100644 specification/voiceservices/resource-manager/Microsoft.VoiceServices/stable/2023-09-01/examples/TestLines_Get.json create mode 100644 specification/voiceservices/resource-manager/Microsoft.VoiceServices/stable/2023-09-01/examples/TestLines_ListByCommunicationsGateway.json create mode 100644 specification/voiceservices/resource-manager/Microsoft.VoiceServices/stable/2023-09-01/examples/TestLines_Update.json create mode 100644 specification/voiceservices/resource-manager/Microsoft.VoiceServices/stable/2023-09-01/voiceservices.json diff --git a/specification/voiceservices/resource-manager/Microsoft.VoiceServices/stable/2023-09-01/examples/CommunicationsGateways_CreateOrUpdate.json b/specification/voiceservices/resource-manager/Microsoft.VoiceServices/stable/2023-09-01/examples/CommunicationsGateways_CreateOrUpdate.json new file mode 100644 index 000000000000..f3ff7fb7be50 --- /dev/null +++ b/specification/voiceservices/resource-manager/Microsoft.VoiceServices/stable/2023-09-01/examples/CommunicationsGateways_CreateOrUpdate.json @@ -0,0 +1,234 @@ +{ + "operationId": "CommunicationsGateways_CreateOrUpdate", + "title": "CreateCommunicationsGatewayResource", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testrg", + "api-version": "2023-09-01", + "name": "myname", + "communicationsGatewayName": "myname", + "resource": { + "location": "useast", + "sku": { + "name": "standard" + }, + "properties": { + "serviceLocations": [ + { + "name": "useast", + "primaryRegionProperties": { + "operatorAddresses": [ + "198.51.100.1" + ], + "allowedSignalingSourceAddressPrefixes": [ + "10.1.1.0/24" + ], + "allowedMediaSourceAddressPrefixes": [ + "10.1.2.0/24" + ] + } + }, + { + "name": "useast2", + "primaryRegionProperties": { + "operatorAddresses": [ + "198.51.100.2" + ], + "allowedSignalingSourceAddressPrefixes": [ + "10.2.1.0/24" + ], + "allowedMediaSourceAddressPrefixes": [ + "10.2.2.0/24" + ] + } + } + ], + "connectivity": "PublicAddress", + "codecs": [ + "PCMA" + ], + "e911Type": "Standard", + "platforms": [ + "OperatorConnect", + "TeamsDirectRouting" + ], + "autoGeneratedDomainNameLabelScope": "NoReuse", + "teamsVoicemailPilotNumber": "1234567890", + "apiBridge": { + "configureApiBridge": "enabled", + "allowedAddressPrefixes": [ + "198.51.100.192/26" + ] + }, + "dnsDelegations": { + "delegations": [ + { + "domain": "commsgw.contoso.com" + } + ] + }, + "customSipHeaders": { + "headers": [ + { + "name": "x-contoso-commsgw-identifier" + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.VoiceServices/communicationsGateways/myname", + "name": "myname", + "type": "Microsoft.VoiceServices/communicationsGateways", + "location": "useast", + "sku": { + "name": "standard" + }, + "properties": { + "serviceLocations": [ + { + "name": "useast", + "primaryRegionProperties": { + "operatorAddresses": [ + "198.51.100.1" + ], + "allowedSignalingSourceAddressPrefixes": [ + "10.1.1.0/24" + ], + "allowedMediaSourceAddressPrefixes": [ + "10.1.2.0/24" + ] + } + }, + { + "name": "useast2", + "primaryRegionProperties": { + "operatorAddresses": [ + "198.51.100.2" + ], + "allowedSignalingSourceAddressPrefixes": [ + "10.2.1.0/24" + ], + "allowedMediaSourceAddressPrefixes": [ + "10.2.2.0/24" + ] + } + } + ], + "status": "ChangePending", + "connectivity": "PublicAddress", + "codecs": [ + "PCMA" + ], + "e911Type": "Standard", + "platforms": [ + "OperatorConnect", + "TeamsDirectRouting" + ], + "autoGeneratedDomainNameLabelScope": "NoReuse", + "autoGeneratedDomainNameLabel": "somelabel", + "teamsVoicemailPilotNumber": "1234567890", + "apiBridge": { + "configureApiBridge": "enabled", + "allowedAddressPrefixes": [ + "198.51.100.192/26" + ] + }, + "dnsDelegations": { + "delegations": [ + { + "domain": "commsgw.contoso.com" + } + ] + }, + "customSipHeaders": { + "headers": [ + { + "name": "x-contoso-commsgw-identifier" + } + ] + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.VoiceServices/communicationsGateways/myname", + "name": "myname", + "type": "Microsoft.VoiceServices/communicationsGateways", + "location": "useast", + "sku": { + "name": "standard" + }, + "properties": { + "status": "ChangePending", + "serviceLocations": [ + { + "name": "useast", + "primaryRegionProperties": { + "operatorAddresses": [ + "198.51.100.1" + ], + "allowedSignalingSourceAddressPrefixes": [ + "10.1.1.0/24" + ], + "allowedMediaSourceAddressPrefixes": [ + "10.1.2.0/24" + ] + } + }, + { + "name": "useast2", + "primaryRegionProperties": { + "operatorAddresses": [ + "198.51.100.2" + ], + "allowedSignalingSourceAddressPrefixes": [ + "10.2.1.0/24" + ], + "allowedMediaSourceAddressPrefixes": [ + "10.2.2.0/24" + ] + } + } + ], + "connectivity": "PublicAddress", + "codecs": [ + "PCMA" + ], + "e911Type": "Standard", + "platforms": [ + "OperatorConnect", + "TeamsDirectRouting" + ], + "autoGeneratedDomainNameLabelScope": "NoReuse", + "autoGeneratedDomainNameLabel": "somelabel", + "teamsVoicemailPilotNumber": "1234567890", + "apiBridge": { + "configureApiBridge": "enabled", + "allowedAddressPrefixes": [ + "198.51.100.192/26" + ] + }, + "dnsDelegations": { + "delegations": [ + { + "domain": "commsgw.contoso.com" + } + ] + }, + "customSipHeaders": { + "headers": [ + { + "name": "x-contoso-commsgw-identifier" + } + ] + } + } + } + } + } +} diff --git a/specification/voiceservices/resource-manager/Microsoft.VoiceServices/stable/2023-09-01/examples/CommunicationsGateways_Delete.json b/specification/voiceservices/resource-manager/Microsoft.VoiceServices/stable/2023-09-01/examples/CommunicationsGateways_Delete.json new file mode 100644 index 000000000000..140134bde98a --- /dev/null +++ b/specification/voiceservices/resource-manager/Microsoft.VoiceServices/stable/2023-09-01/examples/CommunicationsGateways_Delete.json @@ -0,0 +1,20 @@ +{ + "operationId": "CommunicationsGateways_Delete", + "title": "DeleteCommunicationsGatewayResource", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testrg", + "api-version": "2023-09-01", + "communicationsGatewayName": "myname", + "location": "useast" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": {} + } +} diff --git a/specification/voiceservices/resource-manager/Microsoft.VoiceServices/stable/2023-09-01/examples/CommunicationsGateways_Get.json b/specification/voiceservices/resource-manager/Microsoft.VoiceServices/stable/2023-09-01/examples/CommunicationsGateways_Get.json new file mode 100644 index 000000000000..d8e154ddb80d --- /dev/null +++ b/specification/voiceservices/resource-manager/Microsoft.VoiceServices/stable/2023-09-01/examples/CommunicationsGateways_Get.json @@ -0,0 +1,102 @@ +{ + "operationId": "CommunicationsGateways_Get", + "title": "GetCommunicationsGatewayResource", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testrg", + "api-version": "2023-09-01", + "name": "myname", + "communicationsGatewayName": "myname" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.VoiceService/communicationsGateways/myname", + "name": "myname", + "location": "useast", + "type": "Microsoft.VoiceService/communicationsGateways", + "sku": { + "name": "standard" + }, + "properties": { + "status": "ChangePending", + "serviceLocations": [ + { + "name": "useast", + "primaryRegionProperties": { + "operatorAddresses": [ + "198.51.100.1" + ], + "allowedSignalingSourceAddressPrefixes": [ + "10.1.1.0/24" + ], + "allowedMediaSourceAddressPrefixes": [ + "10.1.2.0/24" + ] + } + }, + { + "name": "useast2", + "primaryRegionProperties": { + "operatorAddresses": [ + "198.51.100.2" + ], + "allowedSignalingSourceAddressPrefixes": [ + "10.2.1.0/24" + ], + "allowedMediaSourceAddressPrefixes": [ + "10.2.2.0/24" + ] + } + } + ], + "connectivity": "PublicAddress", + "codecs": [ + "PCMA" + ], + "e911Type": "Standard", + "platforms": [ + "OperatorConnect", + "TeamsDirectRouting" + ], + "autoGeneratedDomainNameLabelScope": "NoReuse", + "autoGeneratedDomainNameLabel": "somelabel", + "teamsVoicemailPilotNumber": "1234567890", + "apiBridge": { + "configureApiBridge": "enabled", + "endpointFqdns": [ + "ap2.hash.commsgw.net" + ], + "allowedAddressPrefixes": [ + "198.51.100.192/26" + ] + }, + "dnsDelegations": { + "delegations": [ + { + "domain": "commsgw.contoso.com", + "nameServers": [ + "1.2.3.4", + "2.3.4.5" + ] + } + ] + }, + "customSipHeaders": { + "headers": [ + { + "name": "x-contoso-commsgw-identifier" + } + ] + }, + "allocatedSignalingAddressPrefixes": [ + "203.0.113.0/26" + ], + "allocatedMediaAddressPrefixes": [ + "203.0.113.64/26" + ] + } + } + } + } +} diff --git a/specification/voiceservices/resource-manager/Microsoft.VoiceServices/stable/2023-09-01/examples/CommunicationsGateways_ListByResourceGroup.json b/specification/voiceservices/resource-manager/Microsoft.VoiceServices/stable/2023-09-01/examples/CommunicationsGateways_ListByResourceGroup.json new file mode 100644 index 000000000000..d1170418c717 --- /dev/null +++ b/specification/voiceservices/resource-manager/Microsoft.VoiceServices/stable/2023-09-01/examples/CommunicationsGateways_ListByResourceGroup.json @@ -0,0 +1,70 @@ +{ + "operationId": "CommunicationsGateways_ListByResourceGroup", + "title": "ListCommunicationsGatewayResource", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testrg", + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.VoiceService/communicationsGateways/myname", + "name": "myname", + "location": "useast", + "type": "Microsoft.VoiceService/communicationsGateways", + "sku": { + "name": "standard" + }, + "properties": { + "status": "ChangePending", + "serviceLocations": [ + { + "name": "useast", + "primaryRegionProperties": { + "operatorAddresses": [ + "198.51.100.1" + ], + "allowedSignalingSourceAddressPrefixes": [ + "10.1.1.0/24" + ], + "allowedMediaSourceAddressPrefixes": [ + "10.1.2.0/24" + ] + } + }, + { + "name": "useast2", + "primaryRegionProperties": { + "operatorAddresses": [ + "198.51.100.2" + ], + "allowedSignalingSourceAddressPrefixes": [ + "10.2.1.0/24" + ], + "allowedMediaSourceAddressPrefixes": [ + "10.2.2.0/24" + ] + } + } + ], + "connectivity": "PublicAddress", + "codecs": [ + "PCMA" + ], + "e911Type": "Standard", + "platforms": [ + "OperatorConnect" + ], + "autoGeneratedDomainNameLabelScope": "NoReuse", + "autoGeneratedDomainNameLabel": "somelabel", + "teamsVoicemailPilotNumber": "1234567890" + } + } + ] + } + } + } +} diff --git a/specification/voiceservices/resource-manager/Microsoft.VoiceServices/stable/2023-09-01/examples/CommunicationsGateways_ListBySubscription.json b/specification/voiceservices/resource-manager/Microsoft.VoiceServices/stable/2023-09-01/examples/CommunicationsGateways_ListBySubscription.json new file mode 100644 index 000000000000..745f3c2fb178 --- /dev/null +++ b/specification/voiceservices/resource-manager/Microsoft.VoiceServices/stable/2023-09-01/examples/CommunicationsGateways_ListBySubscription.json @@ -0,0 +1,69 @@ +{ + "operationId": "CommunicationsGateways_ListBySubscription", + "title": "ListCommunicationsGatewayResourceSub", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.VoiceService/communicationsGateways/myname", + "name": "myname", + "location": "useast", + "type": "Microsoft.VoiceService/communicationsGateways", + "sku": { + "name": "standard" + }, + "properties": { + "status": "ChangePending", + "serviceLocations": [ + { + "name": "useast", + "primaryRegionProperties": { + "operatorAddresses": [ + "198.51.100.1" + ], + "allowedSignalingSourceAddressPrefixes": [ + "10.1.1.0/24" + ], + "allowedMediaSourceAddressPrefixes": [ + "10.1.2.0/24" + ] + } + }, + { + "name": "useast2", + "primaryRegionProperties": { + "operatorAddresses": [ + "198.51.100.2" + ], + "allowedSignalingSourceAddressPrefixes": [ + "10.2.1.0/24" + ], + "allowedMediaSourceAddressPrefixes": [ + "10.2.2.0/24" + ] + } + } + ], + "connectivity": "PublicAddress", + "codecs": [ + "PCMA" + ], + "e911Type": "Standard", + "platforms": [ + "OperatorConnect" + ], + "autoGeneratedDomainNameLabelScope": "NoReuse", + "autoGeneratedDomainNameLabel": "somelabel", + "teamsVoicemailPilotNumber": "1234567890" + } + } + ] + } + } + } +} diff --git a/specification/voiceservices/resource-manager/Microsoft.VoiceServices/stable/2023-09-01/examples/CommunicationsGateways_Update.json b/specification/voiceservices/resource-manager/Microsoft.VoiceServices/stable/2023-09-01/examples/CommunicationsGateways_Update.json new file mode 100644 index 000000000000..ad2b6fb69f2a --- /dev/null +++ b/specification/voiceservices/resource-manager/Microsoft.VoiceServices/stable/2023-09-01/examples/CommunicationsGateways_Update.json @@ -0,0 +1,103 @@ +{ + "operationId": "CommunicationsGateways_Update", + "title": "UpdateCommunicationsGatewayResource", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testrg", + "api-version": "2023-09-01", + "communicationsGatewayName": "myname", + "location": "useast", + "properties": {} + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.VoiceServices/communicationsGateways/myname", + "name": "myname", + "type": "Microsoft.VoiceServices/communicationsGateways", + "location": "useast", + "sku": { + "name": "standard" + }, + "properties": { + "status": "ChangePending", + "serviceLocations": [ + { + "name": "useast", + "primaryRegionProperties": { + "operatorAddresses": [ + "198.51.100.1" + ], + "allowedSignalingSourceAddressPrefixes": [ + "10.1.1.0/24" + ], + "allowedMediaSourceAddressPrefixes": [ + "10.1.2.0/24" + ] + } + }, + { + "name": "useast2", + "primaryRegionProperties": { + "operatorAddresses": [ + "198.51.100.2" + ], + "allowedSignalingSourceAddressPrefixes": [ + "10.2.1.0/24" + ], + "allowedMediaSourceAddressPrefixes": [ + "10.2.2.0/24" + ] + } + } + ], + "connectivity": "PublicAddress", + "codecs": [ + "PCMA" + ], + "e911Type": "Standard", + "platforms": [ + "OperatorConnect", + "TeamsDirectRouting" + ], + "autoGeneratedDomainNameLabelScope": "NoReuse", + "autoGeneratedDomainNameLabel": "somelabel", + "teamsVoicemailPilotNumber": "1234567890", + "apiBridge": { + "configureApiBridge": "enabled", + "endpointFqdns": [ + "ap2.hash.commsgw.net" + ], + "allowedAddressPrefixes": [ + "198.51.100.192/26" + ] + }, + "dnsDelegations": { + "delegations": [ + { + "domain": "commsgw.contoso.com", + "nameServers": [ + "1.2.3.4", + "2.3.4.5" + ] + } + ] + }, + "customSipHeaders": { + "headers": [ + { + "name": "x-contoso-commsgw-identifier" + } + ] + }, + "allocatedSignalingAddressPrefixes": [ + "203.0.113.0/26" + ], + "allocatedMediaAddressPrefixes": [ + "203.0.113.64/26" + ] + } + } + } + } +} diff --git a/specification/voiceservices/resource-manager/Microsoft.VoiceServices/stable/2023-09-01/examples/NameAvailability_CheckLocal.json b/specification/voiceservices/resource-manager/Microsoft.VoiceServices/stable/2023-09-01/examples/NameAvailability_CheckLocal.json new file mode 100644 index 000000000000..f42ec4046699 --- /dev/null +++ b/specification/voiceservices/resource-manager/Microsoft.VoiceServices/stable/2023-09-01/examples/NameAvailability_CheckLocal.json @@ -0,0 +1,22 @@ +{ + "operationId": "NameAvailability_CheckLocal", + "title": "CheckLocalNameAvailability", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-09-01", + "location": "useast", + "body": { + "name": "myname", + "type": "Microsoft.VoiceServices/CommunicationsGateways" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": false, + "reason": "AlreadyExists", + "message": "Some error string" + } + } + } +} diff --git a/specification/voiceservices/resource-manager/Microsoft.VoiceServices/stable/2023-09-01/examples/Operations_List.json b/specification/voiceservices/resource-manager/Microsoft.VoiceServices/stable/2023-09-01/examples/Operations_List.json new file mode 100644 index 000000000000..8decc63d2b97 --- /dev/null +++ b/specification/voiceservices/resource-manager/Microsoft.VoiceServices/stable/2023-09-01/examples/Operations_List.json @@ -0,0 +1,25 @@ +{ + "operationId": "Operations_List", + "title": "OperationsList", + "parameters": { + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.VoiceService/communicationsGateways/write", + "display": { + "provider": "Microsoft.VoiceService", + "resource": "communicationsGateways", + "operation": "write", + "description": "Write communicationsGateways resource" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/voiceservices/resource-manager/Microsoft.VoiceServices/stable/2023-09-01/examples/TestLines_CreateOrUpdate.json b/specification/voiceservices/resource-manager/Microsoft.VoiceServices/stable/2023-09-01/examples/TestLines_CreateOrUpdate.json new file mode 100644 index 000000000000..212165420bc7 --- /dev/null +++ b/specification/voiceservices/resource-manager/Microsoft.VoiceServices/stable/2023-09-01/examples/TestLines_CreateOrUpdate.json @@ -0,0 +1,45 @@ +{ + "operationId": "TestLines_CreateOrUpdate", + "title": "CreateTestLineResource", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testrg", + "api-version": "2023-09-01", + "name": "myline", + "testLineName": "myline", + "communicationsGatewayName": "myname", + "resource": { + "location": "useast", + "properties": { + "phoneNumber": "+1-555-1234", + "purpose": "Automated" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.VoiceServices/communicationsGateways/myname/TestLines/myline", + "name": "myline", + "location": "useast", + "type": "Microsoft.VoiceServices/communicationsGateways/testLines", + "properties": { + "phoneNumber": "+1-555-1234", + "purpose": "Automated" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.VoiceServices/communicationsGateways/myname/TestLines/myline", + "name": "myline", + "location": "useast", + "type": "Microsoft.VoiceServices/communicationsGateways/testLines", + "properties": { + "phoneNumber": "+1-555-1234", + "purpose": "Automated" + } + } + } + } +} diff --git a/specification/voiceservices/resource-manager/Microsoft.VoiceServices/stable/2023-09-01/examples/TestLines_Delete.json b/specification/voiceservices/resource-manager/Microsoft.VoiceServices/stable/2023-09-01/examples/TestLines_Delete.json new file mode 100644 index 000000000000..ef86e7f1869c --- /dev/null +++ b/specification/voiceservices/resource-manager/Microsoft.VoiceServices/stable/2023-09-01/examples/TestLines_Delete.json @@ -0,0 +1,22 @@ +{ + "operationId": "TestLines_Delete", + "title": "DeleteTestLineResource", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testrg", + "api-version": "2023-09-01", + "name": "myline", + "testLineName": "myline", + "communicationsGatewayName": "myname", + "location": "useast" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": {} + } +} diff --git a/specification/voiceservices/resource-manager/Microsoft.VoiceServices/stable/2023-09-01/examples/TestLines_Get.json b/specification/voiceservices/resource-manager/Microsoft.VoiceServices/stable/2023-09-01/examples/TestLines_Get.json new file mode 100644 index 000000000000..a60ec021b4d8 --- /dev/null +++ b/specification/voiceservices/resource-manager/Microsoft.VoiceServices/stable/2023-09-01/examples/TestLines_Get.json @@ -0,0 +1,26 @@ +{ + "operationId": "TestLines_Get", + "title": "GetTestLineResource", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testrg", + "api-version": "2023-09-01", + "name": "myline", + "testLineName": "myline", + "communicationsGatewayName": "myname" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.VoiceServices/communicationsGateways/myname/TestLines/myline", + "name": "myline", + "type": "Microsoft.VoiceServices/communicationsGateways/testLines", + "location": "useast", + "properties": { + "phoneNumber": "+1-555-1234", + "purpose": "Automated" + } + } + } + } +} diff --git a/specification/voiceservices/resource-manager/Microsoft.VoiceServices/stable/2023-09-01/examples/TestLines_ListByCommunicationsGateway.json b/specification/voiceservices/resource-manager/Microsoft.VoiceServices/stable/2023-09-01/examples/TestLines_ListByCommunicationsGateway.json new file mode 100644 index 000000000000..0226f790fe71 --- /dev/null +++ b/specification/voiceservices/resource-manager/Microsoft.VoiceServices/stable/2023-09-01/examples/TestLines_ListByCommunicationsGateway.json @@ -0,0 +1,28 @@ +{ + "operationId": "TestLines_ListByCommunicationsGateway", + "title": "ListTestLineResource", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testrg", + "api-version": "2023-09-01", + "communicationsGatewayName": "myname" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.VoiceServices/communicationsGateways/myname/TestLines/myline", + "name": "myline", + "type": "Microsoft.VoiceServices/communicationsGateways/testLines", + "location": "useast", + "properties": { + "phoneNumber": "+1-555-1234", + "purpose": "Automated" + } + } + ] + } + } + } +} diff --git a/specification/voiceservices/resource-manager/Microsoft.VoiceServices/stable/2023-09-01/examples/TestLines_Update.json b/specification/voiceservices/resource-manager/Microsoft.VoiceServices/stable/2023-09-01/examples/TestLines_Update.json new file mode 100644 index 000000000000..b29dd42c9c6b --- /dev/null +++ b/specification/voiceservices/resource-manager/Microsoft.VoiceServices/stable/2023-09-01/examples/TestLines_Update.json @@ -0,0 +1,28 @@ +{ + "operationId": "TestLines_Update", + "title": "UpdateTestLineResource", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testrg", + "api-version": "2023-09-01", + "name": "myline", + "testLineName": "myline", + "communicationsGatewayName": "myname", + "location": "useast", + "properties": {} + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.VoiceServices/communicationsGateways/myname/TestLines/myline", + "name": "myline", + "location": "useast", + "type": "Microsoft.VoiceServices/communicationsGateways/testLines", + "properties": { + "phoneNumber": "+1-555-1234", + "purpose": "Automated" + } + } + } + } +} diff --git a/specification/voiceservices/resource-manager/Microsoft.VoiceServices/stable/2023-09-01/voiceservices.json b/specification/voiceservices/resource-manager/Microsoft.VoiceServices/stable/2023-09-01/voiceservices.json new file mode 100644 index 000000000000..76af78f0eb18 --- /dev/null +++ b/specification/voiceservices/resource-manager/Microsoft.VoiceServices/stable/2023-09-01/voiceservices.json @@ -0,0 +1,1617 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.VoiceServices", + "version": "2023-09-01", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "Operations" + }, + { + "name": "TestLines" + }, + { + "name": "CommunicationsGateways" + } + ], + "paths": { + "/providers/Microsoft.VoiceServices/operations": { + "get": { + "operationId": "Operations_List", + "tags": [ + "Operations" + ], + "description": "List the operations for the provider", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "OperationsList": { + "$ref": "./examples/Operations_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.VoiceServices/communicationsGateways": { + "get": { + "operationId": "CommunicationsGateways_ListBySubscription", + "tags": [ + "CommunicationsGateways" + ], + "description": "List CommunicationsGateway resources by subscription ID", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommunicationsGatewayListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListCommunicationsGatewayResourceSub": { + "$ref": "./examples/CommunicationsGateways_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.VoiceServices/locations/{location}/checkNameAvailability": { + "post": { + "operationId": "NameAvailability_CheckLocal", + "description": "Check whether the resource name is available in the given region.", + "parameters": [ + { + "name": "location", + "in": "path", + "description": "The location in which uniqueness will be verified.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "in": "body", + "description": "The check availability request body.", + "required": true, + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityRequest" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CheckLocalNameAvailability": { + "$ref": "./examples/NameAvailability_CheckLocal.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VoiceServices/communicationsGateways": { + "get": { + "operationId": "CommunicationsGateways_ListByResourceGroup", + "tags": [ + "CommunicationsGateways" + ], + "description": "List CommunicationsGateway resources by resource group", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommunicationsGatewayListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListCommunicationsGatewayResource": { + "$ref": "./examples/CommunicationsGateways_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VoiceServices/communicationsGateways/{communicationsGatewayName}": { + "get": { + "operationId": "CommunicationsGateways_Get", + "tags": [ + "CommunicationsGateways" + ], + "description": "Get a CommunicationsGateway", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "communicationsGatewayName", + "in": "path", + "description": "Unique identifier for this deployment", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommunicationsGateway" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetCommunicationsGatewayResource": { + "$ref": "./examples/CommunicationsGateways_Get.json" + } + } + }, + "put": { + "operationId": "CommunicationsGateways_CreateOrUpdate", + "tags": [ + "CommunicationsGateways" + ], + "description": "Create a CommunicationsGateway", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "communicationsGatewayName", + "in": "path", + "description": "Unique identifier for this deployment", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/CommunicationsGateway" + } + } + ], + "responses": { + "200": { + "description": "Resource 'CommunicationsGateway' update operation succeeded", + "schema": { + "$ref": "#/definitions/CommunicationsGateway" + } + }, + "201": { + "description": "Resource 'CommunicationsGateway' create operation succeeded", + "schema": { + "$ref": "#/definitions/CommunicationsGateway" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateCommunicationsGatewayResource": { + "$ref": "./examples/CommunicationsGateways_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "CommunicationsGateways_Update", + "tags": [ + "CommunicationsGateways" + ], + "description": "Update a CommunicationsGateway", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "communicationsGatewayName", + "in": "path", + "description": "Unique identifier for this deployment", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/CommunicationsGatewayUpdate" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommunicationsGateway" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "UpdateCommunicationsGatewayResource": { + "$ref": "./examples/CommunicationsGateways_Update.json" + } + } + }, + "delete": { + "operationId": "CommunicationsGateways_Delete", + "tags": [ + "CommunicationsGateways" + ], + "description": "Delete a CommunicationsGateway", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "communicationsGatewayName", + "in": "path", + "description": "Unique identifier for this deployment", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DeleteCommunicationsGatewayResource": { + "$ref": "./examples/CommunicationsGateways_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VoiceServices/communicationsGateways/{communicationsGatewayName}/testLines": { + "get": { + "operationId": "TestLines_ListByCommunicationsGateway", + "tags": [ + "TestLines" + ], + "description": "List TestLine resources by CommunicationsGateway", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "communicationsGatewayName", + "in": "path", + "description": "Unique identifier for this deployment", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/TestLineListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListTestLineResource": { + "$ref": "./examples/TestLines_ListByCommunicationsGateway.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VoiceServices/communicationsGateways/{communicationsGatewayName}/testLines/{testLineName}": { + "get": { + "operationId": "TestLines_Get", + "tags": [ + "TestLines" + ], + "description": "Get a TestLine", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "communicationsGatewayName", + "in": "path", + "description": "Unique identifier for this deployment", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "testLineName", + "in": "path", + "description": "Unique identifier for this test line", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/TestLine" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetTestLineResource": { + "$ref": "./examples/TestLines_Get.json" + } + } + }, + "put": { + "operationId": "TestLines_CreateOrUpdate", + "tags": [ + "TestLines" + ], + "description": "Create a TestLine", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "communicationsGatewayName", + "in": "path", + "description": "Unique identifier for this deployment", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "testLineName", + "in": "path", + "description": "Unique identifier for this test line", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/TestLine" + } + } + ], + "responses": { + "200": { + "description": "Resource 'TestLine' update operation succeeded", + "schema": { + "$ref": "#/definitions/TestLine" + } + }, + "201": { + "description": "Resource 'TestLine' create operation succeeded", + "schema": { + "$ref": "#/definitions/TestLine" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateTestLineResource": { + "$ref": "./examples/TestLines_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "TestLines_Update", + "tags": [ + "TestLines" + ], + "description": "Update a TestLine", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "communicationsGatewayName", + "in": "path", + "description": "Unique identifier for this deployment", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "testLineName", + "in": "path", + "description": "Unique identifier for this test line", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/TestLineUpdate" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/TestLine" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "UpdateTestLineResource": { + "$ref": "./examples/TestLines_Update.json" + } + } + }, + "delete": { + "operationId": "TestLines_Delete", + "tags": [ + "TestLines" + ], + "description": "Delete a TestLine", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "communicationsGatewayName", + "in": "path", + "description": "Unique identifier for this deployment", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "testLineName", + "in": "path", + "description": "Unique identifier for this test line", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DeleteTestLineResource": { + "$ref": "./examples/TestLines_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "ApiBridgeActivationState": { + "type": "string", + "description": "API Bridge activation state.", + "enum": [ + "enabled", + "disabled" + ], + "x-ms-enum": { + "name": "ApiBridgeActivationState", + "modelAsString": true, + "values": [ + { + "name": "enabled", + "value": "enabled", + "description": "API Bridge is enabled" + }, + { + "name": "disabled", + "value": "disabled", + "description": "API Bridge is disabled" + } + ] + } + }, + "ApiBridgeProperties": { + "type": "object", + "description": "Configuration of the API Bridge.", + "properties": { + "configureApiBridge": { + "$ref": "#/definitions/ApiBridgeActivationState", + "description": "The activation state of the API Bridge for this Communications Gateway", + "default": "disabled", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "endpointFqdns": { + "type": "array", + "description": "FQDNs for sending requests to the API Bridge endpoint", + "items": { + "type": "string" + }, + "readOnly": true + }, + "allowedAddressPrefixes": { + "type": "array", + "description": "The allowed source IP addresses or CIDR ranges for accessing the API Bridge", + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + } + } + }, + "AutoGeneratedDomainNameLabelScope": { + "type": "string", + "description": "Available auto-generated domain name scopes.", + "enum": [ + "TenantReuse", + "SubscriptionReuse", + "ResourceGroupReuse", + "NoReuse" + ], + "x-ms-enum": { + "name": "AutoGeneratedDomainNameLabelScope", + "modelAsString": true, + "values": [ + { + "name": "TenantReuse", + "value": "TenantReuse", + "description": "Generated domain name label depends on resource name and tenant ID." + }, + { + "name": "SubscriptionReuse", + "value": "SubscriptionReuse", + "description": "Generated domain name label depends on resource name, tenant ID and subscription ID." + }, + { + "name": "ResourceGroupReuse", + "value": "ResourceGroupReuse", + "description": "Generated domain name label depends on resource name, tenant ID, subscription ID and resource group name." + }, + { + "name": "NoReuse", + "value": "NoReuse", + "description": "Generated domain name label is always unique." + } + ] + } + }, + "CheckNameAvailabilityReason": { + "type": "string", + "description": "Possible reasons for a name not being available.", + "enum": [ + "Invalid", + "AlreadyExists" + ], + "x-ms-enum": { + "name": "CheckNameAvailabilityReason", + "modelAsString": true + } + }, + "CheckNameAvailabilityRequest": { + "type": "object", + "description": "The check availability request body.", + "properties": { + "name": { + "type": "string", + "description": "The name of the resource for which availability needs to be checked." + }, + "type": { + "type": "string", + "description": "The resource type." + } + } + }, + "CheckNameAvailabilityResponse": { + "type": "object", + "description": "The check availability result.", + "properties": { + "nameAvailable": { + "type": "boolean", + "description": "Indicates if the resource name is available." + }, + "reason": { + "$ref": "#/definitions/CheckNameAvailabilityReason", + "description": "The reason why the given name is not available." + }, + "message": { + "type": "string", + "description": "Detailed reason why the given name is not available." + } + } + }, + "CommunicationsGateway": { + "type": "object", + "description": "A CommunicationsGateway resource", + "properties": { + "properties": { + "$ref": "#/definitions/CommunicationsGatewayProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "identity": { + "$ref": "../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The managed service identities assigned to this resource." + }, + "sku": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Sku", + "description": "The SKU (Stock Keeping Unit) assigned to this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ] + }, + "CommunicationsGatewayListResult": { + "type": "object", + "description": "The response of a CommunicationsGateway list operation.", + "properties": { + "value": { + "type": "array", + "description": "The CommunicationsGateway items on this page", + "items": { + "$ref": "#/definitions/CommunicationsGateway" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "CommunicationsGatewayProperties": { + "type": "object", + "description": "Details of the CommunicationsGateway resource.", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Resource provisioning state.", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/Status", + "description": "The current status of the deployment.", + "readOnly": true + }, + "serviceLocations": { + "type": "array", + "description": "The regions in which to deploy the resources needed for Teams Calling", + "items": { + "$ref": "#/definitions/ServiceRegionProperties" + }, + "x-ms-identifiers": [ + "name" + ], + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "connectivity": { + "$ref": "#/definitions/Connectivity", + "description": "How to connect back to the operator network, e.g. MAPS", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "codecs": { + "type": "array", + "description": "Voice codecs to support", + "items": { + "$ref": "#/definitions/TeamsCodecs" + }, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "e911Type": { + "$ref": "#/definitions/E911Type", + "description": "How to handle 911 calls", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "platforms": { + "type": "array", + "description": "What platforms to support", + "minItems": 1, + "items": { + "$ref": "#/definitions/CommunicationsPlatform" + }, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "apiBridge": { + "$ref": "#/definitions/ApiBridgeProperties", + "description": "Details of API bridge functionality, if required", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "autoGeneratedDomainNameLabelScope": { + "$ref": "#/definitions/AutoGeneratedDomainNameLabelScope", + "description": "The scope at which the auto-generated domain name can be re-used", + "default": "TenantReuse", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "autoGeneratedDomainNameLabel": { + "type": "string", + "description": "The autogenerated label used as part of the FQDNs for accessing the Communications Gateway", + "readOnly": true + }, + "teamsVoicemailPilotNumber": { + "type": "string", + "description": "This number is used in Teams Phone Mobile scenarios for access to the voicemail IVR from the native dialer.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "onPremMcpEnabled": { + "type": "boolean", + "description": "Whether an on-premises Mobile Control Point is in use.", + "default": false, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "integratedMcpEnabled": { + "type": "boolean", + "description": "Whether an integrated Mobile Control Point is in use.", + "default": false, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "emergencyDialStrings": { + "type": "array", + "description": "A list of dial strings used for emergency calling.", + "default": [ + "911", + "933" + ], + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "dnsDelegations": { + "$ref": "#/definitions/DnsDelegationsProperties", + "description": "Details of DNS Domains to delegate to the Communications Gateway.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "customSipHeaders": { + "$ref": "#/definitions/CustomSipHeadersProperties", + "description": "Custom SIP Header to add to any subscriber with a custom_header value, if required.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "allocatedSignalingAddressPrefixes": { + "type": "array", + "description": "A list of IP allocated prefixes which may be used to receive signaling data from this Communications Gateway.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "allocatedMediaAddressPrefixes": { + "type": "array", + "description": "A list of allocated IP prefixes which may be used to receive media data from this Communications Gateway.", + "items": { + "type": "string" + }, + "readOnly": true + } + }, + "required": [ + "serviceLocations", + "connectivity", + "codecs", + "e911Type", + "platforms" + ] + }, + "CommunicationsGatewayUpdate": { + "type": "object", + "description": "The type used for update operations of the CommunicationsGateway.", + "properties": { + "identity": { + "$ref": "../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The managed service identities assigned to this resource." + }, + "sku": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Sku", + "description": "The SKU (Stock Keeping Unit) assigned to this resource." + }, + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "CommunicationsPlatform": { + "type": "string", + "description": "Available platform types.", + "enum": [ + "OperatorConnect", + "TeamsPhoneMobile", + "TeamsDirectRouting" + ], + "x-ms-enum": { + "name": "CommunicationsPlatform", + "modelAsString": true, + "values": [ + { + "name": "OperatorConnect", + "value": "OperatorConnect", + "description": "Operator Connect" + }, + { + "name": "TeamsPhoneMobile", + "value": "TeamsPhoneMobile", + "description": "Teams Phone Mobile" + }, + { + "name": "TeamsDirectRouting", + "value": "TeamsDirectRouting", + "description": "Teams Direct Routing" + } + ] + } + }, + "Connectivity": { + "type": "string", + "description": "How this deployment connects back to the operator network", + "enum": [ + "PublicAddress" + ], + "x-ms-enum": { + "name": "Connectivity", + "modelAsString": true, + "values": [ + { + "name": "PublicAddress", + "value": "PublicAddress", + "description": "This deployment connects to the operator network using a Public IP address, e.g. when using MAPS" + } + ] + } + }, + "CustomSipHeader": { + "type": "object", + "description": "Details of a Custom SIP Header.", + "properties": { + "name": { + "type": "string", + "description": "The name of the Custom SIP Header", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + } + } + }, + "CustomSipHeadersProperties": { + "type": "object", + "description": "Properties of Custom SIP Headers.", + "properties": { + "headers": { + "type": "array", + "description": "The Custom SIP Headers to apply to the calls which traverse the Communications Gateway", + "items": { + "$ref": "#/definitions/CustomSipHeader" + }, + "x-ms-identifiers": [ + "name" + ], + "x-ms-mutability": [ + "read", + "update", + "create" + ] + } + } + }, + "DnsDelegationProperties": { + "type": "object", + "description": "Details of a DNS Domain delegated to the Communications Gateway.", + "properties": { + "domain": { + "type": "string", + "description": "Domain name to delegate", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "nameServers": { + "type": "array", + "description": "The Azure-hosted DNS Name Servers for the delegated DNS Zones", + "items": { + "type": "string" + }, + "readOnly": true + } + } + }, + "DnsDelegationsProperties": { + "type": "object", + "description": "Details of DNS Domains delegated to the Communications Gateway.", + "properties": { + "delegations": { + "type": "array", + "description": "DNS Domains to delegate for the creation of DNS Zones by the Azure Communications Gateway", + "items": { + "$ref": "#/definitions/DnsDelegationProperties" + }, + "x-ms-identifiers": [ + "domain" + ], + "x-ms-mutability": [ + "read", + "update", + "create" + ] + } + } + }, + "E911Type": { + "type": "string", + "description": "The method for terminating emergency calls to the PSTN.", + "enum": [ + "Standard", + "DirectToEsrp" + ], + "x-ms-enum": { + "name": "E911Type", + "modelAsString": true, + "values": [ + { + "name": "Standard", + "value": "Standard", + "description": "Emergency calls are not handled different from other calls" + }, + { + "name": "DirectToEsrp", + "value": "DirectToEsrp", + "description": "Emergency calls are routed directly to the ESRP" + } + ] + } + }, + "PrimaryRegionProperties": { + "type": "object", + "description": "The configuration used in this region as primary, and other regions as backup.", + "properties": { + "operatorAddresses": { + "type": "array", + "description": "IP address to use to contact the operator network from this region", + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "esrpAddresses": { + "type": "array", + "description": "IP address to use to contact the ESRP from this region", + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "allowedSignalingSourceAddressPrefixes": { + "type": "array", + "description": "The allowed source IP addresses or CIDR ranges for signaling", + "default": [], + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "allowedMediaSourceAddressPrefixes": { + "type": "array", + "description": "The allowed source IP addresses or CIDR ranges for media", + "default": [], + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + } + }, + "required": [ + "operatorAddresses" + ] + }, + "ProvisioningState": { + "type": "string", + "description": "Provisioning state of the resource.", + "enum": [ + "Succeeded", + "Failed", + "Canceled" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Resource has been created." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Resource creation failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Resource creation was canceled." + } + ] + } + }, + "ServiceRegionProperties": { + "type": "object", + "description": "The service region configuration needed for Teams Callings.", + "properties": { + "name": { + "type": "string", + "description": "The name of the region in which the resources needed for Teams Calling will be deployed.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "primaryRegionProperties": { + "$ref": "#/definitions/PrimaryRegionProperties", + "description": "The configuration used in this region as primary, and other regions as backup.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + } + }, + "required": [ + "name", + "primaryRegionProperties" + ] + }, + "Status": { + "type": "string", + "description": "The status of the current CommunicationsGateway resource.", + "enum": [ + "ChangePending", + "Complete" + ], + "x-ms-enum": { + "name": "Status", + "modelAsString": true, + "values": [ + { + "name": "ChangePending", + "value": "ChangePending", + "description": "The resource has been created or updated, but the CommunicationsGateway service has not yet been updated to reflect the changes." + }, + { + "name": "Complete", + "value": "Complete", + "description": "The CommunicationsGateway service is up and running with the parameters specified in the resource." + } + ] + } + }, + "TeamsCodecs": { + "type": "string", + "description": "The voice codecs expected for communication with Teams.", + "enum": [ + "PCMA", + "PCMU", + "G722", + "G722_2", + "SILK_8", + "SILK_16" + ], + "x-ms-enum": { + "name": "TeamsCodecs", + "modelAsString": true, + "values": [ + { + "name": "PCMA", + "value": "PCMA", + "description": "Pulse code modulation(PCM) U-law narrowband audio codec(G.711u)" + }, + { + "name": "PCMU", + "value": "PCMU", + "description": "Pulse code modulation(PCM) U-law narrowband audio codec(G.711u)" + }, + { + "name": "G722", + "value": "G722", + "description": "G.722 wideband audio codec" + }, + { + "name": "G722_2", + "value": "G722_2", + "description": "G.722.2 wideband audio codec" + }, + { + "name": "SILK_8", + "value": "SILK_8", + "description": "SILK/8000 narrowband audio codec" + }, + { + "name": "SILK_16", + "value": "SILK_16", + "description": "SILK/16000 wideband audio codec" + } + ] + } + }, + "TestLine": { + "type": "object", + "description": "A TestLine resource", + "properties": { + "properties": { + "$ref": "#/definitions/TestLineProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ] + }, + "TestLineListResult": { + "type": "object", + "description": "The response of a TestLine list operation.", + "properties": { + "value": { + "type": "array", + "description": "The TestLine items on this page", + "items": { + "$ref": "#/definitions/TestLine" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "TestLineProperties": { + "type": "object", + "description": "Details of the TestLine resource.", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Resource provisioning state.", + "readOnly": true + }, + "phoneNumber": { + "type": "string", + "description": "The phone number", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "purpose": { + "$ref": "#/definitions/TestLinePurpose", + "description": "Purpose of this test line, e.g. automated or manual testing", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + } + }, + "required": [ + "phoneNumber", + "purpose" + ] + }, + "TestLinePurpose": { + "type": "string", + "description": "The purpose of the TestLine resource.", + "enum": [ + "Manual", + "Automated" + ], + "x-ms-enum": { + "name": "TestLinePurpose", + "modelAsString": true, + "values": [ + { + "name": "Manual", + "value": "Manual", + "description": "The test line is used for manual testing" + }, + { + "name": "Automated", + "value": "Automated", + "description": "The test line is used for automated testing" + } + ] + } + }, + "TestLineUpdate": { + "type": "object", + "description": "The type used for update operations of the TestLine.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + } + }, + "parameters": {} +} diff --git a/specification/voiceservices/resource-manager/readme.md b/specification/voiceservices/resource-manager/readme.md index c7564dc52612..639eb123e374 100644 --- a/specification/voiceservices/resource-manager/readme.md +++ b/specification/voiceservices/resource-manager/readme.md @@ -27,7 +27,7 @@ These are the global settings for the voiceservices. ```yaml openapi-type: arm openapi-subtype: rpaas -tag: package-2023-04-03 +tag: package-2023-09-01 ``` ### Tag: package-2022-12-01-preview @@ -57,6 +57,15 @@ input-file: - Microsoft.VoiceServices/stable/2023-04-03/voiceservices.json ``` +### Tag: package-2023-09-01 + +These settings apply only when `--tag=package-2023-09-01` is specified on the command line. + +```yaml $(tag) == 'package-2023-09-01' +input-file: + - Microsoft.VoiceServices/stable/2023-09-01/voiceservices.json +``` + --- # Code Generation