From 014cde5e610680143ac8c4295901599d0bba080a Mon Sep 17 00:00:00 2001 From: Alfredo Santamaria Gomez Date: Tue, 24 Nov 2020 14:52:43 -0800 Subject: [PATCH] deprecate cluster cert cmdlets, update help --- src/ServiceFabric/ServiceFabric/ChangeLog.md | 4 ++++ ...dAzureRmServiceFabricClusterCertificate.cs | 1 + ...eAzureRmServiceFabricClusterCertificate.cs | 1 + .../help/Get-AzServiceFabricApplication.md | 2 +- .../Get-AzServiceFabricApplicationType.md | 2 +- ...t-AzServiceFabricApplicationTypeVersion.md | 2 +- .../help/Get-AzServiceFabricService.md | 2 +- .../help/Remove-AzServiceFabricApplication.md | 2 +- .../Remove-AzServiceFabricApplicationType.md | 2 +- ...e-AzServiceFabricApplicationTypeVersion.md | 2 +- .../help/Remove-AzServiceFabricService.md | 2 +- .../help/Set-AzServiceFabricSetting.md | 23 ++++++++++++++++++- .../help/Update-AzServiceFabricApplication.md | 2 +- 13 files changed, 37 insertions(+), 10 deletions(-) diff --git a/src/ServiceFabric/ServiceFabric/ChangeLog.md b/src/ServiceFabric/ServiceFabric/ChangeLog.md index 2dc4b18e5c47..72c449fa3208 100644 --- a/src/ServiceFabric/ServiceFabric/ChangeLog.md +++ b/src/ServiceFabric/ServiceFabric/ChangeLog.md @@ -19,6 +19,10 @@ --> ## Upcoming Release +* Add example to Set-AzServiceFabricSetting with SettingsSectionDescription param +* Update application related cmdlets to call out that support is only for ARM deployed resources +* Mark for deprecation cluster cert cmdlets Add-AzureRmServiceFabricClusterCertificate and Remove-AzureRmServiceFabricClusterCertificate + ## Version 2.2.0 * Added new cmdlets for managed clusters and node types: diff --git a/src/ServiceFabric/ServiceFabric/Commands/AddAzureRmServiceFabricClusterCertificate.cs b/src/ServiceFabric/ServiceFabric/Commands/AddAzureRmServiceFabricClusterCertificate.cs index ff958ae718a0..10a4f8d98387 100644 --- a/src/ServiceFabric/ServiceFabric/Commands/AddAzureRmServiceFabricClusterCertificate.cs +++ b/src/ServiceFabric/ServiceFabric/Commands/AddAzureRmServiceFabricClusterCertificate.cs @@ -27,6 +27,7 @@ namespace Microsoft.Azure.Commands.ServiceFabric.Commands { + [CmdletDeprecation("This cmdlet is not stable and it will be deprecated in a future release. Please follow these instructions to add certificates to the cluster: https://docs.microsoft.com/en-us/azure/service-fabric/service-fabric-cluster-security-update-certs-azure#add-a-secondary-certificate-using-azure-resource-manager")] [Cmdlet("Add", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "ServiceFabricClusterCertificate", SupportsShouldProcess = true), OutputType(typeof(PSCluster))] public class AddAzureRmServiceFabricClusterCertificate : ServiceFabricClusterCertificateCmdlet { diff --git a/src/ServiceFabric/ServiceFabric/Commands/RemoveAzureRmServiceFabricClusterCertificate.cs b/src/ServiceFabric/ServiceFabric/Commands/RemoveAzureRmServiceFabricClusterCertificate.cs index aff8e507e67b..e07a48394762 100644 --- a/src/ServiceFabric/ServiceFabric/Commands/RemoveAzureRmServiceFabricClusterCertificate.cs +++ b/src/ServiceFabric/ServiceFabric/Commands/RemoveAzureRmServiceFabricClusterCertificate.cs @@ -22,6 +22,7 @@ namespace Microsoft.Azure.Commands.ServiceFabric.Commands { + [CmdletDeprecation("This cmdlet is not stable and it will be deprecated in a future release. Please follow these instructions to remove certificates from the cluster: https://docs.microsoft.com/en-us/azure/service-fabric/service-fabric-cluster-security-update-certs-azure#remove-a-cluster-certificate-using-the-portal")] [Cmdlet("Remove", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "ServiceFabricClusterCertificate", SupportsShouldProcess = true), OutputType(typeof(PSCluster))] public class RemoveAzureRmServiceFabricClusterCertificate : ServiceFabricClusterCmdlet { diff --git a/src/ServiceFabric/ServiceFabric/help/Get-AzServiceFabricApplication.md b/src/ServiceFabric/ServiceFabric/help/Get-AzServiceFabricApplication.md index 7e2922426cdd..0e2eb04b83b5 100644 --- a/src/ServiceFabric/ServiceFabric/help/Get-AzServiceFabricApplication.md +++ b/src/ServiceFabric/ServiceFabric/help/Get-AzServiceFabricApplication.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-AzServiceFabricApplication ## SYNOPSIS -Get Service Fabric application details. +Get Service Fabric application details. Only supports ARM deployed applications. ## SYNTAX diff --git a/src/ServiceFabric/ServiceFabric/help/Get-AzServiceFabricApplicationType.md b/src/ServiceFabric/ServiceFabric/help/Get-AzServiceFabricApplicationType.md index b96a84bd565f..50eb3cc6f573 100644 --- a/src/ServiceFabric/ServiceFabric/help/Get-AzServiceFabricApplicationType.md +++ b/src/ServiceFabric/ServiceFabric/help/Get-AzServiceFabricApplicationType.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-AzServiceFabricApplicationType ## SYNOPSIS -Get Service Fabric application type details. +Get Service Fabric application type details. Only supports ARM deployed application types. ## SYNTAX diff --git a/src/ServiceFabric/ServiceFabric/help/Get-AzServiceFabricApplicationTypeVersion.md b/src/ServiceFabric/ServiceFabric/help/Get-AzServiceFabricApplicationTypeVersion.md index dc213813b569..378489e1d4fa 100644 --- a/src/ServiceFabric/ServiceFabric/help/Get-AzServiceFabricApplicationTypeVersion.md +++ b/src/ServiceFabric/ServiceFabric/help/Get-AzServiceFabricApplicationTypeVersion.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-AzServiceFabricApplicationTypeVersion ## SYNOPSIS -Get Service Fabric application type version details. +Get Service Fabric application type version details. Only supports ARM deployed application type versions. ## SYNTAX diff --git a/src/ServiceFabric/ServiceFabric/help/Get-AzServiceFabricService.md b/src/ServiceFabric/ServiceFabric/help/Get-AzServiceFabricService.md index 7ac5e0b858d8..531a4e05f259 100644 --- a/src/ServiceFabric/ServiceFabric/help/Get-AzServiceFabricService.md +++ b/src/ServiceFabric/ServiceFabric/help/Get-AzServiceFabricService.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-AzServiceFabricService ## SYNOPSIS -Get Service Fabric service details under the specified application and cluster. +Get Service Fabric service details under the specified application and cluster. Only supports ARM deployed services. ## SYNTAX diff --git a/src/ServiceFabric/ServiceFabric/help/Remove-AzServiceFabricApplication.md b/src/ServiceFabric/ServiceFabric/help/Remove-AzServiceFabricApplication.md index dd11ac160c36..626c4db423b3 100644 --- a/src/ServiceFabric/ServiceFabric/help/Remove-AzServiceFabricApplication.md +++ b/src/ServiceFabric/ServiceFabric/help/Remove-AzServiceFabricApplication.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Remove-AzServiceFabricApplication ## SYNOPSIS -Remove an application from the cluster. This will remove all the services under the application. +Remove an application from the cluster. This will remove all the services under the application. Only supports ARM deployed applications. ## SYNTAX diff --git a/src/ServiceFabric/ServiceFabric/help/Remove-AzServiceFabricApplicationType.md b/src/ServiceFabric/ServiceFabric/help/Remove-AzServiceFabricApplicationType.md index cf55ae8b0fab..1a6e460eeb92 100644 --- a/src/ServiceFabric/ServiceFabric/help/Remove-AzServiceFabricApplicationType.md +++ b/src/ServiceFabric/ServiceFabric/help/Remove-AzServiceFabricApplicationType.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Remove-AzServiceFabricApplicationType ## SYNOPSIS -Remove Service fabric an application type from the cluster. This will remove all type versions under this resource. +Remove Service fabric an application type from the cluster. This will remove all type versions under this resource. Only supports ARM deployed application types. ## SYNTAX diff --git a/src/ServiceFabric/ServiceFabric/help/Remove-AzServiceFabricApplicationTypeVersion.md b/src/ServiceFabric/ServiceFabric/help/Remove-AzServiceFabricApplicationTypeVersion.md index 05775ec1cc81..7fe7efdd657a 100644 --- a/src/ServiceFabric/ServiceFabric/help/Remove-AzServiceFabricApplicationTypeVersion.md +++ b/src/ServiceFabric/ServiceFabric/help/Remove-AzServiceFabricApplicationTypeVersion.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Remove-AzServiceFabricApplicationTypeVersion ## SYNOPSIS -Remove Service fabric an application type version from the cluster. +Remove Service fabric an application type version from the cluster. Only supports ARM deployed application type versions. ## SYNTAX diff --git a/src/ServiceFabric/ServiceFabric/help/Remove-AzServiceFabricService.md b/src/ServiceFabric/ServiceFabric/help/Remove-AzServiceFabricService.md index 3f503891acbf..d252167f3c5b 100644 --- a/src/ServiceFabric/ServiceFabric/help/Remove-AzServiceFabricService.md +++ b/src/ServiceFabric/ServiceFabric/help/Remove-AzServiceFabricService.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Remove-AzServiceFabricService ## SYNOPSIS -Remove a service from the cluster. +Remove a service from the cluster. Only supports ARM deployed services. ## SYNTAX diff --git a/src/ServiceFabric/ServiceFabric/help/Set-AzServiceFabricSetting.md b/src/ServiceFabric/ServiceFabric/help/Set-AzServiceFabricSetting.md index 7a3f90fc4a13..670ff8e77c98 100644 --- a/src/ServiceFabric/ServiceFabric/help/Set-AzServiceFabricSetting.md +++ b/src/ServiceFabric/ServiceFabric/help/Set-AzServiceFabricSetting.md @@ -32,11 +32,32 @@ Use **Set-AzServiceFabricSetting** to add or update Service Fabric settings in a ### Example 1 ``` -PS c:\> Set-AzServiceFabricSetting -ResourceGroupName 'Group1' -Name 'Contoso01SFCluster' -Section 'NamingService' -Parameter 'MaxFileOperationTimeout' -Value 5000 +Set-AzServiceFabricSetting -ResourceGroupName 'Group1' -Name 'Contoso01SFCluster' -Section 'NamingService' -Parameter 'MaxFileOperationTimeout' -Value 5000 ``` This command will set 'MaxFileOperationTimeout' to value '5000' under the section 'NamingService'. + +### Example 2 +``` +$fabricSettings = @( + @{ + "name" = "NamingService"; + "parameters" = [System.Collections.Generic.List[Microsoft.Azure.Commands.ServiceFabric.Models.PSSettingsParameterDescription]]@( + @{ "Name" = "MaxFileOperationTimeout"; "Value" = "5000" }; + @{ "Name" = "MaxOperationTimeout"; "Value" = "1200" }) + }, + @{ + "name" = "Hosting"; + "parameters" = [System.Collections.Generic.List[Microsoft.Azure.Commands.ServiceFabric.Models.PSSettingsParameterDescription]]@( + @{ "Name" = "ActivationMaxFailureCount"; "Value" = "11" }) + }) + +Set-AzServiceFabricSetting -ResourceGroupName 'Group1' -Name 'Contoso01SFCluster' -SettingsSectionDescription $fabricSettings -Verbose +``` + +This command will trigger an upgrade to set multiple fabric setting using SettingsSectionDescription parameter. + ## PARAMETERS ### -DefaultProfile diff --git a/src/ServiceFabric/ServiceFabric/help/Update-AzServiceFabricApplication.md b/src/ServiceFabric/ServiceFabric/help/Update-AzServiceFabricApplication.md index b60daded857c..c3a1d8b8e822 100644 --- a/src/ServiceFabric/ServiceFabric/help/Update-AzServiceFabricApplication.md +++ b/src/ServiceFabric/ServiceFabric/help/Update-AzServiceFabricApplication.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Update-AzServiceFabricApplication ## SYNOPSIS -Update a service fabric application. This allows to update the application parameters and/or upgrade the application type version which will trigger an application upgrade. +Update a service fabric application. This allows to update the application parameters and/or upgrade the application type version which will trigger an application upgrade. Only supports ARM deployed applications. ## SYNTAX