Edit

Share via

Get-AzOperationalInsightsCluster

  • Reference
Module:
Az.OperationalInsights

Get or list clusters

Syntax

PowerShell 
Get-AzOperationalInsightsCluster
   [-ResourceGroupName <String>]
   [-ClusterName <String>]
   [-ResourceId <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
PowerShell 
Get-AzOperationalInsightsCluster
   -ResourceGroupName <String>
   -ClusterName <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
PowerShell 
Get-AzOperationalInsightsCluster
   -ResourceId <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

Get or list clusters, list clusters under resource group when "-ClusterName" was not provided, list clusters under subscription when "-ClusterName" and "ResourceGroupName" were not provided.

Examples

Example 1

PowerShell 
Get-AzOperationalInsightsCluster -ResourceGroupName "rg-name" -ClusterName "cluster-name"

Identity						: Microsoft.Azure.Commands.OperationalInsights.Models.PSIdentity
Sku								: Microsoft.Azure.Commands.OperationalInsights.Models.PSClusterSku
ClusterId						: {cluster-id}
ProvisioningState				: Succeeded
IsDoubleEncryptionEnabled		: True
IsAvailabilityZonesEnabled		: False
BillingType						: Cluster
KeyVaultProperties				: Microsoft.Azure.Commands.OperationalInsights.Models.PSKeyVaultProperties
LastModifiedDate				: Wed, 26 May 2021 15:19:38 GMT
CreatedDate						: Sun, 27 Dec 2020 11:17:11 GMT
AssociatedWorkspaces			: {workspaces}
CapacityReservationProperties	: Microsoft.Azure.Management.OperationalInsights.Models.CapacityReservationProperties
Location						: South Central US
Id								: /subscriptions/{subscription}/resourceGroups/{rg-name}/providers/Microsoft.OperationalInsights/clusters/{cluster-name}
Name							: {cluster-name}
Type							: Microsoft.OperationalInsights/clusters
Tags							: {}

Get cluster

Parameters

-ClusterName

The cluster name.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ResourceGroupName

The resource group name.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ResourceId

The destination resource ID. This can be copied from the Properties entry of the destination resource in Azure.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

Inputs

Outputs