FabricClient.ServiceGroupManagementClient.GetServiceGroupDescriptionAsync Method

Definition

Namespace:

System.Fabric

Assembly:

System.Fabric.dll

Package:

Microsoft.ServiceFabric v9.1.1833

Overloads

GetServiceGroupDescriptionAsync(Uri)	Asynchronously fetches the ServiceGroupDescription for the specified service group, if it exists.
GetServiceGroupDescriptionAsync(Uri, TimeSpan, CancellationToken)	Asynchronously fetches the ServiceGroupDescription for the specified service group, if it exists, with the provided timeout and CancellationToken.

GetServiceGroupDescriptionAsync(Uri)

Asynchronously fetches the ServiceGroupDescription for the specified service group, if it exists.

public System.Threading.Tasks.Task<System.Fabric.Description.ServiceGroupDescription> GetServiceGroupDescriptionAsync (Uri serviceGroupName);

member this.GetServiceGroupDescriptionAsync : Uri -> System.Threading.Tasks.Task<System.Fabric.Description.ServiceGroupDescription>

Public Function GetServiceGroupDescriptionAsync (serviceGroupName As Uri) As Task(Of ServiceGroupDescription)

Parameters

serviceGroupName

Uri

The name of the service group whose ServiceGroupDescription should be fetched.

Returns

Task<ServiceGroupDescription>

The task representing the asynchronous operation.

Exceptions

FabricObjectClosedException

The FabricClient object is in a closed state. Dispose of the FabricClient object you are using and instantiate a new FabricClient object.

GetServiceGroupDescriptionAsync(Uri, TimeSpan, CancellationToken)

Asynchronously fetches the ServiceGroupDescription for the specified service group, if it exists, with the provided timeout and CancellationToken.

public System.Threading.Tasks.Task<System.Fabric.Description.ServiceGroupDescription> GetServiceGroupDescriptionAsync (Uri serviceGroupName, TimeSpan timeout, System.Threading.CancellationToken cancellationToken);

member this.GetServiceGroupDescriptionAsync : Uri * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Fabric.Description.ServiceGroupDescription>

Public Function GetServiceGroupDescriptionAsync (serviceGroupName As Uri, timeout As TimeSpan, cancellationToken As CancellationToken) As Task(Of ServiceGroupDescription)

Parameters

serviceGroupName

Uri

The name of the service group whose ServiceGroupDescription should be fetched.

timeout

TimeSpan

Timespan that defines the maximum amount of time Service Fabric will allow this operation to continue before returning a Timeout Exception.

cancellationToken

CancellationToken

The CancellationToken that the operation is observing. It can be used to send a notification that the operation should be canceled. Note that cancellation is advisory and that the operation may still be completed even if it is cancelled.

Returns

Task<ServiceGroupDescription>

The task representing the asynchronous operation.

Exceptions

FabricObjectClosedException

The FabricClient object is in a closed state. Dispose of the FabricClient object you are using and instantiate a new FabricClient object.