Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[ServiceFabric] Deprecate cluster cert cmdlets, update help #13581

Merged
merged 1 commit into from
Nov 25, 2020
Merged

[ServiceFabric] Deprecate cluster cert cmdlets, update help #13581

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions src/ServiceFabric/ServiceFabric/ChangeLog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
1 change: 1 addition & 0 deletions src/ServiceFabric/ServiceFabric/Commands/AddAzureRmServiceFabricClusterCertificate.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand Down
1 change: 1 addition & 0 deletions src/ServiceFabric/ServiceFabric/Commands/RemoveAzureRmServiceFabricClusterCertificate.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand Down
2 changes: 1 addition & 1 deletion src/ServiceFabric/ServiceFabric/help/Get-AzServiceFabricApplication.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion src/ServiceFabric/ServiceFabric/help/Get-AzServiceFabricApplicationType.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion src/ServiceFabric/ServiceFabric/help/Get-AzServiceFabricApplicationTypeVersion.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion src/ServiceFabric/ServiceFabric/help/Get-AzServiceFabricService.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion src/ServiceFabric/ServiceFabric/help/Remove-AzServiceFabricApplication.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion src/ServiceFabric/ServiceFabric/help/Remove-AzServiceFabricApplicationType.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion ...erviceFabric/ServiceFabric/help/Remove-AzServiceFabricApplicationTypeVersion.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion src/ServiceFabric/ServiceFabric/help/Remove-AzServiceFabricService.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
23 changes: 22 additions & 1 deletion src/ServiceFabric/ServiceFabric/help/Set-AzServiceFabricSetting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/ServiceFabric/ServiceFabric/help/Update-AzServiceFabricApplication.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down