Share via


ApiReleaseCollection Class

Definition

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

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

Constructors

ApiReleaseCollection()

Initializes a new instance of the ApiReleaseCollection 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, ApiReleaseData, Nullable<ETag>, CancellationToken)

Creates a new Release for the API.

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

Creates a new Release for the API.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/releases/{releaseId}
  • Operation Id: ApiRelease_CreateOrUpdate
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiReleaseResource
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}/releases/{releaseId}
  • Operation Id: ApiRelease_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiReleaseResource
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}/releases/{releaseId}
  • Operation Id: ApiRelease_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiReleaseResource
Get(String, CancellationToken)

Returns the details of an API release.

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

Lists all releases of an API. An API release is created when making an API Revision current. Releases are also used to rollback to previous revisions. Results will be paged and can be constrained by the $top and $skip parameters.

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

Lists all releases of an API. An API release is created when making an API Revision current. Releases are also used to rollback to previous revisions. Results will be paged and can be constrained by the $top and $skip parameters.

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

Returns the details of an API release.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/releases/{releaseId}
  • Operation Id: ApiRelease_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiReleaseResource
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}/releases/{releaseId}
  • Operation Id: ApiRelease_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiReleaseResource
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}/releases/{releaseId}
  • Operation Id: ApiRelease_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiReleaseResource
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<ApiReleaseResource>.GetAsyncEnumerator(CancellationToken)

Returns an enumerator that iterates asynchronously through the collection.

IEnumerable.GetEnumerator()

Returns an enumerator that iterates through a collection.

IEnumerable<ApiReleaseResource>.GetEnumerator()

Returns an enumerator that iterates through the collection.

Applies to