Skip to content

Commit ce0317b

Browse files
authored
Merge pull request #4894 from maddieclayton/fourth
Last set of help file regeneration
2 parents e00f5fa + 0c012fe commit ce0317b

File tree

363 files changed

+8486
-2462
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

363 files changed

+8486
-2462
lines changed
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
Module Name: AzureRM.ContainerInstance
3+
Module Guid:
4+
Download Help Link:
5+
Help Version:
6+
Locale: en-US
7+
---
8+
9+
# AzureRM.ContainerInstance Module
10+
## Description
11+
This topic displays help topics for the Azure Container Instance Cmdlets.
12+
13+
## AzureRM.ContainerInstance Cmdlets
14+
### [Get-AzureRmContainerGroup](Get-AzureRmContainerGroup.md)
15+
Gets container groups.
16+
17+
### [Get-AzureRmContainerInstanceLog](Get-AzureRmContainerInstanceLog.md)
18+
Get the logs of a container instance in a container group.
19+
20+
### [New-AzureRmContainerGroup](New-AzureRmContainerGroup.md)
21+
Creates a container group.
22+
23+
### [Remove-AzureRmContainerGroup](Remove-AzureRmContainerGroup.md)
24+
Removes a container group.
25+

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

Lines changed: 23 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
external help file: Microsoft.Azure.Commands.ContainerInstance.dll-Help.xml
3-
Module Name: AzureRM.ContainerInstance
3+
Module Name: AzureRM
44
online version:
55
schema: 2.0.0
66
---
@@ -14,17 +14,19 @@ Gets container groups.
1414

1515
### ListContainerGroupParamSet (Default)
1616
```
17-
Get-AzureRmContainerGroup [[-ResourceGroupName] <String>]
17+
Get-AzureRmContainerGroup [[-ResourceGroupName] <String>] [-DefaultProfile <IAzureContextContainer>]
18+
[<CommonParameters>]
1819
```
1920

2021
### GetContainerGroupInResourceGroupParamSet
2122
```
2223
Get-AzureRmContainerGroup [-ResourceGroupName] <String> [-Name] <String>
24+
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
2325
```
2426

2527
### GetContainerGroupByResourceIdParamSet
2628
```
27-
Get-AzureRmContainerGroup -ResourceId <String>
29+
Get-AzureRmContainerGroup -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
2830
```
2931

3032
## DESCRIPTION
@@ -102,6 +104,21 @@ The command gets the container group with the resource Id.
102104

103105
## PARAMETERS
104106

107+
### -DefaultProfile
108+
The credentials, account, tenant, and subscription used for communication with azure.
109+
110+
```yaml
111+
Type: IAzureContextContainer
112+
Parameter Sets: (All)
113+
Aliases: AzureRmContext, AzureCredential
114+
115+
Required: False
116+
Position: Named
117+
Default value: None
118+
Accept pipeline input: False
119+
Accept wildcard characters: False
120+
```
121+
105122
### -Name
106123
The container group Name.
107124
@@ -159,16 +176,17 @@ Accept pipeline input: True (ByPropertyName)
159176
Accept wildcard characters: False
160177
```
161178
179+
### CommonParameters
180+
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).
181+
162182
## INPUTS
163183
164184
### System.String
165185
166-
167186
## OUTPUTS
168187
169188
### Microsoft.Azure.Commands.ContainerInstance.Models.PSContainerGroup
170189
171-
172190
## NOTES
173191
174192
## RELATED LINKS

src/ResourceManager/ContainerInstance/Commands.ContainerInstance/help/Get-AzureRmContainerInstanceLog.md

Lines changed: 29 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
external help file: Microsoft.Azure.Commands.ContainerInstance.dll-Help.xml
3-
Module Name: AzureRM.ContainerInstance
3+
Module Name: AzureRM
44
online version:
55
schema: 2.0.0
66
---
@@ -12,20 +12,22 @@ Get the logs of a container instance in a container group.
1212

1313
## SYNTAX
1414

15-
### GetContainerInstanceLogByNames
15+
### GetContainerInstanceLogByNamesParamSet (Default)
1616
```
1717
Get-AzureRmContainerInstanceLog [-ResourceGroupName] <String> -ContainerGroupName <String> [-Name <String>]
18-
[-Tail <Int32>]
18+
[-Tail <Int32>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
1919
```
2020

21-
### GetContainerInstanceLogByPSContainerGroup
21+
### GetContainerInstanceLogByPSContainerGroupParamSet
2222
```
2323
Get-AzureRmContainerInstanceLog -InputContainerGroup <PSContainerGroup> [-Name <String>] [-Tail <Int32>]
24+
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
2425
```
2526

26-
### GetContainerInstanceLogByResourceId
27+
### GetContainerInstanceLogByResourceIdParamSet
2728
```
2829
Get-AzureRmContainerInstanceLog -ResourceId <String> [-Name <String>] [-Tail <Int32>]
30+
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
2931
```
3032

3133
## DESCRIPTION
@@ -86,7 +88,7 @@ The container group name.
8688

8789
```yaml
8890
Type: String
89-
Parameter Sets: GetContainerInstanceLogByNames
91+
Parameter Sets: GetContainerInstanceLogByNamesParamSet
9092
Aliases:
9193

9294
Required: True
@@ -96,12 +98,27 @@ Accept pipeline input: False
9698
Accept wildcard characters: False
9799
```
98100
101+
### -DefaultProfile
102+
The credentials, account, tenant, and subscription used for communication with azure.
103+
104+
```yaml
105+
Type: IAzureContextContainer
106+
Parameter Sets: (All)
107+
Aliases: AzureRmContext, AzureCredential
108+
109+
Required: False
110+
Position: Named
111+
Default value: None
112+
Accept pipeline input: False
113+
Accept wildcard characters: False
114+
```
115+
99116
### -InputContainerGroup
100117
The input container group object.
101118
102119
```yaml
103120
Type: PSContainerGroup
104-
Parameter Sets: GetContainerInstanceLogByPSContainerGroup
121+
Parameter Sets: GetContainerInstanceLogByPSContainerGroupParamSet
105122
Aliases:
106123

107124
Required: True
@@ -132,7 +149,7 @@ The resource group name.
132149
133150
```yaml
134151
Type: String
135-
Parameter Sets: GetContainerInstanceLogByNames
152+
Parameter Sets: GetContainerInstanceLogByNamesParamSet
136153
Aliases:
137154

138155
Required: True
@@ -147,7 +164,7 @@ The resource id.
147164
148165
```yaml
149166
Type: String
150-
Parameter Sets: GetContainerInstanceLogByResourceId
167+
Parameter Sets: GetContainerInstanceLogByResourceIdParamSet
151168
Aliases:
152169

153170
Required: True
@@ -173,16 +190,17 @@ Accept pipeline input: False
173190
Accept wildcard characters: False
174191
```
175192
193+
### CommonParameters
194+
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).
195+
176196
## INPUTS
177197
178198
### Microsoft.Azure.Commands.ContainerInstance.Models.PSContainerGroup
179199
180-
181200
## OUTPUTS
182201
183202
### System.String
184203
185-
186204
## NOTES
187205
188206
## RELATED LINKS

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

Lines changed: 33 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
external help file: Microsoft.Azure.Commands.ContainerInstance.dll-Help.xml
3-
Module Name: AzureRM.ContainerInstance
3+
Module Name: AzureRM
44
online version:
55
schema: 2.0.0
66
---
@@ -12,19 +12,21 @@ Creates a container group.
1212

1313
## SYNTAX
1414

15-
### CreateContainerGroupBaseParamSet
15+
### CreateContainerGroupBaseParamSet (Default)
1616
```
1717
New-AzureRmContainerGroup [-ResourceGroupName] <String> [-Name] <String> -Image <String> [-Location <String>]
1818
[-OsType <String>] [-Cpu <Int32>] [-MemoryInGB <Double>] [-IpAddressType <String>] [-Port <Int32>]
19-
[-Command <String>] [-EnvironmentVariable <Hashtable>] [-Tag <Hashtable>] [-WhatIf] [-Confirm]
19+
[-Command <String>] [-EnvironmentVariable <Hashtable>] [-Tag <Hashtable>]
20+
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
2021
```
2122

2223
### CreateContainerGroupWithRegistryParamSet
2324
```
2425
New-AzureRmContainerGroup [-ResourceGroupName] <String> [-Name] <String> -Image <String> [-Location <String>]
2526
[-OsType <String>] [-Cpu <Int32>] [-MemoryInGB <Double>] [-IpAddressType <String>] [-Port <Int32>]
2627
[-Command <String>] [-EnvironmentVariable <Hashtable>] [-RegistryServerDomain <String>]
27-
-RegistryCredential <PSCredential> [-Tag <Hashtable>] [-WhatIf] [-Confirm]
28+
-RegistryCredential <PSCredential> [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf]
29+
[-Confirm] [<CommonParameters>]
2830
```
2931

3032
## DESCRIPTION
@@ -141,13 +143,14 @@ Accept pipeline input: False
141143
Accept wildcard characters: False
142144
```
143145
144-
### -Confirm
145-
Prompts you for confirmation before running the cmdlet.
146+
### -Cpu
147+
The required CPU cores.
148+
Default: 1
146149
147150
```yaml
148-
Type: SwitchParameter
151+
Type: Int32
149152
Parameter Sets: (All)
150-
Aliases: cf
153+
Aliases:
151154

152155
Required: False
153156
Position: Named
@@ -156,14 +159,13 @@ Accept pipeline input: False
156159
Accept wildcard characters: False
157160
```
158161
159-
### -Cpu
160-
The required CPU cores.
161-
Default: 1
162+
### -DefaultProfile
163+
The credentials, account, tenant, and subscription used for communication with azure.
162164
163165
```yaml
164-
Type: Int32
166+
Type: IAzureContextContainer
165167
Parameter Sets: (All)
166-
Aliases:
168+
Aliases: AzureRmContext, AzureCredential
167169

168170
Required: False
169171
Position: Named
@@ -358,6 +360,21 @@ Accept pipeline input: True (ByPropertyName)
358360
Accept wildcard characters: False
359361
```
360362
363+
### -Confirm
364+
Prompts you for confirmation before running the cmdlet.
365+
366+
```yaml
367+
Type: SwitchParameter
368+
Parameter Sets: (All)
369+
Aliases: cf
370+
371+
Required: False
372+
Position: Named
373+
Default value: None
374+
Accept pipeline input: False
375+
Accept wildcard characters: False
376+
```
377+
361378
### -WhatIf
362379
Shows what would happen if the cmdlet runs.
363380
The cmdlet is not run.
@@ -374,17 +391,18 @@ Accept pipeline input: False
374391
Accept wildcard characters: False
375392
```
376393
394+
### CommonParameters
395+
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).
396+
377397
## INPUTS
378398
379399
### System.String
380400
System.Collections.Hashtable
381401
382-
383402
## OUTPUTS
384403
385404
### Microsoft.Azure.Commands.ContainerInstance.Models.PSContainerGroup
386405
387-
388406
## NOTES
389407
390408
## RELATED LINKS

0 commit comments

Comments
 (0)