Skip to content

Commit 33100ed

Browse files
LukeSlevLukeSlev
committed
Help Doc updates, changelog and module
1 parent 11bf1e5 commit 33100ed

28 files changed

+4876
-12
lines changed

‎src/ServiceFabric/ServiceFabric/Az.ServiceFabric.psd1

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,8 @@ RequiredModules = @(@{ModuleName = 'Az.Accounts'; ModuleVersion = '2.2.6'; })
5858
# Assemblies that must be loaded prior to importing this module
5959
RequiredAssemblies = 'Microsoft.Azure.KeyVault.dll',
6060
'Microsoft.Azure.KeyVault.WebKey.dll',
61-
'Microsoft.Azure.Management.ServiceFabric.dll'
61+
'Microsoft.Azure.Management.ServiceFabric.dll',
62+
'Microsoft.Azure.Management.ServiceFabricManagedClusters.dll'
6263

6364
# Script files (.ps1) that are run in the caller's environment prior to importing this module.
6465
# ScriptsToProcess = @()

‎src/ServiceFabric/ServiceFabric/ChangeLog.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,25 @@
4141
* `Update-AzServiceFabricReliability` is now able to update reliability level when the cluster has more than one primary node type.
4242
To do this, the name of the node type is supplied via the new -NodeType parameter.
4343
44+
* Added new cmdlets for managed applications:
45+
- `New-AzServiceFabricManagedClusterApplication`
46+
- `Get-AzServiceFabricManagedClusterApplication`
47+
- `Set-AzServiceFabricManagedClusterApplication`
48+
- `Remove-AzServiceFabricManagedClusterApplication`
49+
- `New-AzServiceFabricManagedClusterApplicationType`
50+
- `Get-AzServiceFabricManagedClusterApplicationType`
51+
- `Set-AzServiceFabricManagedClusterApplicationType`
52+
- `Remove-AzServiceFabricManagedClusterApplicationType`
53+
- `New-AzServiceFabricManagedClusterApplicationTypeVersion`
54+
- `Get-AzServiceFabricManagedClusterApplicationTypeVersion`
55+
- `Set-AzServiceFabricManagedClusterApplicationTypeVersion`
56+
- `Remove-AzServiceFabricManagedClusterApplicationTypeVersion`
57+
- `New-AzServiceFabricManagedClusterService`
58+
- `Get-AzServiceFabricManagedClusterService`
59+
- `Set-AzServiceFabricManagedClusterService`
60+
- `Remove-AzServiceFabricManagedClusterService`
61+
* Upgraded Managed Cluster commands to use Service Fabric Managed Cluster SDK version 1.0.0-beta.1 which uses service fabric resource provider api-version 2021-01-01-preview.
62+
4463
## Version 2.2.2
4564
* Fixed `Add-AzServiceFabricNodeType`. Added node type to service fabric cluster before creating virtual machine scale set.
4665

‎src/ServiceFabric/ServiceFabric/help/Add-AzServiceFabricManagedClusterClientCertificate.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ Accept wildcard characters: False
139139
Managed cluster resource
140140
141141
```yaml
142-
Type: Microsoft.Azure.Commands.ServiceFabric.Models.PSManagedCluster
142+
Type: Microsoft.Azure.Commands.ServiceFabric.Models.ManagedClusters.PSManagedCluster
143143
Parameter Sets: ClientCertByTpByObj, ClientCertByCnByObj
144144
Aliases:
145145

‎src/ServiceFabric/ServiceFabric/help/Add-AzServiceFabricManagedNodeTypeVMSecret.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ Accept wildcard characters: False
137137
Node Type resource
138138
139139
```yaml
140-
Type: Microsoft.Azure.Commands.ServiceFabric.Models.PSManagedNodeType
140+
Type: Microsoft.Azure.Commands.ServiceFabric.Models.ManagedClusters.PSManagedNodeType
141141
Parameter Sets: ByObj
142142
Aliases:
143143

‎src/ServiceFabric/ServiceFabric/help/Get-AzServiceFabricManagedClusterApplication.md

Lines changed: 156 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,156 @@
1+
---
2+
external help file: Microsoft.Azure.PowerShell.Cmdlets.ServiceFabric.dll-Help.xml
3+
Module Name: Az.ServiceFabric
4+
online version: https://docs.microsoft.com/powershell/module/az.servicefabric/get-azservicefabricmanagedclusterapplication
5+
schema: 2.0.0
6+
---
7+
8+
# Get-AzServiceFabricManagedClusterApplication
9+
10+
## SYNOPSIS
11+
Get Service Fabric managed application details. Only supports ARM deployed applications.
12+
13+
## SYNTAX
14+
15+
### ByResourceGroupAndCluster (Default)
16+
```
17+
Get-AzServiceFabricManagedClusterApplication [-ResourceGroupName] <String> [-ClusterName] <String>
18+
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
19+
```
20+
21+
### ByName
22+
```
23+
Get-AzServiceFabricManagedClusterApplication [-ResourceGroupName] <String> [-ClusterName] <String>
24+
[-Name] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
25+
```
26+
27+
### ByResourceId
28+
```
29+
Get-AzServiceFabricManagedClusterApplication -ResourceId <String> [-DefaultProfile <IAzureContextContainer>]
30+
[<CommonParameters>]
31+
```
32+
33+
## DESCRIPTION
34+
This cmdlet gets the managed application details in the specified resource group and cluster.
35+
36+
## EXAMPLES
37+
38+
### Example 1
39+
```powershell
40+
PS C:\> $resourceGroupName = "testRG"
41+
PS C:\> $clusterName = "testCluster"
42+
PS C:\> $appName = "testApp"
43+
PS C:\> Get-AzServiceFabricManagedClusterApplication -ResourceGroupName $resourceGroupName -ClusterName $clusterName -Name $appName
44+
```
45+
46+
This example gets the managed application resource details for the managed application "testApp".
47+
48+
### Example 2
49+
```powershell
50+
PS C:\> $resourceGroupName = "testRG"
51+
PS C:\> $clusterName = "testCluster"
52+
PS C:\> Get-AzServiceFabricManagedClusterApplication -ResourceGroupName $resourceGroupName -ClusterName $clusterName
53+
```
54+
55+
This example gets a list of the managed applications under the cluster "testCluster".
56+
57+
### Example 3
58+
```powershell
59+
PS C:\> $resourceId = "/subscriptions/13ad2c84-84fa-4798-ad71-e70c07af873f/resourcegroups/testRG/providers/Microsoft.ServiceFabric/managedClusters/testCluster/applications/testApp"
60+
PS C:\> Get-AzServiceFabricManagedClusterApplication -ResourceId $resourceId
61+
```
62+
63+
This example will get the managed application details with the ARM Resource ID specified, if it doesn't find the resource it will throw an exception.
64+
65+
66+
## PARAMETERS
67+
68+
### -ClusterName
69+
Specify the name of the cluster.
70+
71+
```yaml
72+
Type: String
73+
Parameter Sets: ByResourceGroupAndCluster, ByName
74+
Aliases:
75+
76+
Required: True
77+
Position: 1
78+
Default value: None
79+
Accept pipeline input: True (ByPropertyName)
80+
Accept wildcard characters: False
81+
```
82+
83+
### -DefaultProfile
84+
The credentials, account, tenant, and subscription used for communication with Azure.
85+
86+
```yaml
87+
Type: IAzureContextContainer
88+
Parameter Sets: (All)
89+
Aliases: AzContext, AzureRmContext, AzureCredential
90+
91+
Required: False
92+
Position: Named
93+
Default value: None
94+
Accept pipeline input: False
95+
Accept wildcard characters: False
96+
```
97+
98+
### -Name
99+
Specify the name of the managed application.
100+
101+
```yaml
102+
Type: String
103+
Parameter Sets: ByName
104+
Aliases: ApplicationName
105+
106+
Required: True
107+
Position: 2
108+
Default value: None
109+
Accept pipeline input: True (ByPropertyName)
110+
Accept wildcard characters: False
111+
```
112+
113+
### -ResourceGroupName
114+
Specify the name of the resource group.
115+
116+
```yaml
117+
Type: String
118+
Parameter Sets: ByResourceGroupAndCluster, ByName
119+
Aliases:
120+
121+
Required: True
122+
Position: 0
123+
Default value: None
124+
Accept pipeline input: True (ByPropertyName)
125+
Accept wildcard characters: False
126+
```
127+
128+
### -ResourceId
129+
Arm ResourceId of the managed application.
130+
131+
```yaml
132+
Type: String
133+
Parameter Sets: ByResourceId
134+
Aliases:
135+
136+
Required: True
137+
Position: Named
138+
Default value: None
139+
Accept pipeline input: True (ByPropertyName)
140+
Accept wildcard characters: False
141+
```
142+
143+
### CommonParameters
144+
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).
145+
146+
## INPUTS
147+
148+
### System.String
149+
150+
## OUTPUTS
151+
152+
### Microsoft.Azure.Commands.ServiceFabric.Models.ManagedClusters.PSManagedApplication
153+
154+
## NOTES
155+
156+
## RELATED LINKS

‎src/ServiceFabric/ServiceFabric/help/Get-AzServiceFabricManagedClusterApplicationType.md

Lines changed: 155 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,155 @@
1+
---
2+
external help file: Microsoft.Azure.PowerShell.Cmdlets.ServiceFabric.dll-Help.xml
3+
Module Name: Az.ServiceFabric
4+
online version: https://docs.microsoft.com/powershell/module/az.servicefabric/get-azservicefabricmanagedclusterapplicationtype
5+
schema: 2.0.0
6+
---
7+
8+
# Get-AzServiceFabricManagedClusterApplicationType
9+
10+
## SYNOPSIS
11+
Get Service Fabric managed application type details. Only supports ARM deployed application types.
12+
13+
## SYNTAX
14+
15+
### ByResourceGroupAndCluster (Default)
16+
```
17+
Get-AzServiceFabricManagedClusterApplicationType [-ResourceGroupName] <String> [-ClusterName] <String>
18+
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
19+
```
20+
21+
### ByName
22+
```
23+
Get-AzServiceFabricManagedClusterApplicationType [-ResourceGroupName] <String> [-ClusterName] <String>
24+
[-Name] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
25+
```
26+
27+
### ByResourceId
28+
```
29+
Get-AzServiceFabricManagedClusterApplicationType -ResourceId <String>
30+
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
31+
```
32+
33+
## DESCRIPTION
34+
Use this cmdlet to get the managed application type details in the specified resource group and cluster.
35+
36+
## EXAMPLES
37+
38+
### Example 1
39+
```powershell
40+
PS C:\> $resourceGroupName = "testRG"
41+
PS C:\> $clusterName = "testCluster"
42+
PS C:\> $appTypeName = "testAppType"
43+
PS C:\> Get-AzServiceFabricManagedClusterApplicationType -ResourceGroupName $resourceGroupName -ClusterName $clusterName -Name $appTypeName
44+
```
45+
46+
This example will get the managed application type details with the parameters specified, if it doesn't find the resource it will throw an exception.
47+
48+
### Example 2
49+
```powershell
50+
PS C:\> $resourceGroupName = "testRG"
51+
PS C:\> $clusterName = "testCluster"
52+
PS C:\> Get-AzServiceFabricManagedClusterApplicationType -ResourceGroupName $resourceGroupName -ClusterName $clusterName
53+
```
54+
55+
This example will get a list of the managed application types defined under the specified cluster.
56+
57+
### Example 3
58+
```powershell
59+
PS C:\> $resourceId = "/subscriptions/13ad2c84-84fa-4798-ad71-e70c07af873f/resourcegroups/testRG/providers/Microsoft.ServiceFabric/managedClusters/testCluster/applicationTypes/testAppType"
60+
PS C:\> Get-AzServiceFabricManagedClusterApplicationType -ResourceId $resourceId
61+
```
62+
63+
This example will get the managed application type details with the ARM Resource ID specified, if it doesn't find the resource it will throw an exception.
64+
65+
## PARAMETERS
66+
67+
### -ClusterName
68+
Specify the name of the cluster.
69+
70+
```yaml
71+
Type: String
72+
Parameter Sets: ByResourceGroupAndCluster, ByName
73+
Aliases:
74+
75+
Required: True
76+
Position: 1
77+
Default value: None
78+
Accept pipeline input: True (ByPropertyName)
79+
Accept wildcard characters: False
80+
```
81+
82+
### -DefaultProfile
83+
The credentials, account, tenant, and subscription used for communication with Azure.
84+
85+
```yaml
86+
Type: IAzureContextContainer
87+
Parameter Sets: (All)
88+
Aliases: AzContext, AzureRmContext, AzureCredential
89+
90+
Required: False
91+
Position: Named
92+
Default value: None
93+
Accept pipeline input: False
94+
Accept wildcard characters: False
95+
```
96+
97+
### -Name
98+
Specify the name of the managed application type
99+
100+
```yaml
101+
Type: String
102+
Parameter Sets: ByName
103+
Aliases: ApplicationTypeName
104+
105+
Required: True
106+
Position: 2
107+
Default value: None
108+
Accept pipeline input: True (ByValue)
109+
Accept wildcard characters: False
110+
```
111+
112+
### -ResourceGroupName
113+
Specify the name of the resource group.
114+
115+
```yaml
116+
Type: String
117+
Parameter Sets: ByResourceGroupAndCluster, ByName
118+
Aliases:
119+
120+
Required: True
121+
Position: 0
122+
Default value: None
123+
Accept pipeline input: True (ByPropertyName)
124+
Accept wildcard characters: False
125+
```
126+
127+
### -ResourceId
128+
Arm ResourceId of the managed application type.
129+
130+
```yaml
131+
Type: String
132+
Parameter Sets: ByResourceId
133+
Aliases:
134+
135+
Required: True
136+
Position: Named
137+
Default value: None
138+
Accept pipeline input: True (ByPropertyName)
139+
Accept wildcard characters: False
140+
```
141+
142+
### CommonParameters
143+
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).
144+
145+
## INPUTS
146+
147+
### System.String
148+
149+
## OUTPUTS
150+
151+
### Microsoft.Azure.Commands.ServiceFabric.Models.ManagedClusters.PSManagedApplicationType
152+
153+
## NOTES
154+
155+
## RELATED LINKS

0 commit comments

Comments
 (0)