Skip to content

Last set of help file regeneration #4894

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.

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

Merged
merged 25 commits into from
Nov 2, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
Module Name: AzureRM.ContainerInstance
Module Guid:
Download Help Link:
Help Version:
Locale: en-US
---

# AzureRM.ContainerInstance Module
## Description
This topic displays help topics for the Azure Container Instance Cmdlets.

## AzureRM.ContainerInstance Cmdlets
### [Get-AzureRmContainerGroup](Get-AzureRmContainerGroup.md)
Gets container groups.

### [Get-AzureRmContainerInstanceLog](Get-AzureRmContainerInstanceLog.md)
Get the logs of a container instance in a container group.

### [New-AzureRmContainerGroup](New-AzureRmContainerGroup.md)
Creates a container group.

### [Remove-AzureRmContainerGroup](Remove-AzureRmContainerGroup.md)
Removes a container group.

Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
external help file: Microsoft.Azure.Commands.ContainerInstance.dll-Help.xml
Module Name: AzureRM.ContainerInstance
Module Name: AzureRM
online version:
schema: 2.0.0
---
Expand All @@ -14,17 +14,19 @@ Gets container groups.

### ListContainerGroupParamSet (Default)
```
Get-AzureRmContainerGroup [[-ResourceGroupName] <String>]
Get-AzureRmContainerGroup [[-ResourceGroupName] <String>] [-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
```

### GetContainerGroupInResourceGroupParamSet
```
Get-AzureRmContainerGroup [-ResourceGroupName] <String> [-Name] <String>
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
```

### GetContainerGroupByResourceIdParamSet
```
Get-AzureRmContainerGroup -ResourceId <String>
Get-AzureRmContainerGroup -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
```

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

## PARAMETERS

### -DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure.

```yaml
Type: IAzureContextContainer
Parameter Sets: (All)
Aliases: AzureRmContext, AzureCredential

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -Name
The container group Name.

Expand Down Expand Up @@ -159,16 +176,17 @@ Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```

### CommonParameters
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).

## INPUTS

### System.String


## OUTPUTS

### Microsoft.Azure.Commands.ContainerInstance.Models.PSContainerGroup


## NOTES

## RELATED LINKS
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
external help file: Microsoft.Azure.Commands.ContainerInstance.dll-Help.xml
Module Name: AzureRM.ContainerInstance
Module Name: AzureRM
online version:
schema: 2.0.0
---
Expand All @@ -12,20 +12,22 @@ Get the logs of a container instance in a container group.

## SYNTAX

### GetContainerInstanceLogByNames
### GetContainerInstanceLogByNamesParamSet (Default)
```
Get-AzureRmContainerInstanceLog [-ResourceGroupName] <String> -ContainerGroupName <String> [-Name <String>]
[-Tail <Int32>]
[-Tail <Int32>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
```

### GetContainerInstanceLogByPSContainerGroup
### GetContainerInstanceLogByPSContainerGroupParamSet
```
Get-AzureRmContainerInstanceLog -InputContainerGroup <PSContainerGroup> [-Name <String>] [-Tail <Int32>]
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
```

### GetContainerInstanceLogByResourceId
### GetContainerInstanceLogByResourceIdParamSet
```
Get-AzureRmContainerInstanceLog -ResourceId <String> [-Name <String>] [-Tail <Int32>]
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
```

## DESCRIPTION
Expand Down Expand Up @@ -86,7 +88,7 @@ The container group name.

```yaml
Type: String
Parameter Sets: GetContainerInstanceLogByNames
Parameter Sets: GetContainerInstanceLogByNamesParamSet
Aliases:

Required: True
Expand All @@ -96,12 +98,27 @@ Accept pipeline input: False
Accept wildcard characters: False
```

### -DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure.

```yaml
Type: IAzureContextContainer
Parameter Sets: (All)
Aliases: AzureRmContext, AzureCredential

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -InputContainerGroup
The input container group object.

```yaml
Type: PSContainerGroup
Parameter Sets: GetContainerInstanceLogByPSContainerGroup
Parameter Sets: GetContainerInstanceLogByPSContainerGroupParamSet
Aliases:

Required: True
Expand Down Expand Up @@ -132,7 +149,7 @@ The resource group name.

```yaml
Type: String
Parameter Sets: GetContainerInstanceLogByNames
Parameter Sets: GetContainerInstanceLogByNamesParamSet
Aliases:

Required: True
Expand All @@ -147,7 +164,7 @@ The resource id.

```yaml
Type: String
Parameter Sets: GetContainerInstanceLogByResourceId
Parameter Sets: GetContainerInstanceLogByResourceIdParamSet
Aliases:

Required: True
Expand All @@ -173,16 +190,17 @@ Accept pipeline input: False
Accept wildcard characters: False
```

### CommonParameters
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).

## INPUTS

### Microsoft.Azure.Commands.ContainerInstance.Models.PSContainerGroup


## OUTPUTS

### System.String


## NOTES

## RELATED LINKS
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
external help file: Microsoft.Azure.Commands.ContainerInstance.dll-Help.xml
Module Name: AzureRM.ContainerInstance
Module Name: AzureRM
online version:
schema: 2.0.0
---
Expand All @@ -12,19 +12,21 @@ Creates a container group.

## SYNTAX

### CreateContainerGroupBaseParamSet
### CreateContainerGroupBaseParamSet (Default)
```
New-AzureRmContainerGroup [-ResourceGroupName] <String> [-Name] <String> -Image <String> [-Location <String>]
[-OsType <String>] [-Cpu <Int32>] [-MemoryInGB <Double>] [-IpAddressType <String>] [-Port <Int32>]
[-Command <String>] [-EnvironmentVariable <Hashtable>] [-Tag <Hashtable>] [-WhatIf] [-Confirm]
[-Command <String>] [-EnvironmentVariable <Hashtable>] [-Tag <Hashtable>]
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
```

### CreateContainerGroupWithRegistryParamSet
```
New-AzureRmContainerGroup [-ResourceGroupName] <String> [-Name] <String> -Image <String> [-Location <String>]
[-OsType <String>] [-Cpu <Int32>] [-MemoryInGB <Double>] [-IpAddressType <String>] [-Port <Int32>]
[-Command <String>] [-EnvironmentVariable <Hashtable>] [-RegistryServerDomain <String>]
-RegistryCredential <PSCredential> [-Tag <Hashtable>] [-WhatIf] [-Confirm]
-RegistryCredential <PSCredential> [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf]
[-Confirm] [<CommonParameters>]
```

## DESCRIPTION
Expand Down Expand Up @@ -141,13 +143,14 @@ Accept pipeline input: False
Accept wildcard characters: False
```

### -Confirm
Prompts you for confirmation before running the cmdlet.
### -Cpu
The required CPU cores.
Default: 1

```yaml
Type: SwitchParameter
Type: Int32
Parameter Sets: (All)
Aliases: cf
Aliases:

Required: False
Position: Named
Expand All @@ -156,14 +159,13 @@ Accept pipeline input: False
Accept wildcard characters: False
```

### -Cpu
The required CPU cores.
Default: 1
### -DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure.

```yaml
Type: Int32
Type: IAzureContextContainer
Parameter Sets: (All)
Aliases:
Aliases: AzureRmContext, AzureCredential

Required: False
Position: Named
Expand Down Expand Up @@ -358,6 +360,21 @@ Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```

### -Confirm
Prompts you for confirmation before running the cmdlet.

```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
Expand All @@ -374,17 +391,18 @@ Accept pipeline input: False
Accept wildcard characters: False
```

### CommonParameters
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).

## INPUTS

### System.String
System.Collections.Hashtable


## OUTPUTS

### Microsoft.Azure.Commands.ContainerInstance.Models.PSContainerGroup


## NOTES

## RELATED LINKS
Expand Down
Loading