Share via


ApiManagementGroupCollection Class

Definition

A class representing a collection of ApiManagementGroupResource and their operations. Each ApiManagementGroupResource in the collection will belong to the same instance of ApiManagementServiceResource. To get an ApiManagementGroupCollection instance call the GetApiManagementGroups method from an instance of ApiManagementServiceResource.

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

Constructors

ApiManagementGroupCollection()

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

Creates or Updates a group.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}
  • Operation Id: Group_CreateOrUpdate
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementGroupResource
CreateOrUpdateAsync(WaitUntil, String, ApiManagementGroupCreateOrUpdateContent, Nullable<ETag>, CancellationToken)

Creates or Updates a group.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}
  • Operation Id: Group_CreateOrUpdate
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementGroupResource
Exists(String, CancellationToken)

Checks to see if the resource exists in azure.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}
  • Operation Id: Group_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementGroupResource
ExistsAsync(String, CancellationToken)

Checks to see if the resource exists in azure.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}
  • Operation Id: Group_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementGroupResource
Get(String, CancellationToken)

Gets the details of the group specified by its identifier.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}
  • Operation Id: Group_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementGroupResource
GetAll(String, Nullable<Int32>, Nullable<Int32>, CancellationToken)

Lists a collection of groups defined within a service instance.

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

Lists a collection of groups defined within a service instance.

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

Gets the details of the group specified by its identifier.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}
  • Operation Id: Group_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementGroupResource
GetIfExists(String, CancellationToken)

Tries to get details for this resource from the service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}
  • Operation Id: Group_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementGroupResource
GetIfExistsAsync(String, CancellationToken)

Tries to get details for this resource from the service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}
  • Operation Id: Group_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementGroupResource
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<ApiManagementGroupResource>.GetAsyncEnumerator(CancellationToken)

Returns an enumerator that iterates asynchronously through the collection.

IEnumerable.GetEnumerator()

Returns an enumerator that iterates through a collection.

IEnumerable<ApiManagementGroupResource>.GetEnumerator()

Returns an enumerator that iterates through the collection.

Applies to