TenantResource.GetManagementGroupAsync Method

Reference

Definition

Namespace:: Azure.ResourceManager.Resources

Assembly:: Azure.ResourceManager.dll

Package:: Azure.ResourceManager v1.11.1

Package:: Azure.ResourceManager v1.12.0-beta.1

Source:: TenantResource.cs

Source:: TenantResource.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Get the details of the management group.

Request Path: /providers/Microsoft.Management/managementGroups/{groupId}
Operation Id: ManagementGroups_Get
Default Api Version: 2021-04-01
Resource: ManagementGroupResource

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.ManagementGroups.ManagementGroupResource>> GetManagementGroupAsync (string groupId, Azure.ResourceManager.ManagementGroups.Models.ManagementGroupExpandType? expand = default, bool? recurse = default, string filter = default, string cacheControl = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetManagementGroupAsync : string * Nullable<Azure.ResourceManager.ManagementGroups.Models.ManagementGroupExpandType> * Nullable<bool> * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.ManagementGroups.ManagementGroupResource>>
override this.GetManagementGroupAsync : string * Nullable<Azure.ResourceManager.ManagementGroups.Models.ManagementGroupExpandType> * Nullable<bool> * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.ManagementGroups.ManagementGroupResource>>

Public Overridable Function GetManagementGroupAsync (groupId As String, Optional expand As Nullable(Of ManagementGroupExpandType) = Nothing, Optional recurse As Nullable(Of Boolean) = Nothing, Optional filter As String = Nothing, Optional cacheControl As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of ManagementGroupResource))

Parameters

groupId: String

Management Group ID.

expand: Nullable<ManagementGroupExpandType>

The $expand=children query string parameter allows clients to request inclusion of children in the response payload. $expand=path includes the path from the root group to the current group. $expand=ancestors includes the ancestor Ids of the current group.

recurse: Nullable<Boolean>

The $recurse=true query string parameter allows clients to request inclusion of entire hierarchy in the response payload. Note that $expand=children must be passed up if $recurse is set to true.

filter: String

A filter which allows the exclusion of subscriptions from results (i.e. '$filter=children.childType ne Subscription').

cacheControl: String

Indicates whether the request should utilize any caches. Populate the header with 'no-cache' value to bypass existing caches.

cancellationToken: CancellationToken

The cancellation token to use.

Returns

Task<Response<ManagementGroupResource>>

Exceptions

ArgumentNullException

groupId is null.

ArgumentException

groupId is an empty string, and was expected to be non-empty.

Applies to