Skip to content

Commit a90e15b

Browse files
yolocsyolocs
committed
updated help
1 parent d775d65 commit a90e15b

File tree

5 files changed

+160
-25
lines changed

5 files changed

+160
-25
lines changed

‎src/ResourceManager/ContainerInstance/Commands.ContainerInstance/help/AzureRM.ContainerInstance.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
---
1+
---
22
Module Name: AzureRM.ContainerInstance
3-
Module Guid:
4-
Download Help Link:
5-
Help Version:
3+
Module Guid:
4+
Download Help Link:
5+
Help Version:
66
Locale: en-US
77
---
88

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

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
---
1+
---
22
external help file: Microsoft.Azure.Commands.ContainerInstance.dll-Help.xml
3-
Module Name: AzureRM
3+
Module Name: AzureRM.ContainerInstance
44
online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.containerinstance/get-azurermcontainergroup
55
schema: 2.0.0
66
---
@@ -52,6 +52,8 @@ IpAddress : 13.88.10.240
5252
Ports : {8000}
5353
OsType : Linux
5454
Volumes :
55+
State : Running
56+
Events : {}
5557
```
5658

5759
The command gets the specified container group.
@@ -98,6 +100,8 @@ IpAddress : 13.88.10.240
98100
Ports : {8000}
99101
OsType : Linux
100102
Volumes :
103+
State : Running
104+
Events : {}
101105
```
102106

103107
The command gets the container group with the resource Id.

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
---
1+
---
22
external help file: Microsoft.Azure.Commands.ContainerInstance.dll-Help.xml
3-
Module Name: AzureRM
3+
Module Name: AzureRM.ContainerInstance
44
online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.containerinstance/get-azurermcontainerinstancelog
55
schema: 2.0.0
66
---

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

Lines changed: 146 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
---
1+
---
22
external help file: Microsoft.Azure.Commands.ContainerInstance.dll-Help.xml
3-
Module Name: AzureRM
3+
Module Name: AzureRM.ContainerInstance
44
online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.containerinstance/new-azurermcontainergroup
55
schema: 2.0.0
66
---
@@ -15,28 +15,38 @@ Creates a container group.
1515
### CreateContainerGroupBaseParamSet (Default)
1616
```
1717
New-AzureRmContainerGroup [-ResourceGroupName] <String> [-Name] <String> -Image <String> [-Location <String>]
18-
[-OsType <String>] [-Cpu <Int32>] [-MemoryInGB <Double>] [-IpAddressType <String>] [-Port <Int32>]
19-
[-Command <String>] [-EnvironmentVariable <Hashtable>] [-Tag <Hashtable>]
18+
[-OsType <String>] [-RestartPolicy <String>] [-Cpu <Int32>] [-MemoryInGB <Double>] [-IpAddressType <String>]
19+
[-Ports <Int32[]>] [-Command <String>] [-EnvironmentVariable <Hashtable>] [-Tag <Hashtable>]
2020
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
2121
```
2222

2323
### CreateContainerGroupWithRegistryParamSet
2424
```
2525
New-AzureRmContainerGroup [-ResourceGroupName] <String> [-Name] <String> -Image <String> [-Location <String>]
26-
[-OsType <String>] [-Cpu <Int32>] [-MemoryInGB <Double>] [-IpAddressType <String>] [-Port <Int32>]
27-
[-Command <String>] [-EnvironmentVariable <Hashtable>] [-RegistryServerDomain <String>]
26+
[-OsType <String>] [-RestartPolicy <String>] [-Cpu <Int32>] [-MemoryInGB <Double>] [-IpAddressType <String>]
27+
[-Ports <Int32[]>] [-Command <String>] [-EnvironmentVariable <Hashtable>] [-RegistryServerDomain <String>]
2828
-RegistryCredential <PSCredential> [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf]
2929
[-Confirm] [<CommonParameters>]
3030
```
3131

32+
### CreateContainerGroupWithAzureFileMountParamSet
33+
```
34+
New-AzureRmContainerGroup [-ResourceGroupName] <String> [-Name] <String> -Image <String> [-Location <String>]
35+
[-OsType <String>] [-RestartPolicy <String>] [-Cpu <Int32>] [-MemoryInGB <Double>] [-IpAddressType <String>]
36+
[-Ports <Int32[]>] [-Command <String>] [-EnvironmentVariable <Hashtable>] -AzureFileVolumeShareName <String>
37+
-AzureFileVolumeAccountName <String> -AzureFileVolumeAccountKey <PSCredential>
38+
-AzureFileVolumeMountPath <String> [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf]
39+
[-Confirm] [<CommonParameters>]
40+
```
41+
3242
## DESCRIPTION
3343
The **New-AzureRmContainerGroup** cmdlets creates a container group.
3444

3545
## EXAMPLES
3646

3747
### Example 1
3848
```
39-
PS C:\> New-AzureRmContainerGroup -ResourceGroupName demo -Name mycontainer -Image nginx -OsType Linux -IpAddressType Public -Port 8000
49+
PS C:\> New-AzureRmContainerGroup -ResourceGroupName demo -Name mycontainer -Image nginx -OsType Linux -IpAddressType Public -Ports @(8000)
4050
4151
ResourceGroupName : demo
4252
Id : /subscriptions/ae43b1e3-c35d-4c8c-bc0d-f148b4c52b78/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/mycontainer
@@ -52,6 +62,8 @@ IpAddress : 13.88.10.240
5262
Ports : {8000}
5363
OsType : Linux
5464
Volumes :
65+
State : Running
66+
Events : {}
5567
```
5668

5769
This commands creates a container group using latest nginx image and requests a public IP address with opening port 8000.
@@ -74,11 +86,37 @@ IpAddress :
7486
Ports :
7587
OsType : Linux
7688
Volumes :
89+
State : Running
90+
Events : {}
7791
```
7892

7993
This commands creates a container group and runs a custom script inside the container.
8094

81-
### Example 3: Creates a container group using image in Azure Container Registry
95+
### Example 3: Creates a run-to-completion container group.
96+
```
97+
PS C:\> New-AzureRmContainerGroup -ResourceGroupName demo -Name mycontainer -Image alpine -OsType Linux -Command "echo hello" -RestartPolicy Never
98+
99+
ResourceGroupName : demo
100+
Id : /subscriptions/ae43b1e3-c35d-4c8c-bc0d-f148b4c52b78/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/mycontainer
101+
Name : mycontainer
102+
Type : Microsoft.ContainerInstance/containerGroups
103+
Location : westus
104+
Tags :
105+
ProvisioningState : Creating
106+
Containers : {mycontainer}
107+
ImageRegistryCredentials :
108+
RestartPolicy :
109+
IpAddress :
110+
Ports :
111+
OsType : Linux
112+
Volumes :
113+
State : Running
114+
Events : {}
115+
```
116+
117+
This commands creates a container group which prints out 'hello' and stops.
118+
119+
### Example 4: Creates a container group using image in Azure Container Registry
82120
```
83121
PS C:\> $secpasswd = ConvertTo-SecureString "PlainTextPassword" -AsPlainText -Force
84122
PS C:\> $mycred = New-Object System.Management.Automation.PSCredential ("myacr", $secpasswd)
@@ -98,11 +136,13 @@ IpAddress : 13.88.10.240
98136
Ports : {80}
99137
OsType : Linux
100138
Volumes :
139+
State : Running
140+
Events : {}
101141
```
102142

103143
This commands creates a container group using a nginx image in Azure Container Registry.
104144

105-
### Example 4: Creates a container group using image in custom container image registry
145+
### Example 5: Creates a container group using image in custom container image registry
106146
```
107147
PS C:\> $secpasswd = ConvertTo-SecureString "PlainTextPassword" -AsPlainText -Force
108148
PS C:\> $mycred = New-Object System.Management.Automation.PSCredential ("username", $secpasswd)
@@ -122,12 +162,92 @@ IpAddress : 13.88.10.240
122162
Ports : {80}
123163
OsType : Linux
124164
Volumes :
165+
State : Running
166+
Events : {}
125167
```
126168

127169
This commands creates a container group using a custom image from a custom container image registry.
128170

171+
### Example 6: Creates a container group that mounts Azure File volume
172+
```
173+
PS C:\> $secpasswd = ConvertTo-SecureString "PlainTextPassword" -AsPlainText -Force
174+
PS C:\> $mycred = New-Object System.Management.Automation.PSCredential ("username", $secpasswd)
175+
PS C:\> New-AzureRmContainerGroup -ResourceGroupName MyResourceGroup -Name MyContainer -Image alpine -AzureFileVolumeShareName myshare -AzureFileVolumeAccountName mystorage -AzureFileVolumeAccountKey $mycred -AzureFileVolumeMountPath /mnt/azfile
176+
177+
ResourceGroupName : demo
178+
Id : /subscriptions/ae43b1e3-c35d-4c8c-bc0d-f148b4c52b78/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/mycontainer
179+
Name : mycontainer
180+
Type : Microsoft.ContainerInstance/containerGroups
181+
Location : westus
182+
Tags :
183+
ProvisioningState : Creating
184+
Containers : {mycontainer}
185+
ImageRegistryCredentials : {myserver.com}
186+
RestartPolicy :
187+
IpAddress : 13.88.10.240
188+
Ports : {80}
189+
OsType : Linux
190+
Volumes : {AzureFile}
191+
State : Running
192+
Events : {}
193+
```
194+
195+
This commands creates a container group that mounts the provided Azure File share to `/mnt/azfile`.
196+
129197
## PARAMETERS
130198

199+
### -AzureFileVolumeAccountKey
200+
The storage account key of the Azure File share to mount.```yaml
201+
Type: PSCredential
202+
Parameter Sets: CreateContainerGroupWithAzureFileMountParamSet
203+
Aliases:
204+
205+
Required: True
206+
Position: Named
207+
Default value: None
208+
Accept pipeline input: False
209+
Accept wildcard characters: False
210+
```
211+
212+
### -AzureFileVolumeAccountName
213+
The storage account name of the Azure File share to mount.```yaml
214+
Type: String
215+
Parameter Sets: CreateContainerGroupWithAzureFileMountParamSet
216+
Aliases:
217+
218+
Required: True
219+
Position: Named
220+
Default value: None
221+
Accept pipeline input: False
222+
Accept wildcard characters: False
223+
```
224+
225+
### -AzureFileVolumeMountPath
226+
The mount path for the Azure File volume.```yaml
227+
Type: String
228+
Parameter Sets: CreateContainerGroupWithAzureFileMountParamSet
229+
Aliases:
230+
231+
Required: True
232+
Position: Named
233+
Default value: None
234+
Accept pipeline input: False
235+
Accept wildcard characters: False
236+
```
237+
238+
### -AzureFileVolumeShareName
239+
The name of the Azure File share to mount.```yaml
240+
Type: String
241+
Parameter Sets: CreateContainerGroupWithAzureFileMountParamSet
242+
Aliases:
243+
244+
Required: True
245+
Position: Named
246+
Default value: None
247+
Accept pipeline input: False
248+
Accept wildcard characters: False
249+
```
250+
131251
### -Command
132252
The command to run in the container.
133253

@@ -284,12 +404,9 @@ Accept pipeline input: False
284404
Accept wildcard characters: False
285405
```
286406
287-
### -Port
288-
The port to open.
289-
Default: 80
290-
291-
```yaml
292-
Type: Int32
407+
### -Ports
408+
The ports to open. Default: [80]```yaml
409+
Type: Int32[]
293410
Parameter Sets: (All)
294411
Aliases:
295412

@@ -345,6 +462,20 @@ Accept pipeline input: True (ByPropertyName)
345462
Accept wildcard characters: False
346463
```
347464
465+
### -RestartPolicy
466+
The container restart policy. Default: Always```yaml
467+
Type: String
468+
Parameter Sets: (All)
469+
Aliases:
470+
Accepted values: Always, Never, OnFailure
471+
472+
Required: False
473+
Position: Named
474+
Default value: None
475+
Accept pipeline input: False
476+
Accept wildcard characters: False
477+
```
478+
348479
### -Tag
349480
{{Fill Tag Description}}
350481

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
---
1+
---
22
external help file: Microsoft.Azure.Commands.ContainerInstance.dll-Help.xml
3-
Module Name: AzureRM
3+
Module Name: AzureRM.ContainerInstance
44
online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.containerinstance/remove-azurermcontainergroup
55
schema: 2.0.0
66
---

0 commit comments

Comments
 (0)