< Back

New-AzureRmOperationalInsightsWorkspace

Thu Apr 04, 2019 5:40 am

NAME New-AzureRmOperationalInsightsWorkspace



SYNOPSIS

Creates a workspace.





SYNTAX

New-AzureRmOperationalInsightsWorkspace [-ResourceGroupName] <String> [-Name] <String> [-Location] <String> [[-Sku] {free | standard | premium |

pernode | standalone}] [[-CustomerId] <Guid>] [[-Tag] <Hashtable>] [[-RetentionInDays] <Int32>] [-DefaultProfile <IAzureContextContainer>]

[-Force] [-Confirm] [-WhatIf] [<CommonParameters>]





DESCRIPTION

The New-AzureRmOperationalInsightsWorkspace cmdlet creates a workspace in the specified resource group and location.





PARAMETERS

-CustomerId <Guid>

Specifies the account to which this workspace will be linked. The Get-AzureRmOperationalInsightsLinkTargets cmdlet can also be used to list

the potential accounts.



Required? false

Position? 4

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



-Force [<SwitchParameter>]

Forces the command to run without asking for user confirmation.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-Location <String>

Specifies the location in which to create the workspace, for example, East US or West Europe.



Required? true

Position? 2

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Name <String>

Specifies the name of the workspace.



Required? true

Position? 1

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-ResourceGroupName <String>

Specifies the name of an Azure resource group. The workspace is created in this resource group.



Required? true

Position? 0

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-RetentionInDays <Int32>

The workspace data retention in days. 730 days is the maximum allowed for all other Skus



Required? false

Position? 6

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Sku <String>

Specifies the service tier of the workspace. Valid values are:



- free



- standard



- premium



Required? false

Position? 3

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Tag <Hashtable>

The resource tags for the workspace.



Required? false

Position? 5

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.OperationalInsights.Models.PSWorkspace







NOTES









Example 1: Create a workspace by name



PS C:\\>New-AzureRmOperationalInsightsWorkspace -ResourceGroupName "ContosoResourceGroup" -Name "MyWorkspace" -Location "East US" -Sku "Standard"



This command creates a standard SKU workspace named MyWorkspace in the resource group named ContosoResourceGroup.





Example 2: Create a workspace and link it to an existing account



PS C:\\>$OILinkTargets = Get-AzureRmOperationalInsightsLinkTargets



PS C:\\>$OILinkTargets[0] | New-AzureRmOperationalInsightsWorkspace -ResourceGroupName "ContosoResourceGroup" -Name "MyWorkspace" -Sku "Standard"



The first command uses the Get-AzureRmOperationalInsightsLinkTargets cmdlet to get Operational Insights account link targets, and then stores them

in the $OILinkTargets variable.



The second command passes the first account link target in $OILinkTargets to the New-AzureRmOperationalInsightsWorkspace cmdlet by using the

pipeline operator. The command creates a standard SKU workspace named MyWorkspace that is linked to the first Operational Insights account in

$OILinkTargets.







RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... sworkspace

Azure Operational Insights Cmdlets

Get-AzureRmOperationalInsightsLinkTargets