Share via


ApiDiagnosticCollection Class

Definition

A class representing a collection of ApiDiagnosticResource and their operations. Each ApiDiagnosticResource in the collection will belong to the same instance of ApiResource. To get an ApiDiagnosticCollection instance call the GetApiDiagnostics method from an instance of ApiResource.

public class ApiDiagnosticCollection : Azure.ResourceManager.ArmCollection, System.Collections.Generic.IAsyncEnumerable<Azure.ResourceManager.ApiManagement.ApiDiagnosticResource>, System.Collections.Generic.IEnumerable<Azure.ResourceManager.ApiManagement.ApiDiagnosticResource>
type ApiDiagnosticCollection = class
    inherit ArmCollection
    interface seq<ApiDiagnosticResource>
    interface IEnumerable
    interface IAsyncEnumerable<ApiDiagnosticResource>
Public Class ApiDiagnosticCollection
Inherits ArmCollection
Implements IAsyncEnumerable(Of ApiDiagnosticResource), IEnumerable(Of ApiDiagnosticResource)
Inheritance
ApiDiagnosticCollection
Implements

Constructors

ApiDiagnosticCollection()

Initializes a new instance of the ApiDiagnosticCollection class for mocking.

Properties

Client

Gets the ArmClient this resource client was created from.

(Inherited from ArmCollection)
Diagnostics

Gets the diagnostic options for this resource client.

(Inherited from ArmCollection)
Endpoint

Gets the base uri for this resource client.

(Inherited from ArmCollection)
Id

Gets the resource identifier.

(Inherited from ArmCollection)
Pipeline

Gets the pipeline for this resource client.

(Inherited from ArmCollection)

Methods

CreateOrUpdate(WaitUntil, String, DiagnosticContractData, Nullable<ETag>, CancellationToken)

Creates a new Diagnostic for an API or updates an existing one.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/diagnostics/{diagnosticId}
  • Operation Id: ApiDiagnostic_CreateOrUpdate
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiDiagnosticResource
CreateOrUpdateAsync(WaitUntil, String, DiagnosticContractData, Nullable<ETag>, CancellationToken)

Creates a new Diagnostic for an API or updates an existing one.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/diagnostics/{diagnosticId}
  • Operation Id: ApiDiagnostic_CreateOrUpdate
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiDiagnosticResource
Exists(String, CancellationToken)

Checks to see if the resource exists in azure.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/diagnostics/{diagnosticId}
  • Operation Id: ApiDiagnostic_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiDiagnosticResource
ExistsAsync(String, CancellationToken)

Checks to see if the resource exists in azure.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/diagnostics/{diagnosticId}
  • Operation Id: ApiDiagnostic_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiDiagnosticResource
Get(String, CancellationToken)

Gets the details of the Diagnostic for an API specified by its identifier.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/diagnostics/{diagnosticId}
  • Operation Id: ApiDiagnostic_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiDiagnosticResource
GetAll(String, Nullable<Int32>, Nullable<Int32>, CancellationToken)

Lists all diagnostics of an API.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/diagnostics
  • Operation Id: ApiDiagnostic_ListByService
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiDiagnosticResource
GetAllAsync(String, Nullable<Int32>, Nullable<Int32>, CancellationToken)

Lists all diagnostics of an API.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/diagnostics
  • Operation Id: ApiDiagnostic_ListByService
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiDiagnosticResource
GetAsync(String, CancellationToken)

Gets the details of the Diagnostic for an API specified by its identifier.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/diagnostics/{diagnosticId}
  • Operation Id: ApiDiagnostic_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiDiagnosticResource
GetIfExists(String, CancellationToken)

Tries to get details for this resource from the service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/diagnostics/{diagnosticId}
  • Operation Id: ApiDiagnostic_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiDiagnosticResource
GetIfExistsAsync(String, CancellationToken)

Tries to get details for this resource from the service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/diagnostics/{diagnosticId}
  • Operation Id: ApiDiagnostic_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiDiagnosticResource
TryGetApiVersion(ResourceType, String)

Gets the api version override if it has been set for the current client options.

(Inherited from ArmCollection)

Explicit Interface Implementations

IAsyncEnumerable<ApiDiagnosticResource>.GetAsyncEnumerator(CancellationToken)

Returns an enumerator that iterates asynchronously through the collection.

IEnumerable.GetEnumerator()

Returns an enumerator that iterates through a collection.

IEnumerable<ApiDiagnosticResource>.GetEnumerator()

Returns an enumerator that iterates through the collection.

Applies to