Skip to content

Commit 1a948f2

Browse files
authored
Add API properties and example JSON for Web App Routing of IngressProfile (#18564)
* Add API properties and example JSON for Web App Routing of IngressProfile. * Add a ending period for description to match the style in all other "descriptions" in the same file.
1 parent 217b039 commit 1a948f2

File tree

2 files changed

+276
-0
lines changed

2 files changed

+276
-0
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,245 @@
1+
{
2+
"parameters": {
3+
"api-version": "2022-03-02-preview",
4+
"subscriptionId": "subid1",
5+
"resourceGroupName": "rg1",
6+
"resourceName": "clustername1",
7+
"parameters": {
8+
"location": "location1",
9+
"tags": {
10+
"tier": "production",
11+
"archv2": ""
12+
},
13+
"sku": {
14+
"name": "Basic",
15+
"tier": "Free"
16+
},
17+
"properties": {
18+
"kubernetesVersion": "",
19+
"dnsPrefix": "dnsprefix1",
20+
"agentPoolProfiles": [
21+
{
22+
"name": "nodepool1",
23+
"count": 3,
24+
"vmSize": "Standard_DS2_v2",
25+
"osType": "Linux",
26+
"type": "VirtualMachineScaleSets",
27+
"enableNodePublicIP": true,
28+
"mode": "System"
29+
}
30+
],
31+
"linuxProfile": {
32+
"adminUsername": "azureuser",
33+
"ssh": {
34+
"publicKeys": [
35+
{
36+
"keyData": "keydata"
37+
}
38+
]
39+
}
40+
},
41+
"networkProfile": {
42+
"loadBalancerSku": "standard",
43+
"outboundType": "loadBalancer",
44+
"loadBalancerProfile": {
45+
"managedOutboundIPs": {
46+
"count": 2
47+
}
48+
}
49+
},
50+
"ingressProfile": {
51+
"webAppRouting": {
52+
"enabled": true,
53+
"dnsZoneResourceId": "/subscriptions/SUB_ID/resourceGroups/RG_NAME/providers/Microsoft.Network/dnszones/DNS_ZONE_NAME"
54+
}
55+
}
56+
}
57+
}
58+
},
59+
"responses": {
60+
"200": {
61+
"body": {
62+
"id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1",
63+
"location": "location1",
64+
"name": "clustername1",
65+
"tags": {
66+
"archv2": "",
67+
"tier": "production"
68+
},
69+
"type": "Microsoft.ContainerService/ManagedClusters",
70+
"properties": {
71+
"provisioningState": "Succeeded",
72+
"maxAgentPools": 1,
73+
"kubernetesVersion": "1.9.6",
74+
"dnsPrefix": "dnsprefix1",
75+
"agentPoolProfiles": [
76+
{
77+
"name": "nodepool1",
78+
"count": 3,
79+
"vmSize": "Standard_DS2_v2",
80+
"maxPods": 110,
81+
"osType": "Linux",
82+
"provisioningState": "Succeeded",
83+
"orchestratorVersion": "1.9.6",
84+
"type": "VirtualMachineScaleSets",
85+
"enableNodePublicIP": true,
86+
"mode": "System",
87+
"nodeImageVersion": "AKSUbuntu:1604:2020.03.11"
88+
}
89+
],
90+
"linuxProfile": {
91+
"adminUsername": "azureuser",
92+
"ssh": {
93+
"publicKeys": [
94+
{
95+
"keyData": "keydata"
96+
}
97+
]
98+
}
99+
},
100+
"windowsProfile": {
101+
"adminUsername": "azureuser"
102+
},
103+
"servicePrincipalProfile": {
104+
"clientId": "clientid"
105+
},
106+
"nodeResourceGroup": "MC_rg1_clustername1_location1",
107+
"enableRBAC": true,
108+
"diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des",
109+
"enablePodSecurityPolicy": true,
110+
"fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io",
111+
"networkProfile": {
112+
"loadBalancerSku": "basic",
113+
"networkPlugin": "kubenet",
114+
"podCidr": "10.244.0.0/16",
115+
"serviceCidr": "10.0.0.0/16",
116+
"dnsServiceIP": "10.0.0.10",
117+
"dockerBridgeCidr": "172.17.0.1/16",
118+
"outboundType": "loadBalancer",
119+
"podCidrs": [
120+
"10.244.0.0/16"
121+
],
122+
"serviceCidrs": [
123+
"10.0.0.0/16"
124+
],
125+
"ipFamilies": [
126+
"IPv4"
127+
],
128+
"loadBalancerProfile": {
129+
"allocatedOutboundPorts": 2000,
130+
"idleTimeoutInMinutes": 10,
131+
"managedOutboundIPs": {
132+
"count": 2
133+
},
134+
"effectiveOutboundIPs": [
135+
{
136+
"id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1"
137+
},
138+
{
139+
"id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2"
140+
}
141+
]
142+
}
143+
},
144+
"ingressProfile": {
145+
"webAppRouting": {
146+
"enabled": true,
147+
"dnsZoneResourceId": "/subscriptions/SUB_ID/resourceGroups/RG_NAME/providers/Microsoft.Network/dnszones/DNS_ZONE_NAME"
148+
}
149+
}
150+
}
151+
}
152+
},
153+
"201": {
154+
"body": {
155+
"id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1",
156+
"location": "location1",
157+
"name": "clustername1",
158+
"tags": {
159+
"archv2": "",
160+
"tier": "production"
161+
},
162+
"type": "Microsoft.ContainerService/ManagedClusters",
163+
"properties": {
164+
"provisioningState": "Creating",
165+
"maxAgentPools": 1,
166+
"kubernetesVersion": "1.9.6",
167+
"dnsPrefix": "dnsprefix1",
168+
"agentPoolProfiles": [
169+
{
170+
"name": "nodepool1",
171+
"count": 3,
172+
"vmSize": "Standard_DS2_v2",
173+
"maxPods": 110,
174+
"osType": "Linux",
175+
"provisioningState": "Creating",
176+
"orchestratorVersion": "1.9.6",
177+
"type": "VirtualMachineScaleSets",
178+
"enableNodePublicIP": true,
179+
"mode": "System"
180+
}
181+
],
182+
"linuxProfile": {
183+
"adminUsername": "azureuser",
184+
"ssh": {
185+
"publicKeys": [
186+
{
187+
"keyData": "keydata"
188+
}
189+
]
190+
}
191+
},
192+
"windowsProfile": {
193+
"adminUsername": "azureuser"
194+
},
195+
"servicePrincipalProfile": {
196+
"clientId": "clientid"
197+
},
198+
"nodeResourceGroup": "MC_rg1_clustername1_location1",
199+
"enableRBAC": true,
200+
"diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des",
201+
"enablePodSecurityPolicy": true,
202+
"networkProfile": {
203+
"networkPlugin": "kubenet",
204+
"podCidr": "10.244.0.0/16",
205+
"serviceCidr": "10.0.0.0/16",
206+
"dnsServiceIP": "10.0.0.10",
207+
"dockerBridgeCidr": "172.17.0.1/16",
208+
"loadBalancerSku": "standard",
209+
"outboundType": "loadBalancer",
210+
"podCidrs": [
211+
"10.244.0.0/16"
212+
],
213+
"serviceCidrs": [
214+
"10.0.0.0/16"
215+
],
216+
"ipFamilies": [
217+
"IPv4"
218+
],
219+
"loadBalancerProfile": {
220+
"allocatedOutboundPorts": 2000,
221+
"idleTimeoutInMinutes": 10,
222+
"managedOutboundIPs": {
223+
"count": 2
224+
},
225+
"effectiveOutboundIPs": [
226+
{
227+
"id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1"
228+
},
229+
{
230+
"id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2"
231+
}
232+
]
233+
}
234+
},
235+
"ingressProfile": {
236+
"webAppRouting": {
237+
"enabled": true,
238+
"dnsZoneResourceId": "/subscriptions/SUB_ID/resourceGroups/RG_NAME/providers/Microsoft.Network/dnszones/DNS_ZONE_NAME"
239+
}
240+
}
241+
}
242+
}
243+
}
244+
}
245+
}

specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-03-02-preview/managedClusters.json

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -567,6 +567,9 @@
567567
"Create Managed Cluster with Security Profile configured": {
568568
"$ref": "./examples/ManagedClustersCreate_SecurityProfile.json"
569569
},
570+
"Create Managed Cluster with Web App Routing Ingress Profile configured": {
571+
"$ref": "./examples/ManagedClustersCreate_IngressProfile_WebAppRouting.json"
572+
},
570573
"Create Managed Cluster with AKS-managed NAT gateway as outbound type": {
571574
"$ref": "./examples/ManagedClustersCreate_ManagedNATGateway.json"
572575
},
@@ -4252,6 +4255,10 @@
42524255
"$ref": "#/definitions/ManagedClusterSecurityProfile",
42534256
"description": "Security profile for the managed cluster."
42544257
},
4258+
"ingressProfile": {
4259+
"$ref": "#/definitions/ManagedClusterIngressProfile",
4260+
"description": "Ingress profile for the managed cluster."
4261+
},
42554262
"publicNetworkAccess": {
42564263
"type": "string",
42574264
"enum": [
@@ -5856,6 +5863,30 @@
58565863
},
58575864
"description": "Azure Key Vault key management service settings for the security profile."
58585865
},
5866+
"ManagedClusterIngressProfile": {
5867+
"type": "object",
5868+
"properties": {
5869+
"webAppRouting": {
5870+
"$ref": "#/definitions/ManagedClusterIngressProfileWebAppRouting",
5871+
"description": "Web App Routing settings for the ingress profile."
5872+
}
5873+
},
5874+
"description": "Ingress profile for the container service cluster."
5875+
},
5876+
"ManagedClusterIngressProfileWebAppRouting": {
5877+
"type": "object",
5878+
"properties": {
5879+
"enabled": {
5880+
"type": "boolean",
5881+
"description": "Whether to enable Web App Routing."
5882+
},
5883+
"dnsZoneResourceId": {
5884+
"type": "string",
5885+
"description": "Resource ID of the DNS Zone to be associated with the web app. Used only when Web App Routing is enabled."
5886+
}
5887+
},
5888+
"description": "Web App Routing settings for the ingress profile."
5889+
},
58595890
"ManagedClusterSecurityProfileWorkloadIdentity": {
58605891
"type": "object",
58615892
"properties": {

0 commit comments

Comments
 (0)