SynapseKustoPoolResource Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
A Class representing a SynapseKustoPool along with the instance operations that can be performed on it. If you have a ResourceIdentifier you can construct a SynapseKustoPoolResource from an instance of ArmClient using the GetSynapseKustoPoolResource method. Otherwise you can get one from its parent resource SynapseWorkspaceResource using the GetSynapseKustoPool method.
public class SynapseKustoPoolResource : Azure.ResourceManager.ArmResource, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.Synapse.SynapseKustoPoolData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.Synapse.SynapseKustoPoolData>public class SynapseKustoPoolResource : Azure.ResourceManager.ArmResourcetype SynapseKustoPoolResource = class
inherit ArmResource
interface IJsonModel<SynapseKustoPoolData>
interface IPersistableModel<SynapseKustoPoolData>type SynapseKustoPoolResource = class
inherit ArmResourcePublic Class SynapseKustoPoolResource
Inherits ArmResource
Implements IJsonModel(Of SynapseKustoPoolData), IPersistableModel(Of SynapseKustoPoolData)Public Class SynapseKustoPoolResource
Inherits ArmResource- Inheritance
- Implements
Constructors
| Name | Description |
|---|---|
| SynapseKustoPoolResource() |
Initializes a new instance of the SynapseKustoPoolResource class for mocking. |
Fields
| Name | Description |
|---|---|
| ResourceType |
Gets the resource type for the operations. |
Properties
| Name | Description |
|---|---|
| Client |
Gets the ArmClient this resource client was created from. (Inherited from ArmResource) |
| Data |
Gets the data representing this Feature. |
| Diagnostics |
Gets the diagnostic options for this resource client. (Inherited from ArmResource) |
| Endpoint |
Gets the base uri for this resource client. (Inherited from ArmResource) |
| HasData |
Gets whether or not the current instance has data. |
| Id |
Gets the resource identifier. (Inherited from ArmResource) |
| Pipeline |
Gets the pipeline for this resource client. (Inherited from ArmResource) |
Methods
| Name | Description |
|---|---|
| AddLanguageExtensions(WaitUntil, SynapseLanguageExtensionsList, CancellationToken) |
Add a list of language extensions that can run within KQL queries.
|
| AddLanguageExtensionsAsync(WaitUntil, SynapseLanguageExtensionsList, CancellationToken) |
Add a list of language extensions that can run within KQL queries.
|
| AddTag(String, String, CancellationToken) |
Add a tag to the current resource.
|
| AddTagAsync(String, String, CancellationToken) |
Add a tag to the current resource.
|
| CanUseTagResource(CancellationToken) |
Checks to see if the TagResource API is deployed in the current environment. (Inherited from ArmResource) |
| CanUseTagResourceAsync(CancellationToken) |
Checks to see if the TagResource API is deployed in the current environment. (Inherited from ArmResource) |
| CheckKustoPoolChildResourceNameAvailability(KustoPoolChildResourceNameAvailabilityContent, CancellationToken) |
Checks that the Kusto Pool child resource name is valid and is not already in use.
|
| CheckKustoPoolChildResourceNameAvailabilityAsync(KustoPoolChildResourceNameAvailabilityContent, CancellationToken) |
Checks that the Kusto Pool child resource name is valid and is not already in use.
|
| CheckKustoPoolPrincipalAssignmentNameAvailability(KustoPoolPrincipalAssignmentNameAvailabilityContent, CancellationToken) |
Checks that the principal assignment name is valid and is not already in use.
|
| CheckKustoPoolPrincipalAssignmentNameAvailabilityAsync(KustoPoolPrincipalAssignmentNameAvailabilityContent, CancellationToken) |
Checks that the principal assignment name is valid and is not already in use.
|
| CreateResourceIdentifier(String, String, String, String) |
Generate the resource identifier of a SynapseKustoPoolResource instance. |
| Delete(WaitUntil, CancellationToken) |
Deletes a Kusto pool.
|
| DeleteAsync(WaitUntil, CancellationToken) |
Deletes a Kusto pool.
|
| DetachFollowerDatabases(WaitUntil, SynapseFollowerDatabaseDefinition, CancellationToken) |
Detaches all followers of a database owned by this Kusto Pool.
|
| DetachFollowerDatabasesAsync(WaitUntil, SynapseFollowerDatabaseDefinition, CancellationToken) |
Detaches all followers of a database owned by this Kusto Pool.
|
| Get(CancellationToken) |
Gets a Kusto pool.
|
| GetAllKustoPoolPrivateLinkData(CancellationToken) |
Lists all Kusto pool PrivateLinkResources.
|
| GetAllKustoPoolPrivateLinkDataAsync(CancellationToken) |
Lists all Kusto pool PrivateLinkResources.
|
| GetAsync(CancellationToken) |
Gets a Kusto pool.
|
| GetAvailableLocations(CancellationToken) |
Lists all available geo-locations. (Inherited from ArmResource) |
| GetAvailableLocationsAsync(CancellationToken) |
Lists all available geo-locations. (Inherited from ArmResource) |
| GetFollowerDatabases(CancellationToken) |
Returns a list of databases that are owned by this Kusto Pool and were followed by another Kusto Pool.
|
| GetFollowerDatabasesAsync(CancellationToken) |
Returns a list of databases that are owned by this Kusto Pool and were followed by another Kusto Pool.
|
| GetLanguageExtensions(CancellationToken) |
Returns a list of language extensions that can run within KQL queries.
|
| GetLanguageExtensionsAsync(CancellationToken) |
Returns a list of language extensions that can run within KQL queries.
|
| GetManagementLock(String, CancellationToken) |
Get a management lock by scope.
|
| GetManagementLockAsync(String, CancellationToken) |
Get a management lock by scope.
|
| GetManagementLocks() |
Gets a collection of ManagementLockResources in the ArmResource. (Inherited from ArmResource) |
| GetPolicyAssignment(String, CancellationToken) |
This operation retrieves a single policy assignment, given its name and the scope it was created at.
|
| GetPolicyAssignmentAsync(String, CancellationToken) |
This operation retrieves a single policy assignment, given its name and the scope it was created at.
|
| GetPolicyAssignments() |
Gets a collection of PolicyAssignmentResources in the ArmResource. (Inherited from ArmResource) |
| GetSkusByResource(CancellationToken) |
Returns the SKUs available for the provided resource.
|
| GetSkusByResourceAsync(CancellationToken) |
Returns the SKUs available for the provided resource.
|
| GetSynapseAttachedDatabaseConfiguration(String, CancellationToken) |
Returns an attached database configuration.
|
| GetSynapseAttachedDatabaseConfigurationAsync(String, CancellationToken) |
Returns an attached database configuration.
|
| GetSynapseAttachedDatabaseConfigurations() |
Gets a collection of SynapseAttachedDatabaseConfigurationResources in the SynapseKustoPool. |
| GetSynapseClusterPrincipalAssignment(String, CancellationToken) |
Gets a Kusto pool principalAssignment.
|
| GetSynapseClusterPrincipalAssignmentAsync(String, CancellationToken) |
Gets a Kusto pool principalAssignment.
|
| GetSynapseClusterPrincipalAssignments() |
Gets a collection of SynapseClusterPrincipalAssignmentResources in the SynapseKustoPool. |
| GetSynapseDatabase(String, CancellationToken) |
Returns a database.
|
| GetSynapseDatabaseAsync(String, CancellationToken) |
Returns a database.
|
| GetSynapseDatabases() |
Gets a collection of SynapseDatabaseResources in the SynapseKustoPool. |
| GetTagResource() |
Gets an object representing a TagResource along with the instance operations that can be performed on it in the ArmResource. (Inherited from ArmResource) |
| RemoveLanguageExtensions(WaitUntil, SynapseLanguageExtensionsList, CancellationToken) |
Remove a list of language extensions that can run within KQL queries.
|
| RemoveLanguageExtensionsAsync(WaitUntil, SynapseLanguageExtensionsList, CancellationToken) |
Remove a list of language extensions that can run within KQL queries.
|
| RemoveTag(String, CancellationToken) |
Removes a tag by key from the resource.
|
| RemoveTagAsync(String, CancellationToken) |
Removes a tag by key from the resource.
|
| SetTags(IDictionary<String,String>, CancellationToken) |
Replace the tags on the resource with the given set.
|
| SetTagsAsync(IDictionary<String,String>, CancellationToken) |
Replace the tags on the resource with the given set.
|
| Start(WaitUntil, CancellationToken) |
Starts a Kusto pool.
|
| StartAsync(WaitUntil, CancellationToken) |
Starts a Kusto pool.
|
| Stop(WaitUntil, CancellationToken) |
Stops a Kusto pool.
|
| StopAsync(WaitUntil, CancellationToken) |
Stops a Kusto pool.
|
| TryGetApiVersion(ResourceType, String) |
Gets the api version override if it has been set for the current client options. (Inherited from ArmResource) |
| Update(WaitUntil, SynapseKustoPoolPatch, String, CancellationToken) |
Update a Kusto Kusto Pool.
|
| UpdateAsync(WaitUntil, SynapseKustoPoolPatch, String, CancellationToken) |
Update a Kusto Kusto Pool.
|
Explicit Interface Implementations
| Name | Description |
|---|---|
| IJsonModel<SynapseKustoPoolData>.Create(Utf8JsonReader, ModelReaderWriterOptions) |
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. |
| IJsonModel<SynapseKustoPoolData>.Write(Utf8JsonWriter, ModelReaderWriterOptions) |
Writes the model to the provided Utf8JsonWriter. |
| IPersistableModel<SynapseKustoPoolData>.Create(BinaryData, ModelReaderWriterOptions) |
Converts the provided BinaryData into a model. |
| IPersistableModel<SynapseKustoPoolData>.GetFormatFromOptions(ModelReaderWriterOptions) |
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. |
| IPersistableModel<SynapseKustoPoolData>.Write(ModelReaderWriterOptions) |
Writes the model into a BinaryData. |
