Edit

Share via


Get-AzWorkloadsMonitor

Gets properties of a SAP monitor for the specified subscription, resource group, and resource name.

Syntax

List (Default)

Get-AzWorkloadsMonitor
    [-SubscriptionId <String[]>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

Get

Get-AzWorkloadsMonitor
    -Name <String>
    -ResourceGroupName <String>
    [-SubscriptionId <String[]>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

List1

Get-AzWorkloadsMonitor
    -ResourceGroupName <String>
    [-SubscriptionId <String[]>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

GetViaIdentity

Get-AzWorkloadsMonitor
    -InputObject <IMonitorsIdentity>
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

Description

Gets properties of a SAP monitor for the specified subscription, resource group, and resource name.

Examples

Example 1: List all AMS Instances

Get-AzWorkloadsMonitor
Name        ResourceGroupName ManagedResourceGroupConfigurationName Location    ProvisioningState
----        ----------------- ------------------------------------- --------    -----------------
ad-ams-inst ad-ams-rg         ad-ams-mrg                            eastus2euap Deleting
ad-ams-tp   ad-ams-rg         sapmonrg-q2nti3                       eastus2euap Succeeded
ad-ams      ad-ams-rg         sapmonrg-u2mtiw                       eastus      Succeeded
suha-1606-ams2 suha-0802-rg1     mrg-15061                          eastus2euap Failed

Lists all AMS Instances in the subscription

Example 2: List all AMS instances in a Resource Group

Get-AzWorkloadsMonitor -ResourceGroupName ad-ams-rg
Name        ResourceGroupName ManagedResourceGroupConfigurationName Location    ProvisioningState
----        ----------------- ------------------------------------- --------    -----------------
ad-ams-inst ad-ams-rg         ad-ams-mrg                            eastus2euap Deleting
ad-ams-tp   ad-ams-rg         sapmonrg-q2nti3                       eastus2euap Succeeded
ad-ams      ad-ams-rg         sapmonrg-u2mtiw                       eastus      Succeeded

List all AMS instances in a Resource Group

Example 3: Get Information about an AMS Instance

Get-AzWorkloadsMonitor -ResourceGroupName ad-ams-rg -Name ad-ams
Name   ResourceGroupName ManagedResourceGroupConfigurationName Location ProvisioningState
----   ----------------- ------------------------------------- -------- -----------------
ad-ams ad-ams-rg         sapmonrg-u2mtiw                       eastus   Succeeded

Gets information about a specific AMS instance in a resource group

Example 4: Get Information about an AMS Instance by Id

Get-AzWorkloadsMonitor -InputObject '/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/suha-0802-rg1/providers/Microsoft.Workloads/monitors/suha-1606-ams2'
Name           ResourceGroupName ManagedResourceGroupConfigurationName Location    ProvisioningState
----           ----------------- ------------------------------------- --------    -----------------
suha-1606-ams2 suha-0802-rg1     mrg-15061                             eastus2euap Failed

Get Information about an AMS Instance by ArmId

Parameters

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Parameter properties

Type:PSObject
Default value:None
Supports wildcards:False
DontShow:False
Aliases: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

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Parameter properties

Type:IMonitorsIdentity
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

GetViaIdentity
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Name

Name of the SAP monitor resource.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:MonitorName

Parameter sets

Get
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ResourceGroupName

The name of the resource group. The name is case insensitive.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Get
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
List1
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SubscriptionId

The ID of the target subscription.

Parameter properties

Type:

String[]

Default value:(Get-AzContext).Subscription.Id
Supports wildcards:False
DontShow:False

Parameter sets

List
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Get
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
List1
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.

Inputs

IMonitorsIdentity

Outputs

IMonitor