ManagementGroupCollection.GetIfExists Method

Definition

Namespace:

Azure.ResourceManager.ManagementGroups

Assembly:

Azure.ResourceManager.dll

Package:

Azure.ResourceManager v1.13.0

Source:

ManagementGroupCollection.cs

Tries to get details for this resource from the service.

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

public virtual Azure.NullableResponse<Azure.ResourceManager.ManagementGroups.ManagementGroupResource> GetIfExists (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 GetIfExists : string * Nullable<Azure.ResourceManager.ManagementGroups.Models.ManagementGroupExpandType> * Nullable<bool> * string * string * System.Threading.CancellationToken -> Azure.NullableResponse<Azure.ResourceManager.ManagementGroups.ManagementGroupResource>
override this.GetIfExists : string * Nullable<Azure.ResourceManager.ManagementGroups.Models.ManagementGroupExpandType> * Nullable<bool> * string * string * System.Threading.CancellationToken -> Azure.NullableResponse<Azure.ResourceManager.ManagementGroups.ManagementGroupResource>

Public Overridable Function GetIfExists (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 NullableResponse(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

NullableResponse<ManagementGroupResource>

Exceptions

ArgumentException

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

ArgumentNullException

groupId is null.