IManagementGroupsOperations.GetDescendantsWithHttpMessagesAsync Method

Definition

Namespace:

Microsoft.Azure.Management.ManagementGroups

Assembly:

Microsoft.Azure.Management.ManagementGroups.dll

Package:

Microsoft.Azure.Management.ManagementGroups v2.0.0-beta

List all entities that descend from a management group.

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Rest.Azure.IPage<Microsoft.Azure.Management.ManagementGroups.Models.DescendantInfo>>> GetDescendantsWithHttpMessagesAsync (string groupId, string skiptoken = default, int? top = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetDescendantsWithHttpMessagesAsync : string * string * Nullable<int> * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Rest.Azure.IPage<Microsoft.Azure.Management.ManagementGroups.Models.DescendantInfo>>>

Public Function GetDescendantsWithHttpMessagesAsync (groupId As String, Optional skiptoken As String = Nothing, Optional top As Nullable(Of Integer) = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationResponse(Of IPage(Of DescendantInfo)))

Parameters

groupId

String

Management Group ID.

skiptoken

String

Page continuation token is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a token parameter that specifies a starting point to use for subsequent calls.

top

Nullable<Int32>

Number of elements to return when retrieving results. Passing this in will override $skipToken.

customHeaders

Dictionary<String,List<String>>

The headers that will be added to request.

cancellationToken

CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse<IPage<DescendantInfo>>>

Exceptions

ErrorResponseException

Thrown when the operation returned an invalid status code

SerializationException

Thrown when unable to deserialize the response

ValidationException

Thrown when a required parameter is null