Get-SmResourceGroup
Contributors
Suggest changes
Retrieves details about resource groups.
Syntax
Get-SmResourceGroup [-ResourceGroupName] <String> [-ListResources] <> [-ListConfiguration] <> [-ListPolicies] <>
Detailed Description
Retrieves details about resource groups. Entering GetSmResourceGroup with no parameters specifies retrieves information about all resource groups.
Parameters
Name | Description | Required? | Pipeline Input | Default Value |
---|---|---|---|---|
ResourceGroupName |
Specifies a resource group name for which you want to retrieve details. |
false |
true (ByPropertyName) |
|
ListResources |
Specifies whether or not resources for a resource group are listed. |
false |
true (ByPropertyName) |
|
ListConfiguration |
Specifies whether or not configuration information for a resource group is listed. |
false |
true (ByPropertyName) |
|
ListPolicies |
Specifies whether or not policies in a resource group are listed. |
false |
true (ByPropertyName) |
Examples
Example 1: Getting all resource group information
Get-SmResourceGroup
This example syntax retrieves information about all resource groups.
Description : CreationTime: 10/10/2016 4:45:53 PM ModificationTime: 10/10/2016 4:45:53 PM EnableEmail : False EmailSMTPServer : EmailFrom : EmailTo : EmailSubject: EnableSysLog: False ProtectionGroupType : Backup EnableAsupOnFailure : False Policies: {} HostResourceMaping : {} Configuration : SMCoreContracts.SmCloneConfiguration LastBackupStatus: Completed VerificationServer : EmailBody : EmailNotificationPreference : Never VerificationServerInfo : SchedulerSQLInstance: CustomText : CustomSnapshotFormat: SearchResources : False ByPassRunAs : False IsCustomSnapshot: MaintenanceStatus : Production PluginProtectionGroupTypes : {SMSQL} Tag : IsInternal : False EnableEmailAttachment : False VerificationSettings: {} Name: NFS_DB Type: Group Id : 2 Host: UserName: Passphrase : Deleted : False Auth: SMCoreContracts.SmAuth IsClone : False CloneLevel : 0 Hosts : StorageName : ResourceGroupNames : PolicyNames : Description : CreationTime: 10/10/2016 4:51:36 PM ModificationTime: 10/10/2016 5:27:57 PM EnableEmail : False EmailSMTPServer : EmailFrom : EmailTo : EmailSubject: EnableSysLog: False ProtectionGroupType : Backup EnableAsupOnFailure : False Policies: {} HostResourceMaping : {} Configuration : SMCoreContracts.SmCloneConfiguration LastBackupStatus: Failed VerificationServer : EmailBody : EmailNotificationPreference : Never VerificationServerInfo : SchedulerSQLInstance: CustomText : CustomSnapshotFormat: SearchResources : False ByPassRunAs : False IsCustomSnapshot: MaintenanceStatus : Production PluginProtectionGroupTypes : {SMSQL} Tag : IsInternal : False EnableEmailAttachment : False VerificationSettings: {} Name: Test Type: Group Id : 3 Host: UserName: Passphrase : Deleted : False Auth: SMCoreContracts.SmAuth IsClone : False CloneLevel : 0 Hosts : StorageName : ResourceGroupNames : PolicyNames :