ConfluentOrganizationResource.GetEnvironmentAsync Method

Definition

Get Environment details by environment Id

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/environments/{environmentId}
  • Operation Id: Organization_GetEnvironmentById
  • Default Api Version: 2024-02-13
  • Resource: ConfluentOrganizationResource
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Confluent.Models.SCEnvironmentRecord>> GetEnvironmentAsync (string environmentId, System.Threading.CancellationToken cancellationToken = default);
abstract member GetEnvironmentAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Confluent.Models.SCEnvironmentRecord>>
override this.GetEnvironmentAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Confluent.Models.SCEnvironmentRecord>>
Public Overridable Function GetEnvironmentAsync (environmentId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of SCEnvironmentRecord))

Parameters

environmentId
String

Confluent environment id.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

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

environmentId is null.

Applies to