CosmosDBForPostgreSqlRoleCollection.GetIfExistsAsync Method

Definition

Namespace:
Azure.ResourceManager.CosmosDBForPostgreSql
Assembly:
Azure.ResourceManager.CosmosDBForPostgreSql.dll
Package:
Azure.ResourceManager.CosmosDBForPostgreSql v1.0.0
Package:
Azure.ResourceManager.CosmosDBForPostgreSql v1.1.0-beta.3
Source:
CosmosDBForPostgreSqlRoleCollection.cs
Source:
CosmosDBForPostgreSqlRoleCollection.cs

Tries to get details for this resource from the service.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/roles/{roleName}.
  • Operation Id. : Roles_Get.
  • Default Api Version. : 2023-03-02-preview. 
public virtual System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.CosmosDBForPostgreSql.CosmosDBForPostgreSqlRoleResource>> GetIfExistsAsync(string roleName, System.Threading.CancellationToken cancellationToken = default);
abstract member GetIfExistsAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.CosmosDBForPostgreSql.CosmosDBForPostgreSqlRoleResource>>
override this.GetIfExistsAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.CosmosDBForPostgreSql.CosmosDBForPostgreSqlRoleResource>>
Public Overridable Function GetIfExistsAsync (roleName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of NullableResponse(Of CosmosDBForPostgreSqlRoleResource))

Parameters

roleName
String

The name of the cluster role.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Task<NullableResponse<CosmosDBForPostgreSqlRoleResource>>

Exceptions

ArgumentNullException

roleName is null.

ArgumentException

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

Applies to