Skip to content

Commit 5d5311b

Browse files
committed
fix md files
1 parent 0a865b4 commit 5d5311b

20 files changed

+769
-342
lines changed
Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
<!--
2+
Please leave this section at the top of the change log.
3+
4+
Changes for the current release should go under the section titled "Current Release", and should adhere to the following format:
5+
6+
## Current Release
7+
* Overview of change #1
8+
- Additional information about change #1
9+
* Overview of change #2
10+
- Additional information about change #2
11+
- Additional information about change #2
12+
* Overview of change #3
13+
* Overview of change #4
14+
- Additional information about change #4
15+
16+
## YYYY.MM.DD - Version X.Y.Z (Previous Release)
17+
* Overview of change #1
18+
- Additional information about change #1
19+
-->
20+
## Current Release
21+
22+
## Version 0.1.0
23+
* Added cmdlets for service fabric
24+
* New cmdlet
25+
- Add-AzureRmServiceFabricApplicationCertificate
26+
Add a certificate which will be used as application certificate
27+
- Add-AzureRmServiceFabricClientCertificate
28+
Add a common name or thumbprint to the cluster settings for client authentication
29+
- Add-AzureRmServiceFabricClusterCertificate
30+
Add a secondary cluster certificate to the cluster for rolling over the existing certificate
31+
- Add-AzureRmServiceFabricNodes
32+
Add nodes/VMs of a specific node type to a cluster
33+
- Add-AzureRmServiceFabricNodeType
34+
Add a node type/VMs to an existing cluster
35+
- Get-AzureRmServiceFabricCluster
36+
Get the details of the cluster resource
37+
- New-AzureRmServiceFabricCluster
38+
Create a new ServiceFabric cluster. This command has many overloads to cover various scenarios
39+
- Remove-AzureRmServiceFabricClientCertificate
40+
Remove a client certificate from being used to access a cluster
41+
- Remove-AzureRmServiceFabricClusterCertificate
42+
Remove a cluster certificate from being used for cluster security
43+
- Remove-AzureRmServiceFabricNodes
44+
Remove nodes from a specific node type from a cluster
45+
- Remove-AzureRmServiceFabricNodeType
46+
Remove a node type from a cluster
47+
- Remove-AzureRmServiceFabricSettings
48+
Remove one or more ServiceFabric settings from a cluster
49+
- Set-AzureRmServiceFabricSettings
50+
Add or update one or more ServiceFabric settings of a cluster
51+
- Set-AzureRmServiceFabricUpgradeType
52+
Change the ServiceFabric upgrade type of a cluster
53+
- Update-AzureRmServiceFabricDurability
54+
Change the durability tier of a cluster
55+
- Update-AzureRmServiceFabricReliability
56+
Change the reliability tier of a cluster

src/ResourceManager/ServiceFabric/Commands.ServiceFabric/Commands/NewAzureRmServiceFabricCluster.cs

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -157,20 +157,20 @@ public override string KeyVaultResouceGroupLocation
157157
public virtual SecureString SecondaryCertificatePassword { get; set; }
158158

159159
[Parameter(Mandatory = false, ValueFromPipeline = true, ParameterSetName = ByNewPfxAndVaultName,
160-
HelpMessage = "Azure key vault resource group name, it not given it will be same as resource group name")]
160+
HelpMessage = "Azure key vault resource group name, it not given it will be defaulted to resource group name")]
161161
[Parameter(Mandatory = false, ValueFromPipeline = true, ParameterSetName = ByExistingPfxAndVaultName,
162-
HelpMessage = "Azure key vault resource group name, it not given it will be same as resource group name")]
162+
HelpMessage = "Azure key vault resource group name, it not given it will be defaulted to resource group name")]
163163
[Parameter(Mandatory = false, ValueFromPipeline = true, ParameterSetName = ByDefaultArmTemplate,
164-
HelpMessage = "Azure key vault resource group name, it not given it will be same as resource group name")]
164+
HelpMessage = "Azure key vault resource group name, it not given it will be defaulted to resource group name")]
165165
[ValidateNotNullOrEmpty]
166166
public override string KeyVaultResouceGroupName { get; set; }
167167

168168
[Parameter(Mandatory = false, ValueFromPipeline = true, ParameterSetName = ByNewPfxAndVaultName,
169-
HelpMessage = "Azure key vault name, it not given it will be same as resource group name")]
169+
HelpMessage = "Azure key vault name, it not given it will be defaulted to the resource group name")]
170170
[Parameter(Mandatory = false, ValueFromPipeline = true, ParameterSetName = ByExistingPfxAndVaultName,
171-
HelpMessage = "Azure key vault name, it not given it will be same as resource group name")]
171+
HelpMessage = "Azure key vault name, it not given it will be defaulted to the resource group name")]
172172
[Parameter(Mandatory = false, ValueFromPipeline = true, ParameterSetName = ByDefaultArmTemplate,
173-
HelpMessage = "Azure key vault name, it not given it will be same as resource group name")]
173+
HelpMessage = "Azure key vault name, it not given it will be defaulted to the resource group name")]
174174
[ValidateNotNullOrEmpty]
175175
public override string KeyVaultName { get; set; }
176176

@@ -234,7 +234,7 @@ public override string CertificateSubjectName
234234

235235
private OperatingSystem os = OperatingSystem.WindowsServer2016Datacenter;
236236
[Parameter(Mandatory = false, ParameterSetName = ByDefaultArmTemplate, ValueFromPipelineByPropertyName = true,
237-
HelpMessage = "The OS type of the cluster")]
237+
HelpMessage = "The Operating System of the VMs that make up the cluster.")]
238238
[Alias("VmImage")]
239239
public OperatingSystem OS
240240
{

src/ResourceManager/ServiceFabric/Commands.ServiceFabric/Commands/ServiceFabricClusterCertificateCmdlet.cs

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -73,47 +73,47 @@ public abstract class ServiceFabricClusterCertificateCmdlet : ServiceFabricClust
7373
public override string Name { get; set; }
7474

7575
[Parameter(Mandatory = false, ValueFromPipeline = true, ParameterSetName = ByNewPfxAndVaultName,
76-
HelpMessage = "Azure key vault resource group name")]
76+
HelpMessage = "Azure key vault resource group name, it not given it will be defaulted to resource group name")]
7777
[Parameter(Mandatory = false, ValueFromPipeline = true, ParameterSetName = ByExistingPfxAndVaultName,
78-
HelpMessage = "Azure key vault resource group name")]
78+
HelpMessage = "Azure key vault resource group name, it not given it will be defaulted to resource group name")]
7979
[ValidateNotNullOrEmpty]
8080
public virtual string KeyVaultResouceGroupName { get; set; }
8181

8282
[Parameter(Mandatory = false, ValueFromPipeline = true, ParameterSetName = ByNewPfxAndVaultName,
83-
HelpMessage = "Azure key vault name")]
83+
HelpMessage = "Azure key vault name, it not given it will be defaulted to the resource group name")]
8484
[Parameter(Mandatory = false, ValueFromPipeline = true, ParameterSetName = ByExistingPfxAndVaultName,
85-
HelpMessage = "Azure key vault name")]
85+
HelpMessage = "Azure key vault name, it not given it will be defaulted to the resource group name")]
8686
[ValidateNotNullOrEmpty]
8787
public virtual string KeyVaultName { get; set; }
8888

8989
[Parameter(Mandatory = true, ValueFromPipeline = true, ParameterSetName = ExistingKeyVault,
90-
HelpMessage = "The existing Azure key vault secret URL")]
90+
HelpMessage = "The existing Azure key vault secret URL, for example 'https://mykv.vault.azure.net:443/secrets/mysecrets/55ec7c4dc61a462bbc645ffc9b4b225f'")]
9191
[ValidateNotNullOrEmpty]
9292
public string SecretIdentifier { get; set; }
9393

9494
[Parameter(Mandatory = true, ValueFromPipeline = true, ParameterSetName = ByExistingPfxAndVaultName,
95-
HelpMessage = "The existing certificate file path")]
95+
HelpMessage = "The path to the existing certificate")]
9696
[ValidateNotNullOrEmpty]
9797
[Alias("Source")]
9898
public virtual string CertificateFile { get; set; }
9999

100100
[Parameter(Mandatory = false, ValueFromPipeline = true, ParameterSetName = ByNewPfxAndVaultName,
101-
HelpMessage = "The folder path of the new certificate to be created")]
101+
HelpMessage = "The folder where the new certificate needs to be downloaded.")]
102102
[ValidateNotNullOrEmpty]
103103
[Alias("Destination")]
104104
public virtual string CertificateOutputFolder { get; set; }
105105

106106
[Parameter(Mandatory = false, ValueFromPipeline = true, ParameterSetName = ByExistingPfxAndVaultName,
107-
HelpMessage = "The password of the certificate file")]
107+
HelpMessage = "The password of the certificate")]
108108
[Parameter(Mandatory = false, ValueFromPipeline = true, ParameterSetName = ByNewPfxAndVaultName,
109-
HelpMessage = "The password of the certificate file")]
109+
HelpMessage = "The password of the certificate")]
110110
[ValidateNotNullOrEmpty]
111111
[Alias("CertPassword")]
112112
public virtual SecureString CertificatePassword { get; set; }
113113

114114
private string certificateSubjectName;
115115
[Parameter(Mandatory = true, ValueFromPipeline = true, ParameterSetName = ByNewPfxAndVaultName,
116-
HelpMessage = "The subject name of the certificate to be created")]
116+
HelpMessage = "The subject name of the certificate")]
117117
[ValidateNotNullOrEmpty]
118118
[Alias("Subject")]
119119
public virtual string CertificateSubjectName

src/ResourceManager/ServiceFabric/Commands.ServiceFabric/help/Add-AzureRmServiceFabricApplicationCertificate.md

Lines changed: 34 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -40,21 +40,50 @@ You can specify a certificate you already have or have the system generate an ne
4040

4141
### Example 1
4242
```
43-
PS c:> Add-AzureRmServiceFabricApplicationCertificate -ResourceGroupName 'Group1' -ClusterName 'Contoso01SFCluster' -SecretIdentifier 'https://contoso03vault.vault.azure.net/secrets/contoso03vaultrg/7f7de9131c034172b9df37ccc549524f'
43+
PS c:> Add-AzureRmServiceFabricApplicationCertificate -ResourceGroupName 'Group1' -Name 'Contoso01SFCluster' -SecretIdentifier 'https://contoso03vault.vault.azure.net/secrets/contoso03vaultrg/7f7de9131c034172b9df37ccc549524f'
4444
```
4545

4646
This command will add a certificate from existing Azure key vault to all node types of the cluster named Contoso01SFCluster
4747

4848
### Example 2
4949
```
50-
PS c:\> $pwd = ConvertTo-SecureString -String "123" -AsPlainText -Force
51-
PS C:\> Add-AzureRmServiceFabricApplicationCertificate -ResourceGroupName 'Group2' -ClusterName 'Contoso02SFCluster' -KeyVaultName 'Contoso02Vault' -KeyVaultResouceGroupName 'Contoso02VaultRg'
50+
PS c:\> $pwd = ConvertTo-SecureString -String '123' -AsPlainText -Force
51+
PS C:\> Add-AzureRmServiceFabricApplicationCertificate -ResourceGroupName 'Group2' -Name 'Contoso02SFCluster' -KeyVaultName 'Contoso02Vault' -KeyVaultResouceGroupName 'Contoso02VaultRg'
52+
-CertificateSubjectName 'cn=Contoso.com' -CertificateOutputFolder 'c:\test' -CertificatePassword $pwd
5253
```
5354

54-
This command will add certificate by creating an new self signed certificate and uploading to Azure key vault, then installs to all node types of the cluster
55+
This command will create certificate in Azure key vault, then installs to all node types of the cluster, and download the certificate to c:\test
5556

5657
## PARAMETERS
5758

59+
### -CertificateFile
60+
The existing certificate file path
61+
62+
```yaml
63+
Type: String
64+
Parameter Sets: ByExistingPfxAndVaultName
65+
Aliases: Source
66+
67+
Required: True
68+
Position: Named
69+
Default value: None
70+
Accept pipeline input: True (ByValue)
71+
Accept wildcard characters: False
72+
```
73+
74+
### -CertificateOutputFolder
75+
The folder path of the new certificate to be created```yaml
76+
Type: String
77+
Parameter Sets: ByNewPfxAndVaultName
78+
Aliases: Destination
79+
80+
Required: False
81+
Position: Named
82+
Default value: None
83+
Accept pipeline input: True (ByValue)
84+
Accept wildcard characters: False
85+
```
86+
5887
### -CertificatePassword
5988
The password of the pfx file
6089
@@ -144,7 +173,7 @@ Accept wildcard characters: False
144173
```
145174
146175
### -ResourceGroupName
147-
Specifies the name of the resource group.
176+
Specify the name of the resource group.
148177
149178
```yaml
150179
Type: String
@@ -188,32 +217,6 @@ Accept pipeline input: False
188217
Accept wildcard characters: False
189218
```
190219
191-
### -CertificateFile
192-
The existing certificate file path```yaml
193-
Type: String
194-
Parameter Sets: ByExistingPfxAndVaultName
195-
Aliases: Source
196-
197-
Required: True
198-
Position: Named
199-
Default value: None
200-
Accept pipeline input: True (ByValue)
201-
Accept wildcard characters: False
202-
```
203-
204-
### -CertificateOutputFolder
205-
The folder path of the new certificate to be created```yaml
206-
Type: String
207-
Parameter Sets: ByNewPfxAndVaultName
208-
Aliases: Destination
209-
210-
Required: False
211-
Position: Named
212-
Default value: None
213-
Accept pipeline input: True (ByValue)
214-
Accept wildcard characters: False
215-
```
216-
217220
### CommonParameters
218221
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
219222

0 commit comments

Comments
 (0)