Share via


WorkspaceContractCollection Class

Definition

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

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

Constructors

WorkspaceContractCollection()

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

Creates a new workspace or updates an existing one.

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

Creates a new workspace or updates an existing one.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}
  • Operation Id: Workspace_CreateOrUpdate
  • Default Api Version: 2023-03-01-preview
  • Resource: WorkspaceContractResource
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}
  • Operation Id: Workspace_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: WorkspaceContractResource
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}
  • Operation Id: Workspace_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: WorkspaceContractResource
Get(String, CancellationToken)

Gets the details of the workspace specified by its identifier.

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

Lists all workspaces of the API Management service instance.

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

Lists all workspaces of the API Management service instance.

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

Gets the details of the workspace specified by its identifier.

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

Returns an enumerator that iterates asynchronously through the collection.

IEnumerable.GetEnumerator()

Returns an enumerator that iterates through a collection.

IEnumerable<WorkspaceContractResource>.GetEnumerator()

Returns an enumerator that iterates through the collection.

Applies to