< Back
New-AzureRmContainerServiceConfig
Post
NAME New-AzureRmContainerServiceConfig
SYNOPSIS
Creates a local configuration object for a container service.
SYNTAX
New-AzureRmContainerServiceConfig [[-Location] <String>] [[-Tag] <Hashtable>] [[-VmDiagnosticsEnabled] <Boolean>] [[-OrchestratorType] {Swarm |
DCOS | Custom | Kubernetes}] [[-MasterCount] <Int32>] [[-MasterDnsPrefix] <String>] [[-AgentPoolProfile] <ContainerServiceAgentPoolProfile[]>]
[[-WindowsProfileAdminUsername] <String>] [[-WindowsProfileAdminPassword] <String>] [[-AdminUsername] <String>] [[-SshPublicKey] <String[]>]
[-CustomProfileOrchestrator <String>] [-DefaultProfile <IAzureContextContainer>] [-ServicePrincipalProfileClientId <String>]
[-ServicePrincipalProfileSecret <String>] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The New-AzureRmContainerServiceConfig cmdlet creates a local configuration object for a container service. Provide this object to the
New-AzureRmContainerService cmdlet to create a container service.
PARAMETERS
-AdminUsername <String>
Specifies the administrator account name to use for a Linux-based container service.
Required? false
Position? 8
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-AgentPoolProfile <ContainerServiceAgentPoolProfile[]>
Specifies an array of agent pool profile objects for the container service. Add a profile by using the
Add-AzureRmContainerServiceAgentPoolProfile cmdlet.
Required? false
Position? 5
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-CustomProfileOrchestrator <String>
Specifies the custom profile orchestrator.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Location <String>
Specifies the location in which to create the container service.
Required? false
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-MasterCount <Int32>
Specifies the number of master virtual machines to create.
Required? false
Position? 3
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-MasterDnsPrefix <String>
Specifies the DNS prefix for the master virtual machine.
Required? false
Position? 4
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-OrchestratorType <ContainerServiceOrchestratorTypes>
Specifies the type of orchestrator for the container service. The acceptable values for this parameter are: DCOS and Swarm.
Required? false
Position? 2
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ServicePrincipalProfileClientId <String>
Specifies the principal profile client ID.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ServicePrincipalProfileSecret <String>
Specifies the principal profile secret.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-SshPublicKey <String[]>
Specifies the SSH public key for a Linux-based container service.
Required? false
Position? 9
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Tag <Hashtable>
Key-value pairs in the form of a hash table. For example:
@{key0="value0";key1=$null;key2="value2"}
Required? false
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-VmDiagnosticsEnabled <Boolean>
Indicates whether this configuration enables diagnostics for the container service virtual machine.
Required? false
Position? 10
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-WindowsProfileAdminPassword <String>
Specifies the administrator password for a container service that uses the Windows operating system.
Required? false
Position? 7
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-WindowsProfileAdminUsername <String>
Specifies the administrator username for a container service that uses the Windows operating system.
Required? false
Position? 6
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
This cmdlet does not accept any input.
OUTPUTS
Microsoft.Azure.Commands.Compute.Automation.Models.PSContainerService
NOTES
Example 1: Create a container service configuration
PS C:\\> $Container = New-AzureRmContainerServiceConfig -Location "Australia Southeast" -OrchestratorType "DCOS" -MasterDnsPrefix
"MasterResourceGroup17" -AdminUsername "AcsLinuxAdmin" -SshPublicKey "<ssh-key>"
PS C:\\> $Container | Add-AzureRmContainerServiceAgentPoolProfile -Name "AgentPool01" -VmSize "Standard_A1" -DnsPrefix "APResourceGroup17"
This command creates a container, and then stores it in the $Container variable.
The command specifies various settings for the container service configuration. The command passes the configuration object to the
Add-AzureRmContainerServiceAgentPoolProfile cmdlet by using the pipeline operator. That cmdlet adds an agent pool profile.
Specify the object in $Container for the ContainerService parameter of New-AzureRmContainerService .
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... viceconfig
Add-AzureRmContainerServiceAgentPoolProfile
New-AzureRmContainerService
SYNOPSIS
Creates a local configuration object for a container service.
SYNTAX
New-AzureRmContainerServiceConfig [[-Location] <String>] [[-Tag] <Hashtable>] [[-VmDiagnosticsEnabled] <Boolean>] [[-OrchestratorType] {Swarm |
DCOS | Custom | Kubernetes}] [[-MasterCount] <Int32>] [[-MasterDnsPrefix] <String>] [[-AgentPoolProfile] <ContainerServiceAgentPoolProfile[]>]
[[-WindowsProfileAdminUsername] <String>] [[-WindowsProfileAdminPassword] <String>] [[-AdminUsername] <String>] [[-SshPublicKey] <String[]>]
[-CustomProfileOrchestrator <String>] [-DefaultProfile <IAzureContextContainer>] [-ServicePrincipalProfileClientId <String>]
[-ServicePrincipalProfileSecret <String>] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The New-AzureRmContainerServiceConfig cmdlet creates a local configuration object for a container service. Provide this object to the
New-AzureRmContainerService cmdlet to create a container service.
PARAMETERS
-AdminUsername <String>
Specifies the administrator account name to use for a Linux-based container service.
Required? false
Position? 8
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-AgentPoolProfile <ContainerServiceAgentPoolProfile[]>
Specifies an array of agent pool profile objects for the container service. Add a profile by using the
Add-AzureRmContainerServiceAgentPoolProfile cmdlet.
Required? false
Position? 5
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-CustomProfileOrchestrator <String>
Specifies the custom profile orchestrator.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Location <String>
Specifies the location in which to create the container service.
Required? false
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-MasterCount <Int32>
Specifies the number of master virtual machines to create.
Required? false
Position? 3
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-MasterDnsPrefix <String>
Specifies the DNS prefix for the master virtual machine.
Required? false
Position? 4
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-OrchestratorType <ContainerServiceOrchestratorTypes>
Specifies the type of orchestrator for the container service. The acceptable values for this parameter are: DCOS and Swarm.
Required? false
Position? 2
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ServicePrincipalProfileClientId <String>
Specifies the principal profile client ID.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ServicePrincipalProfileSecret <String>
Specifies the principal profile secret.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-SshPublicKey <String[]>
Specifies the SSH public key for a Linux-based container service.
Required? false
Position? 9
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Tag <Hashtable>
Key-value pairs in the form of a hash table. For example:
@{key0="value0";key1=$null;key2="value2"}
Required? false
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-VmDiagnosticsEnabled <Boolean>
Indicates whether this configuration enables diagnostics for the container service virtual machine.
Required? false
Position? 10
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-WindowsProfileAdminPassword <String>
Specifies the administrator password for a container service that uses the Windows operating system.
Required? false
Position? 7
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-WindowsProfileAdminUsername <String>
Specifies the administrator username for a container service that uses the Windows operating system.
Required? false
Position? 6
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
This cmdlet does not accept any input.
OUTPUTS
Microsoft.Azure.Commands.Compute.Automation.Models.PSContainerService
NOTES
Example 1: Create a container service configuration
PS C:\\> $Container = New-AzureRmContainerServiceConfig -Location "Australia Southeast" -OrchestratorType "DCOS" -MasterDnsPrefix
"MasterResourceGroup17" -AdminUsername "AcsLinuxAdmin" -SshPublicKey "<ssh-key>"
PS C:\\> $Container | Add-AzureRmContainerServiceAgentPoolProfile -Name "AgentPool01" -VmSize "Standard_A1" -DnsPrefix "APResourceGroup17"
This command creates a container, and then stores it in the $Container variable.
The command specifies various settings for the container service configuration. The command passes the configuration object to the
Add-AzureRmContainerServiceAgentPoolProfile cmdlet by using the pipeline operator. That cmdlet adds an agent pool profile.
Specify the object in $Container for the ContainerService parameter of New-AzureRmContainerService .
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... viceconfig
Add-AzureRmContainerServiceAgentPoolProfile
New-AzureRmContainerService