Condividi tramite


ServiceWorkspaceApiCollection Class

Definition

A class representing a collection of ServiceWorkspaceApiResource and their operations. Each ServiceWorkspaceApiResource in the collection will belong to the same instance of WorkspaceContractResource. To get a ServiceWorkspaceApiCollection instance call the GetServiceWorkspaceApis method from an instance of WorkspaceContractResource.

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

Constructors

ServiceWorkspaceApiCollection()

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

Creates new or updates existing specified API of the workspace in an API Management service instance.

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

Creates new or updates existing specified API of the workspace in an API Management service instance.

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

Checks to see if the resource exists in azure.

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

Checks to see if the resource exists in azure.

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

Gets the details of the API specified by its identifier.

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

Lists all APIs of the workspace in an API Management service instance.

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

Lists all APIs of the workspace in an API Management service instance.

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

Gets the details of the API specified by its identifier.

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

Tries to get details for this resource from the service.

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

Tries to get details for this resource from the service.

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

Returns an enumerator that iterates asynchronously through the collection.

IEnumerable.GetEnumerator()

Returns an enumerator that iterates through a collection.

IEnumerable<ServiceWorkspaceApiResource>.GetEnumerator()

Returns an enumerator that iterates through the collection.

Applies to