Skip to content

Commit 174630a

Browse files
cschen13JarodAertsMsft
cschen13
and
JarodAertsMsft
authored
[Microsoft.Web] Add CustomDnsSuffixConfiguration to ASE (#18553)
* [Microsoft.Web] Add CustomDnsSuffixConfiguration to AppServiceEnvironments * Add examples * Fix style issues * Add customdnssuffix to custom-words * Add CustomDnsSuffixConfiguration to AppServiceEnvironment definition * Address remaining model validation errors * Adjusted networking configuration definitions * Addressed Arm review feedback Co-authored-by: Jarod Aerts <[email protected]>
1 parent 0dbf579 commit 174630a

File tree

6 files changed

+276
-11
lines changed

6 files changed

+276
-11
lines changed

‎custom-words.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -461,6 +461,7 @@ CSRP
461461
csrs
462462
currentbillingfeatures
463463
currentuser
464+
customdnssuffix
464465
customerinsights
465466
customhostname
466467
customhostnames

‎specification/web/resource-manager/Microsoft.Web/stable/2022-03-01/AppServiceEnvironments.json‎

Lines changed: 148 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -493,6 +493,154 @@
493493
}
494494
}
495495
},
496+
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/configurations/customdnssuffix": {
497+
"get": {
498+
"tags": [
499+
"AppServiceEnvironments"
500+
],
501+
"summary": "Get Custom Dns Suffix configuration of an App Service Environment",
502+
"operationId": "AppServiceEnvironments_GetAseCustomDnsSuffixConfiguration",
503+
"parameters": [
504+
{
505+
"$ref": "#/parameters/resourceGroupNameParameter"
506+
},
507+
{
508+
"name": "name",
509+
"in": "path",
510+
"description": "Name of the App Service Environment.",
511+
"required": true,
512+
"type": "string"
513+
},
514+
{
515+
"$ref": "#/parameters/subscriptionIdParameter"
516+
},
517+
{
518+
"$ref": "#/parameters/apiVersionParameter"
519+
}
520+
],
521+
"responses": {
522+
"200": {
523+
"description": "OK.",
524+
"schema": {
525+
"$ref": "./CommonDefinitions.json#/definitions/CustomDnsSuffixConfiguration"
526+
}
527+
},
528+
"default": {
529+
"description": "App Service error response.",
530+
"schema": {
531+
"$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
532+
}
533+
}
534+
},
535+
"x-ms-examples": {
536+
"Get ASE custom DNS suffix configuration": {
537+
"$ref": "./examples/GetAseCustomDnsSuffixConfiguration.json"
538+
}
539+
}
540+
},
541+
"put": {
542+
"tags": [
543+
"AppServiceEnvironments"
544+
],
545+
"summary": "Update Custom Dns Suffix configuration of an App Service Environment",
546+
"operationId": "AppServiceEnvironments_UpdateAseCustomDnsSuffixConfiguration",
547+
"parameters": [
548+
{
549+
"$ref": "#/parameters/resourceGroupNameParameter"
550+
},
551+
{
552+
"name": "name",
553+
"in": "path",
554+
"description": "Name of the App Service Environment.",
555+
"required": true,
556+
"type": "string"
557+
},
558+
{
559+
"name": "customDnsSuffixConfiguration",
560+
"in": "body",
561+
"required": true,
562+
"schema": {
563+
"$ref": "./CommonDefinitions.json#/definitions/CustomDnsSuffixConfiguration"
564+
}
565+
},
566+
{
567+
"$ref": "#/parameters/subscriptionIdParameter"
568+
},
569+
{
570+
"$ref": "#/parameters/apiVersionParameter"
571+
}
572+
],
573+
"responses": {
574+
"200": {
575+
"description": "OK.",
576+
"schema": {
577+
"$ref": "./CommonDefinitions.json#/definitions/CustomDnsSuffixConfiguration"
578+
}
579+
},
580+
"default": {
581+
"description": "App Service error response.",
582+
"schema": {
583+
"$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
584+
}
585+
}
586+
},
587+
"x-ms-examples": {
588+
"Update ASE custom DNS suffix configuration": {
589+
"$ref": "./examples/UpdateAseCustomDnsSuffixConfiguration.json"
590+
}
591+
}
592+
},
593+
"delete": {
594+
"tags": [
595+
"AppServiceEnvironments"
596+
],
597+
"summary": "Delete Custom Dns Suffix configuration of an App Service Environment",
598+
"operationId": "AppServiceEnvironments_DeleteAseCustomDnsSuffixConfiguration",
599+
"parameters": [
600+
{
601+
"$ref": "#/parameters/resourceGroupNameParameter"
602+
},
603+
{
604+
"name": "name",
605+
"in": "path",
606+
"description": "Name of the App Service Environment.",
607+
"required": true,
608+
"type": "string"
609+
},
610+
{
611+
"$ref": "#/parameters/subscriptionIdParameter"
612+
},
613+
{
614+
"$ref": "#/parameters/apiVersionParameter"
615+
}
616+
],
617+
"responses": {
618+
"200": {
619+
"description": "OK.",
620+
"schema": {
621+
"type": "object"
622+
}
623+
},
624+
"204": {
625+
"description": "No content.",
626+
"schema": {
627+
"type": "object"
628+
}
629+
},
630+
"default": {
631+
"description": "App Service error response.",
632+
"schema": {
633+
"$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
634+
}
635+
}
636+
},
637+
"x-ms-examples": {
638+
"Delete ASE custom DNS suffix configuration": {
639+
"$ref": "./examples/DeleteAseCustomDnsSuffixConfiguration.json"
640+
}
641+
}
642+
}
643+
},
496644
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/configurations/networking": {
497645
"get": {
498646
"tags": [

‎specification/web/resource-manager/Microsoft.Web/stable/2022-03-01/CommonDefinitions.json‎

Lines changed: 52 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -158,6 +158,9 @@
158158
"description": "Whether or not this App Service Environment is zone-redundant.",
159159
"type": "boolean"
160160
},
161+
"customDnsSuffixConfiguration": {
162+
"$ref": "#/definitions/CustomDnsSuffixConfiguration"
163+
},
161164
"networkingConfiguration": {
162165
"$ref": "#/definitions/AseV3NetworkingConfiguration"
163166
}
@@ -414,19 +417,9 @@
414417
"description": "Property to enable and disable Remote Debug on ASEV3",
415418
"type": "boolean"
416419
},
417-
"numberOfOutboundIpAddresses": {
418-
"format": "int32",
419-
"description": "Property to set the number of outbound ips on AseV3",
420-
"type": "integer"
421-
},
422420
"inboundIpAddressOverride": {
423-
"description": "Customer provided Inbound IP Address",
421+
"description": "Customer provided Inbound IP Address. Only able to be set on Ase create.",
424422
"type": "string"
425-
},
426-
"targetNumberOfOutboundIpAddresses": {
427-
"format": "int32",
428-
"type": "integer",
429-
"readOnly": true
430423
}
431424
},
432425
"x-ms-client-flatten": true
@@ -897,6 +890,54 @@
897890
}
898891
}
899892
},
893+
"CustomDnsSuffixConfiguration": {
894+
"description": "Full view of the custom domain suffix configuration for ASEv3.",
895+
"type": "object",
896+
"allOf": [
897+
{
898+
"$ref": "#/definitions/ProxyOnlyResource"
899+
}
900+
],
901+
"properties": {
902+
"properties": {
903+
"description": "CustomDnsSuffixConfiguration resource specific properties",
904+
"type": "object",
905+
"properties": {
906+
"provisioningState": {
907+
"enum": [
908+
"Succeeded",
909+
"Failed",
910+
"Degraded",
911+
"InProgress"
912+
],
913+
"type": "string",
914+
"readOnly": true,
915+
"x-ms-enum": {
916+
"name": "CustomDnsSuffixProvisioningState",
917+
"modelAsString": false
918+
}
919+
},
920+
"provisioningDetails": {
921+
"type": "string",
922+
"readOnly": true
923+
},
924+
"dnsSuffix": {
925+
"description": "The default custom domain suffix to use for all sites deployed on the ASE.",
926+
"type": "string"
927+
},
928+
"certificateUrl": {
929+
"description": "The URL referencing the Azure Key Vault certificate secret that should be used as the default SSL/TLS certificate for sites with the custom domain suffix.",
930+
"type": "string"
931+
},
932+
"keyVaultReferenceIdentity": {
933+
"description": "The user-assigned identity to use for resolving the key vault certificate reference. If not specified, the system-assigned ASE identity will be used if available.",
934+
"type": "string"
935+
}
936+
},
937+
"x-ms-client-flatten": true
938+
}
939+
}
940+
},
900941
"CustomScaleRule": {
901942
"description": "Container App container Custom scaling rule.",
902943
"type": "object",

‎specification/web/resource-manager/Microsoft.Web/stable/2022-03-01/examples/DeleteAseCustomDnsSuffixConfiguration.json‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
{
2+
"parameters": {
3+
"subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
4+
"resourceGroupName": "test-rg",
5+
"name": "test-ase",
6+
"api-version": "2022-03-01"
7+
},
8+
"responses": {
9+
"200": {
10+
"headers": {},
11+
"body": {}
12+
},
13+
"204": {
14+
"headers": {},
15+
"body": {}
16+
}
17+
}
18+
}

‎specification/web/resource-manager/Microsoft.Web/stable/2022-03-01/examples/GetAseCustomDnsSuffixConfiguration.json‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
{
2+
"parameters": {
3+
"subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
4+
"resourceGroupName": "test-rg",
5+
"name": "test-ase",
6+
"api-version": "2022-03-01"
7+
},
8+
"responses": {
9+
"200": {
10+
"headers": {},
11+
"body": {
12+
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/configurations/customdnssuffix",
13+
"name": "customDnsSuffix",
14+
"type": "Microsoft.Web/hostingEnvironments/configurations/customdnssuffix",
15+
"properties": {
16+
"provisioningState": "Succeeded",
17+
"provisioningDetails": null,
18+
"dnsSuffix": "contoso.com",
19+
"certificateUrl": "https://test-kv.vault.azure.net/secrets/contosocert",
20+
"keyVaultReferenceIdentity": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/test-rg/providers/microsoft.managedidentity/userassignedidentities/test-user-mi"
21+
}
22+
}
23+
}
24+
}
25+
}

‎specification/web/resource-manager/Microsoft.Web/stable/2022-03-01/examples/UpdateAseCustomDnsSuffixConfiguration.json‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
{
2+
"parameters": {
3+
"subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
4+
"resourceGroupName": "test-rg",
5+
"name": "test-ase",
6+
"api-version": "2022-03-01",
7+
"customDnsSuffixConfiguration": {
8+
"properties": {
9+
"dnsSuffix": "contoso.com",
10+
"certificateUrl": "https://test-kv.vault.azure.net/secrets/contosocert",
11+
"keyVaultReferenceIdentity": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/test-rg/providers/microsoft.managedidentity/userassignedidentities/test-user-mi"
12+
}
13+
}
14+
},
15+
"responses": {
16+
"200": {
17+
"headers": {},
18+
"body": {
19+
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/configurations/customdnssuffix",
20+
"name": "customDnsSuffix",
21+
"type": "Microsoft.Web/hostingEnvironments/configurations/customdnssuffix",
22+
"properties": {
23+
"provisioningState": "Succeeded",
24+
"provisioningDetails": null,
25+
"dnsSuffix": "contoso.com",
26+
"certificateUrl": "https://test-kv.vault.azure.net/secrets/contosocert",
27+
"keyVaultReferenceIdentity": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/test-rg/providers/microsoft.managedidentity/userassignedidentities/test-user-mi"
28+
}
29+
}
30+
}
31+
}
32+
}

0 commit comments

Comments
 (0)