Skip to content

Commit b382344

Browse files
committed
updated_remove_cg_helper_doc
1 parent c1f68b9 commit b382344

File tree

1 file changed

+59
-10
lines changed

1 file changed

+59
-10
lines changed

src/ResourceManager/ContainerInstance/Commands.ContainerInstance/help/Remove-AzureRmContainerGroup.md

Lines changed: 59 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,19 @@ Removes a container group.
1212

1313
## SYNTAX
1414

15+
### RemoveContainerGroupByResourceGroupAndNameParamSet
1516
```
16-
Remove-AzureRmContainerGroup [-ResourceGroupName] <String> [-Name] <String>
17+
Remove-AzureRmContainerGroup [-ResourceGroupName] <String> [-Name] <String> [-WhatIf] [-Confirm]
18+
```
19+
20+
### RemoveContainerGroupByPSContainerGroupParamSet
21+
```
22+
Remove-AzureRmContainerGroup -InputObject <PSContainerGroup> [-WhatIf] [-Confirm]
23+
```
24+
25+
### RemoveContainerGroupByResourceIdParamSet
26+
```
27+
Remove-AzureRmContainerGroup -ResourceId <String> [-WhatIf] [-Confirm]
1728
```
1829

1930
## DESCRIPTION
@@ -35,14 +46,51 @@ PS C:\> Get-AzureRmContainerGroup -ResourceGroupName MyResourceGroup -Name MyCon
3546

3647
This command removes a container group by piping.
3748

49+
### Example 3: Removes a container group by resource Id.
50+
```
51+
PS C:\> Find-AzureRmResource -ResourceGroupEquals MyResourceGroup -ResourceNameEquals MyContainer | Remove-AzureRmContainerGroup
52+
```
53+
54+
This command removes a container group by resource Id.
55+
3856
## PARAMETERS
3957

58+
### -Confirm
59+
Prompts you for confirmation before running the cmdlet.
60+
61+
```yaml
62+
Type: SwitchParameter
63+
Parameter Sets: (All)
64+
Aliases: cf
65+
66+
Required: False
67+
Position: Named
68+
Default value: None
69+
Accept pipeline input: False
70+
Accept wildcard characters: False
71+
```
72+
73+
### -InputObject
74+
The container group to remove.
75+
76+
```yaml
77+
Type: PSContainerGroup
78+
Parameter Sets: RemoveContainerGroupByPSContainerGroupParamSet
79+
Aliases:
80+
81+
Required: True
82+
Position: Named
83+
Default value: None
84+
Accept pipeline input: True (ByValue)
85+
Accept wildcard characters: False
86+
```
87+
4088
### -Name
4189
The container group name.
4290
4391
```yaml
4492
Type: String
45-
Parameter Sets: (All)
93+
Parameter Sets: RemoveContainerGroupByResourceGroupAndNameParamSet
4694
Aliases:
4795

4896
Required: True
@@ -57,7 +105,7 @@ The resource group name.
57105
58106
```yaml
59107
Type: String
60-
Parameter Sets: (All)
108+
Parameter Sets: RemoveContainerGroupByResourceGroupAndNameParamSet
61109
Aliases:
62110

63111
Required: True
@@ -67,18 +115,18 @@ Accept pipeline input: True (ByPropertyName)
67115
Accept wildcard characters: False
68116
```
69117
70-
### -Confirm
71-
Prompts you for confirmation before running the cmdlet.
118+
### -ResourceId
119+
The resource id.
72120
73121
```yaml
74-
Type: SwitchParameter
75-
Parameter Sets: (All)
76-
Aliases: cf
122+
Type: String
123+
Parameter Sets: RemoveContainerGroupByResourceIdParamSet
124+
Aliases:
77125

78-
Required: False
126+
Required: True
79127
Position: Named
80128
Default value: None
81-
Accept pipeline input: False
129+
Accept pipeline input: True (ByPropertyName)
82130
Accept wildcard characters: False
83131
```
84132
@@ -101,6 +149,7 @@ Accept wildcard characters: False
101149
## INPUTS
102150
103151
### System.String
152+
Microsoft.Azure.Commands.ContainerInstance.Models.PSContainerGroup
104153
105154
106155
## OUTPUTS

0 commit comments

Comments
 (0)