SynapseDatabaseCollection Class

  • Reference

Definition

Namespace:
Azure.ResourceManager.Synapse
Assembly:
Azure.ResourceManager.Synapse.dll
Package:
Azure.ResourceManager.Synapse v1.2.0
Package:
Azure.ResourceManager.Synapse v1.2.0-beta.1
Source:
SynapseDatabaseCollection.cs
Source:
SynapseDatabaseCollection.cs

A class representing a collection of SynapseDatabaseResource and their operations. Each SynapseDatabaseResource in the collection will belong to the same instance of SynapseKustoPoolResource. To get a SynapseDatabaseCollection instance call the GetSynapseDatabases method from an instance of SynapseKustoPoolResource.

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

Constructors

SynapseDatabaseCollection()

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

Creates or updates a database.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/kustoPools/{kustoPoolName}/databases/{databaseName}
  • Operation Id: KustoPoolDatabases_CreateOrUpdate
CreateOrUpdateAsync(WaitUntil, String, SynapseDatabaseData, CancellationToken)

Creates or updates a database.

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

Checks to see if the resource exists in azure.

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

Checks to see if the resource exists in azure.

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

Returns a database.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/kustoPools/{kustoPoolName}/databases/{databaseName}
  • Operation Id: KustoPoolDatabases_Get
GetAll(CancellationToken)

Returns the list of databases of the given Kusto pool.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/kustoPools/{kustoPoolName}/databases
  • Operation Id: KustoPoolDatabases_ListByKustoPool
GetAllAsync(CancellationToken)

Returns the list of databases of the given Kusto pool.

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

Returns a database.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/kustoPools/{kustoPoolName}/databases/{databaseName}
  • Operation Id: KustoPoolDatabases_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}/kustoPools/{kustoPoolName}/databases/{databaseName}
  • Operation Id: KustoPoolDatabases_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}/kustoPools/{kustoPoolName}/databases/{databaseName}
  • Operation Id: KustoPoolDatabases_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<SynapseDatabaseResource>.GetAsyncEnumerator(CancellationToken)

Returns an enumerator that iterates asynchronously through the collection.
IEnumerable.GetEnumerator()

Returns an enumerator that iterates through a collection.
IEnumerable<SynapseDatabaseResource>.GetEnumerator()

Returns an enumerator that iterates through the collection.

Applies to