Skip to content

Commit b28ef4d

Browse files
authored
Corrected Az.Aks examples h3 header format (#25477)
Co-authored-by: Mike F. Robbins <[email protected]>
1 parent ea4a07d commit b28ef4d

9 files changed

+17
-17
lines changed

src/Aks/Aks/help/Get-AzAksCluster.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ List Kubernetes managed clusters.
3535

3636
## EXAMPLES
3737

38-
### List all Kubernetes clusters
38+
### Example 1: List all Kubernetes clusters
3939
```powershell
4040
Get-AzAksCluster
4141
```

src/Aks/Aks/help/Get-AzAksNodePool.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ List node pools in specified cluster.
3737

3838
## EXAMPLES
3939

40-
### Get all node pools within specified cluster
40+
### Example 1: Get all node pools within specified cluster
4141
```powershell
4242
Get-AzAksNodePool -ResourceGroupName myResourceGroup -ClusterName myCluster
4343
```

src/Aks/Aks/help/Import-AzAksCredential.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Import and merge Kubectl config for a managed Kubernetes Cluster.
3838

3939
## EXAMPLES
4040

41-
### Import and merge Kubectl config
41+
### Example 1: Import and merge Kubectl config
4242
```powershell
4343
Import-AzAksCredential -ResourceGroupName group -Name myCluster
4444
```

src/Aks/Aks/help/New-AzAksCluster.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -52,13 +52,13 @@ Create a new Azure Kubernetes Service(AKS) cluster.
5252

5353
## EXAMPLES
5454

55-
### Create an AKS with default params.
55+
### Example 1: Create an AKS with default params.
5656

5757
```powershell
5858
New-AzAksCluster -ResourceGroupName myResourceGroup -Name myCluster
5959
```
6060

61-
### Create Windows Server container on an AKS.
61+
### Example 2: Create Windows Server container on an AKS.
6262
To create Windows Server container on an AKS, you must specify at least four following parameters when creating the AKS, and the value for `NetworkPlugin` and `NodeVmSetType` must be `azure` and `VirtualMachineScaleSets` respectively.
6363
`-WindowsProfileAdminUserName *** -WindowsProfileAdminUserPassword *** -NetworkPlugin azure -NodeVmSetType VirtualMachineScaleSets`
6464

@@ -68,7 +68,7 @@ New-AzAksCluster -ResourceGroupName myResourceGroup -Name myCluster -WindowsProf
6868
New-AzAksNodePool -ResourceGroupName myResourceGroup -ClusterName myCluster -Name win1 -OsType Windows -VmSetType VirtualMachineScaleSets
6969
```
7070

71-
### Create an AKS cluster with LinuxOSConfig and KubeletConfig.
71+
### Example 3: Create an AKS cluster with LinuxOSConfig and KubeletConfig.
7272
When you create an AKS cluster, you can specify the kubelet and OS configurations. The type of `NodeLinuxOSConfig` and `NodeKubeletConfig` must be `Microsoft.Azure.Management.ContainerService.Models.LinuxOSConfig` and `Microsoft.Azure.Management.ContainerService.Models.KubeletConfig` respectively.
7373

7474

@@ -96,7 +96,7 @@ $kubeletConfig = [Microsoft.Azure.Management.ContainerService.Models.KubeletConf
9696
New-AzAksCluster -ResourceGroupName myResourceGroup -Name myAKSCluster -NodeLinuxOSConfig $linuxOsConfig -NodeKubeletConfig $kubeletConfig
9797
```
9898

99-
### Create an AKS cluster with AutoScalerProfile.
99+
### Example 4: Create an AKS cluster with AutoScalerProfile.
100100
When you create an AKS cluster, you can configure granular details of the cluster autoscaler by changing the default values in the cluster-wide autoscaler profile.
101101

102102
```powershell
@@ -109,7 +109,7 @@ $AutoScalerProfile=[Microsoft.Azure.Management.ContainerService.Models.ManagedCl
109109
New-AzAksCluster -ResourceGroupName myResourceGroup -Name myAKSCluster -AutoScalerProfile $AutoScalerProfile
110110
```
111111

112-
### Create an AKS cluster with AadProfile.
112+
### Example 5: Create an AKS cluster with AadProfile.
113113
When you create an AKS cluster, you can configure the AAD profile.
114114

115115
```powershell

src/Aks/Aks/help/New-AzAksNodePool.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,19 +45,19 @@ Create a new node pool in specified cluster.
4545

4646
## EXAMPLES
4747

48-
### Create a node pool with default parameters
48+
### Example 1: Create a node pool with default parameters
4949
```powershell
5050
New-AzAksNodePool -ResourceGroupName myResouceGroup -ClusterName myCluster -Name mydefault
5151
```
5252

53-
### Create Windows Server container on an AKS
53+
### Example 2: Create Windows Server container on an AKS
5454
```powershell
5555
$cred = ConvertTo-SecureString -AsPlainText "Password!!123" -Force
5656
New-AzAksCluster -ResourceGroupName myResourceGroup -Name myCluster -WindowsProfileAdminUserName azureuser -WindowsProfileAdminUserPassword $cred -NetworkPlugin azure -NodeVmSetType VirtualMachineScaleSets
5757
New-AzAksNodePool -ResourceGroupName myResourceGroup -ClusterName myCluster -Name win1 -OsType Windows -VmSetType VirtualMachineScaleSets
5858
```
5959

60-
### Create a node pool with LinuxOSConfig and KubeletConfig.
60+
### Example 3: Create a node pool with LinuxOSConfig and KubeletConfig.
6161
When you create an AKS node pool, you can specify the kubelet and OS configurations. The type of `LinuxOSConfig` and `KubeletConfig` must be `Microsoft.Azure.Management.ContainerService.Models.LinuxOSConfig` and `Microsoft.Azure.Management.ContainerService.Models.KubeletConfig` respectively.
6262

6363

src/Aks/Aks/help/Remove-AzAksCluster.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Delete a managed Kubernetes cluster.
3737

3838
## EXAMPLES
3939

40-
### Delete an existing managed Kubernetes cluster
40+
### Example 1: Delete an existing managed Kubernetes cluster
4141
```powershell
4242
Remove-AzAksCluster -ResourceGroupName group -Name myCluster
4343
```

src/Aks/Aks/help/Remove-AzAksNodePool.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Delete node pool from managed cluster.
4444

4545
## EXAMPLES
4646

47-
### Delete specified node pool
47+
### Example 1: Delete specified node pool
4848
```powershell
4949
Remove-AzAksNodePool -ResourceGroupName myResourceGroup -ClusterName myCluster -Name winpool
5050
```

src/Aks/Aks/help/Set-AzAksCluster.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -81,14 +81,14 @@ Update or create a managed Kubernetes cluster.
8181

8282
## EXAMPLES
8383

84-
### Example 1
84+
### Example 1:
8585
```powershell
8686
Get-AzAksCluster -ResourceGroupName group -Name myCluster | Set-AzAksCluster -NodeCount 5
8787
```
8888

8989
Set the number of nodes in the Kubernetes cluster to 5.
9090

91-
### Update an AKS cluster with AutoScalerProfile.
91+
### Example 2: Update an AKS cluster with AutoScalerProfile.
9292
When you update an AKS cluster, you can configure granular details of the cluster autoscaler by changing the default values in the cluster-wide autoscaler profile.
9393

9494
```powershell
@@ -101,7 +101,7 @@ $AutoScalerProfile=[Microsoft.Azure.Management.ContainerService.Models.ManagedCl
101101
Get-AzAksCluster -ResourceGroupName group -Name myCluster | Set-AzAksCluster -AutoScalerProfile $AutoScalerProfile
102102
```
103103

104-
### Update an AKS cluster with AadProfile.
104+
### Example 3: Update an AKS cluster with AadProfile.
105105
When you update an AKS cluster, you can configure the AAD profile.
106106

107107
```powershell

src/Aks/Aks/help/Update-AzAksNodePool.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ Update node pool in a managed cluster.
5353

5454
## EXAMPLES
5555

56-
### Change minimun count to 5 for specified node pool
56+
### Example 1: Change minimun count to 5 for specified node pool
5757
```powershell
5858
Update-AzAksNodePool -ResourceGroupName myResourceGroup -ClusterName myCluster -Name linuxpool -MinCount 5
5959
```

0 commit comments

Comments
 (0)