IManagementGroupsOperations.GetWithHttpMessagesAsync Method

Definition

Get the details of the management group.

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.Management.ManagementGroups.Models.ManagementGroup>> GetWithHttpMessagesAsync (string groupId, string expand = default, bool? recurse = default, string filter = default, string cacheControl = "no-cache", System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);
abstract member GetWithHttpMessagesAsync : string * string * Nullable<bool> * string * string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.Management.ManagementGroups.Models.ManagementGroup>>
Public Function GetWithHttpMessagesAsync (groupId As String, Optional expand As String = Nothing, Optional recurse As Nullable(Of Boolean) = Nothing, Optional filter As String = Nothing, Optional cacheControl As String = "no-cache", Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationResponse(Of ManagementGroup))

Parameters

groupId
String

Management Group ID.

expand
String

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. Possible values include: 'children', 'path', 'ancestors'

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.

customHeaders
Dictionary<String,List<String>>

The headers that will be added to request.

cancellationToken
CancellationToken

The cancellation token.

Returns

Exceptions

Thrown when the operation returned an invalid status code

Thrown when unable to deserialize the response

Thrown when a required parameter is null

Applies to