Get-AzOperationalInsightsCluster
Get or list clusters
Syntax
ListParameterSet (Default)
Get-AzOperationalInsightsCluster
[-ResourceGroupName <String>]
[-ClusterName <String>]
[-ResourceId <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
GetByNameParameterSet
Get-AzOperationalInsightsCluster
-ResourceGroupName <String>
-ClusterName <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
GetByResourceIdParameterSet
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
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.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ListParameterSet
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Parameter properties
| Type: | IAzureContextContainer |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ResourceGroupName
The resource group name.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ListParameterSet
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ResourceId
The destination resource ID. This can be copied from the Properties entry of the destination resource in Azure.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ListParameterSet
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
