Skip to content

Commit 350f640

Browse files
committed
update examples
1 parent c651b06 commit 350f640

14 files changed

+95
-179
lines changed

src/CloudService/CloudService.Autorest/Properties/AssemblyInfo.cs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,3 +25,4 @@
2525
[assembly: System.Runtime.InteropServices.ComVisibleAttribute(false)]
2626
[assembly: System.CLSCompliantAttribute(false)]
2727

28+

src/CloudService/CloudService.Autorest/docs/New-AzCloudServiceDiagnosticsExtension.md

Lines changed: 6 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -24,27 +24,15 @@ Create a in-memory object for Diagnostics Extension
2424

2525
## EXAMPLES
2626

27-
### Example 1: {{ Add title here }}
27+
### Example 1: Create diagnostics extension object
2828
```powershell
29-
{{ Add code here }}
29+
$storageAccountKey = Get-AzStorageAccountKey -ResourceGroupName "ContosOrg" -Name "ContosSA"
30+
$configFile = "<WAD configuration file path>"
31+
$extension = New-AzCloudServiceDiagnosticsExtension -Name "WADExtension" -ResourceGroupName "ContosOrg" -CloudServiceName "ContosCS" -StorageAccountName "ContosSA" -StorageAccountKey $storageAccountKey[0].Value -DiagnosticsConfigurationPath $configFile -TypeHandlerVersion "1.5" -AutoUpgradeMinorVersion $true
3032
```
3133

32-
```output
33-
{{ Add output here (remove the output block if the example doesn't have an output) }}
34-
```
35-
36-
{{ Add description here }}
37-
38-
### Example 2: {{ Add title here }}
39-
```powershell
40-
{{ Add code here }}
41-
```
42-
43-
```output
44-
{{ Add output here (remove the output block if the example doesn't have an output) }}
45-
```
46-
47-
{{ Add description here }}
34+
This command creates diagnostics extension object which is used for creating or updating a cloud service.
35+
For more details see New-AzCloudService.
4836

4937
## PARAMETERS
5038

src/CloudService/CloudService.Autorest/docs/New-AzCloudServiceLoadBalancerFrontendIPConfigurationObject.md

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -29,27 +29,26 @@ Create an in-memory object for LoadBalancerFrontendIPConfiguration.
2929

3030
## EXAMPLES
3131

32-
### Example 1: {{ Add title here }}
32+
### Example 1: Create load balancer frontend IP configuration object
3333
```powershell
34-
{{ Add code here }}
34+
$publicIP = Get-AzPublicIpAddress -ResourceGroupName 'ContosoOrg' -Name 'ContosoPublicIP'
35+
$feIpConfig = New-AzCloudServiceLoadBalancerFrontendIPConfigurationObject -Name 'ContosoFe' -PublicIPAddressId $publicIp.Id
36+
$loadBalancerConfig = New-AzCloudServiceLoadBalancerConfigurationObject -Name 'ContosoLB' -FrontendIPConfiguration $feIpConfig
3537
```
3638

37-
```output
38-
{{ Add output here (remove the output block if the example doesn't have an output) }}
39-
```
40-
41-
{{ Add description here }}
39+
This command creates load balancer frontend IP configuration object which is used for creating or updating a cloud service.
40+
For more details see New-AzCloudService.
4241

43-
### Example 2: {{ Add title here }}
42+
### Example 2: Create load balancer frontend IP configuration object with Private ID address
4443
```powershell
45-
{{ Add code here }}
46-
```
44+
# Create role profile object
45+
$subnet = New-AzVirtualNetworkSubnetConfig -Name "WebTier" -AddressPrefix "10.0.0.0/24" -WarningAction SilentlyContinue
46+
$feIpConfig = New-AzCloudServiceLoadBalancerFrontendIPConfigurationObject -Name 'ContosoFe' -privateIPAddress '10.0.0.6' -subnetId $Subnet.Id
47+
$loadBalancerConfig = New-AzCloudServiceLoadBalancerConfigurationObject -Name 'ContosoLB' -FrontendIPConfiguration $feIpConfig
4748
48-
```output
49-
{{ Add output here (remove the output block if the example doesn't have an output) }}
5049
```
5150

52-
{{ Add description here }}
51+
This command creates load balancer frontend IP configuration object with a Private IP address
5352

5453
## PARAMETERS
5554

src/CloudService/CloudService.Autorest/docs/New-AzCloudServiceRemoteDesktopExtensionObject.md

Lines changed: 6 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -23,27 +23,15 @@ Create a in-memory object for Remote Desktop Extension
2323

2424
## EXAMPLES
2525

26-
### Example 1: {{ Add title here }}
26+
### Example 1: Create remote desktop extension object
2727
```powershell
28-
{{ Add code here }}
28+
$credential = Get-Credential
29+
$expiration = (Get-Date).AddYears(1)
30+
$extension = New-AzCloudServiceRemoteDesktopExtensionObject -Name 'RDPExtension' -Credential $credential -Expiration $expiration -TypeHandlerVersion '1.2.1'
2931
```
3032

31-
```output
32-
{{ Add output here (remove the output block if the example doesn't have an output) }}
33-
```
34-
35-
{{ Add description here }}
36-
37-
### Example 2: {{ Add title here }}
38-
```powershell
39-
{{ Add code here }}
40-
```
41-
42-
```output
43-
{{ Add output here (remove the output block if the example doesn't have an output) }}
44-
```
45-
46-
{{ Add description here }}
33+
This command creates remote desktop extension object which is used for creating or updating a cloud service.
34+
For more details see New-AzCloudService.
4735

4836
## PARAMETERS
4937

src/CloudService/CloudService.Autorest/docs/New-AzCloudServiceVaultSecretGroupObject.md

Lines changed: 6 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -21,27 +21,15 @@ Create an in-memory object for CloudServiceVaultSecretGroup.
2121

2222
## EXAMPLES
2323

24-
### Example 1: {{ Add title here }}
24+
### Example 1: Create vault secret group object
2525
```powershell
26-
{{ Add code here }}
26+
$keyVault = Get-AzKeyVault -VaultName 'ContosoKeyVault'
27+
$certificate = Get-AzKeyVaultCertificate -VaultName 'ContosoKeyVault' -Name 'ContosoCert'
28+
$secretGroup = New-AzCloudServiceVaultSecretGroupObject -Id $keyVault.ResourceId -CertificateUrl $certificate.SecretId
2729
```
2830

29-
```output
30-
{{ Add output here (remove the output block if the example doesn't have an output) }}
31-
```
32-
33-
{{ Add description here }}
34-
35-
### Example 2: {{ Add title here }}
36-
```powershell
37-
{{ Add code here }}
38-
```
39-
40-
```output
41-
{{ Add output here (remove the output block if the example doesn't have an output) }}
42-
```
43-
44-
{{ Add description here }}
31+
This command creates vault secret group object which is used for creating or updating a cloud service.
32+
For more details see New-AzCloudService.
4533

4634
## PARAMETERS
4735

src/CloudService/CloudService.Autorest/docs/Switch-AzCloudService.md

Lines changed: 9 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -29,27 +29,22 @@ Swaps VIPs between two cloud service (extended support) load balancers.
2929

3030
## EXAMPLES
3131

32-
### Example 1: {{ Add title here }}
32+
### Example 1: Switch cloud service using name
3333
```powershell
34-
{{ Add code here }}
34+
Switch-AzCloudService -ResourceGroupName "BRGThree" -CloudServiceName BService -SubscriptionId 1133e0eb-b53c-1234-b478-2eac8f04afca
3535
```
3636

37-
```output
38-
{{ Add output here (remove the output block if the example doesn't have an output) }}
39-
```
40-
41-
{{ Add description here }}
37+
Above command invokes the vipswap operation on the Cloud service with name 'BService' and will perform the operation once the user confirms the action on the confirmation prompt.
38+
'BService' with be swapped with its swappable cloud service.
4239

43-
### Example 2: {{ Add title here }}
40+
### Example 2: Switch cloud service using cloud service object
4441
```powershell
45-
{{ Add code here }}
46-
```
47-
48-
```output
49-
{{ Add output here (remove the output block if the example doesn't have an output) }}
42+
$cs = Get-AzCloudService -ResourceGroupName "BRGThree" -CloudServiceName BService -SubscriptionId 1133e0eb-b53c-1234-b478-2eac8f04afca
43+
Switch-AzCloudService -CloudService $cs
5044
```
5145

52-
{{ Add description here }}
46+
Above command invokes the vipswap operation on the Cloud service with name 'BService' and will perform the operation once the user confirms the action on the confirmation prompt.
47+
'BService' with be swapped with its swappable cloud service.
5348

5449
## PARAMETERS
5550

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
{
2-
"generate_Id": "827390fd-db05-4315-af6c-03b29fac885f"
2+
"generate_Id": "f1836811-f388-47fa-af6b-f007878e0445"
33
}

src/CloudService/CloudService.sln

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "CloudService", "CloudServic
2121
EndProject
2222
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "CloudService.Autorest", "CloudService.Autorest", "{8D56B996-E5C3-5DFA-8212-71CB87FB279F}"
2323
EndProject
24-
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Az.CloudService", "..\..\generated\CloudService\CloudService.Autorest\Az.CloudService.csproj", "{3A34EA55-E4D0-4B91-96C4-14188F9F5A43}"
24+
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Az.CloudService", "..\..\generated\CloudService\CloudService.Autorest\Az.CloudService.csproj", "{46B6960B-5315-4050-9C88-CE9EE439B4A0}"
2525
EndProject
2626
Global
2727
GlobalSection(SolutionConfigurationPlatforms) = preSolution
@@ -117,18 +117,18 @@ Global
117117
{66F605AB-247B-47C6-BB0C-614EBFCD6C1E}.Release|x64.Build.0 = Release|Any CPU
118118
{66F605AB-247B-47C6-BB0C-614EBFCD6C1E}.Release|x86.ActiveCfg = Release|Any CPU
119119
{66F605AB-247B-47C6-BB0C-614EBFCD6C1E}.Release|x86.Build.0 = Release|Any CPU
120-
{3A34EA55-E4D0-4B91-96C4-14188F9F5A43}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
121-
{3A34EA55-E4D0-4B91-96C4-14188F9F5A43}.Debug|Any CPU.Build.0 = Debug|Any CPU
122-
{3A34EA55-E4D0-4B91-96C4-14188F9F5A43}.Debug|x64.ActiveCfg = Debug|Any CPU
123-
{3A34EA55-E4D0-4B91-96C4-14188F9F5A43}.Debug|x64.Build.0 = Debug|Any CPU
124-
{3A34EA55-E4D0-4B91-96C4-14188F9F5A43}.Debug|x86.ActiveCfg = Debug|Any CPU
125-
{3A34EA55-E4D0-4B91-96C4-14188F9F5A43}.Debug|x86.Build.0 = Debug|Any CPU
126-
{3A34EA55-E4D0-4B91-96C4-14188F9F5A43}.Release|Any CPU.ActiveCfg = Release|Any CPU
127-
{3A34EA55-E4D0-4B91-96C4-14188F9F5A43}.Release|Any CPU.Build.0 = Release|Any CPU
128-
{3A34EA55-E4D0-4B91-96C4-14188F9F5A43}.Release|x64.ActiveCfg = Release|Any CPU
129-
{3A34EA55-E4D0-4B91-96C4-14188F9F5A43}.Release|x64.Build.0 = Release|Any CPU
130-
{3A34EA55-E4D0-4B91-96C4-14188F9F5A43}.Release|x86.ActiveCfg = Release|Any CPU
131-
{3A34EA55-E4D0-4B91-96C4-14188F9F5A43}.Release|x86.Build.0 = Release|Any CPU
120+
{46B6960B-5315-4050-9C88-CE9EE439B4A0}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
121+
{46B6960B-5315-4050-9C88-CE9EE439B4A0}.Debug|Any CPU.Build.0 = Debug|Any CPU
122+
{46B6960B-5315-4050-9C88-CE9EE439B4A0}.Debug|x64.ActiveCfg = Debug|Any CPU
123+
{46B6960B-5315-4050-9C88-CE9EE439B4A0}.Debug|x64.Build.0 = Debug|Any CPU
124+
{46B6960B-5315-4050-9C88-CE9EE439B4A0}.Debug|x86.ActiveCfg = Debug|Any CPU
125+
{46B6960B-5315-4050-9C88-CE9EE439B4A0}.Debug|x86.Build.0 = Debug|Any CPU
126+
{46B6960B-5315-4050-9C88-CE9EE439B4A0}.Release|Any CPU.ActiveCfg = Release|Any CPU
127+
{46B6960B-5315-4050-9C88-CE9EE439B4A0}.Release|Any CPU.Build.0 = Release|Any CPU
128+
{46B6960B-5315-4050-9C88-CE9EE439B4A0}.Release|x64.ActiveCfg = Release|Any CPU
129+
{46B6960B-5315-4050-9C88-CE9EE439B4A0}.Release|x64.Build.0 = Release|Any CPU
130+
{46B6960B-5315-4050-9C88-CE9EE439B4A0}.Release|x86.ActiveCfg = Release|Any CPU
131+
{46B6960B-5315-4050-9C88-CE9EE439B4A0}.Release|x86.Build.0 = Release|Any CPU
132132
EndGlobalSection
133133
GlobalSection(SolutionProperties) = preSolution
134134
HideSolutionNode = FALSE
@@ -140,6 +140,6 @@ Global
140140
{68D2827E-8679-4F16-B8F7-011F2DD8EF47} = {0487394E-0D5F-4D6D-83A2-26E96E7E2920}
141141
{A99ED914-A8AE-49E5-A115-D0D4FD5E1926} = {0487394E-0D5F-4D6D-83A2-26E96E7E2920}
142142
{2C7C5391-8EEA-495F-AFBE-AA8877C35F8B} = {0487394E-0D5F-4D6D-83A2-26E96E7E2920}
143-
{3A34EA55-E4D0-4B91-96C4-14188F9F5A43} = {8D56B996-E5C3-5DFA-8212-71CB87FB279F}
143+
{46B6960B-5315-4050-9C88-CE9EE439B4A0} = {8D56B996-E5C3-5DFA-8212-71CB87FB279F}
144144
EndGlobalSection
145145
EndGlobal

src/CloudService/CloudService/Az.CloudService.psd1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
#
44
# Generated by: Microsoft Corporation
55
#
6-
# Generated on: 2025-09-16
6+
# Generated on: 2025-09-17
77
#
88

99
@{

src/CloudService/CloudService/help/New-AzCloudServiceDiagnosticsExtension.md

Lines changed: 6 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -25,27 +25,15 @@ Create a in-memory object for Diagnostics Extension
2525

2626
## EXAMPLES
2727

28-
### Example 1: {{ Add title here }}
28+
### Example 1: Create diagnostics extension object
2929
```powershell
30-
{{ Add code here }}
30+
$storageAccountKey = Get-AzStorageAccountKey -ResourceGroupName "ContosOrg" -Name "ContosSA"
31+
$configFile = "<WAD configuration file path>"
32+
$extension = New-AzCloudServiceDiagnosticsExtension -Name "WADExtension" -ResourceGroupName "ContosOrg" -CloudServiceName "ContosCS" -StorageAccountName "ContosSA" -StorageAccountKey $storageAccountKey[0].Value -DiagnosticsConfigurationPath $configFile -TypeHandlerVersion "1.5" -AutoUpgradeMinorVersion $true
3133
```
3234

33-
```output
34-
{{ Add output here (remove the output block if the example doesn't have an output) }}
35-
```
36-
37-
{{ Add description here }}
38-
39-
### Example 2: {{ Add title here }}
40-
```powershell
41-
{{ Add code here }}
42-
```
43-
44-
```output
45-
{{ Add output here (remove the output block if the example doesn't have an output) }}
46-
```
47-
48-
{{ Add description here }}
35+
This command creates diagnostics extension object which is used for creating or updating a cloud service.
36+
For more details see New-AzCloudService.
4937

5038
## PARAMETERS
5139

0 commit comments

Comments
 (0)