Share via


SynapseWorkspaceCollection Class

Definition

A class representing a collection of SynapseWorkspaceResource and their operations. Each SynapseWorkspaceResource in the collection will belong to the same instance of ResourceGroupResource. To get a SynapseWorkspaceCollection instance call the GetSynapseWorkspaces method from an instance of ResourceGroupResource.

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

Constructors

SynapseWorkspaceCollection()

Initializes a new instance of the SynapseWorkspaceCollection 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, SynapseWorkspaceData, CancellationToken)

Creates or updates a workspace

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}
  • Operation Id: Workspaces_CreateOrUpdate
CreateOrUpdateAsync(WaitUntil, String, SynapseWorkspaceData, CancellationToken)

Creates or updates a workspace

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}
  • Operation Id: Workspaces_CreateOrUpdate
Exists(String, CancellationToken)

Checks to see if the resource exists in azure.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}
  • Operation Id: Workspaces_Get
ExistsAsync(String, CancellationToken)

Checks to see if the resource exists in azure.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}
  • Operation Id: Workspaces_Get
Get(String, CancellationToken)

Gets a workspace

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}
  • Operation Id: Workspaces_Get
GetAll(CancellationToken)

Returns a list of workspaces in a resource group

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces
  • Operation Id: Workspaces_ListByResourceGroup
GetAllAsync(CancellationToken)

Returns a list of workspaces in a resource group

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces
  • Operation Id: Workspaces_ListByResourceGroup
GetAsync(String, CancellationToken)

Gets a workspace

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}
  • Operation Id: Workspaces_Get
GetIfExists(String, CancellationToken)

Tries to get details for this resource from the service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}
  • Operation Id: Workspaces_Get
GetIfExistsAsync(String, CancellationToken)

Tries to get details for this resource from the service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}
  • Operation Id: Workspaces_Get
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<SynapseWorkspaceResource>.GetAsyncEnumerator(CancellationToken)

Returns an enumerator that iterates asynchronously through the collection.

IEnumerable.GetEnumerator()

Returns an enumerator that iterates through a collection.

IEnumerable<SynapseWorkspaceResource>.GetEnumerator()

Returns an enumerator that iterates through the collection.

Applies to