SynapseSqlPoolResource 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 SynapseSqlPool along with the instance operations that can be performed on it. If you have a ResourceIdentifier you can construct a SynapseSqlPoolResource from an instance of ArmClient using the GetSynapseSqlPoolResource method. Otherwise you can get one from its parent resource SynapseWorkspaceResource using the GetSynapseSqlPool method.
public class SynapseSqlPoolResource : Azure.ResourceManager.ArmResource, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.Synapse.SynapseSqlPoolData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.Synapse.SynapseSqlPoolData>public class SynapseSqlPoolResource : Azure.ResourceManager.ArmResourcetype SynapseSqlPoolResource = class
inherit ArmResource
interface IJsonModel<SynapseSqlPoolData>
interface IPersistableModel<SynapseSqlPoolData>type SynapseSqlPoolResource = class
inherit ArmResourcePublic Class SynapseSqlPoolResource
Inherits ArmResource
Implements IJsonModel(Of SynapseSqlPoolData), IPersistableModel(Of SynapseSqlPoolData)Public Class SynapseSqlPoolResource
Inherits ArmResource- Inheritance
- Implements
Constructors
| Name | Description |
|---|---|
| SynapseSqlPoolResource() |
Initializes a new instance of the SynapseSqlPoolResource 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 |
|---|---|
| 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) |
| CreateResourceIdentifier(String, String, String, String) |
Generate the resource identifier of a SynapseSqlPoolResource instance. |
| CreateSqlPoolRestorePoint(WaitUntil, SqlPoolCreateRestorePointContent, CancellationToken) |
Creates a restore point for a data warehouse.
|
| CreateSqlPoolRestorePointAsync(WaitUntil, SqlPoolCreateRestorePointContent, CancellationToken) |
Creates a restore point for a data warehouse.
|
| Delete(WaitUntil, CancellationToken) |
Delete a SQL pool. You can call ToObjectFromJson<SynapseSqlPoolData>() against the Value property of the result to get specified type.
|
| DeleteAsync(WaitUntil, CancellationToken) |
Delete a SQL pool. You can call ToObjectFromJson<SynapseSqlPoolData>() against the Value property of the result to get specified type.
|
| Get(CancellationToken) |
Get SQL pool properties
|
| GetAsync(CancellationToken) |
Get SQL pool properties
|
| GetAvailableLocations(CancellationToken) |
Lists all available geo-locations. (Inherited from ArmResource) |
| GetAvailableLocationsAsync(CancellationToken) |
Lists all available geo-locations. (Inherited from ArmResource) |
| GetCurrentSqlPoolSensitivityLabels(String, CancellationToken) |
Gets SQL pool sensitivity labels.
|
| GetCurrentSqlPoolSensitivityLabelsAsync(String, CancellationToken) |
Gets SQL pool sensitivity labels.
|
| 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) |
| GetRecommendedSqlPoolSensitivityLabels(Nullable<Boolean>, String, String, CancellationToken) |
Gets sensitivity labels of a given SQL pool.
|
| GetRecommendedSqlPoolSensitivityLabelsAsync(Nullable<Boolean>, String, String, CancellationToken) |
Gets sensitivity labels of a given SQL pool.
|
| GetSqlPoolUsages(CancellationToken) |
Gets SQL pool usages.
|
| GetSqlPoolUsagesAsync(CancellationToken) |
Gets SQL pool usages.
|
| GetSynapseDataMaskingPolicy() |
Gets an object representing a SynapseDataMaskingPolicyResource along with the instance operations that can be performed on it in the SynapseSqlPool. |
| GetSynapseDataWarehouseUserActivities() |
Gets a collection of SynapseDataWarehouseUserActivityResources in the SynapseSqlPool. |
| GetSynapseDataWarehouseUserActivity(SynapseDataWarehouseUserActivityName, CancellationToken) |
Gets the user activities of a SQL pool which includes running and suspended queries
|
| GetSynapseDataWarehouseUserActivityAsync(SynapseDataWarehouseUserActivityName, CancellationToken) |
Gets the user activities of a SQL pool which includes running and suspended queries
|
| GetSynapseExtendedSqlPoolBlobAuditingPolicy() |
Gets an object representing a SynapseExtendedSqlPoolBlobAuditingPolicyResource along with the instance operations that can be performed on it in the SynapseSqlPool. |
| GetSynapseGeoBackupPolicies() |
Gets a collection of SynapseGeoBackupPolicyResources in the SynapseSqlPool. |
| GetSynapseGeoBackupPolicy(SynapseGeoBackupPolicyName, CancellationToken) |
Get the specified SQL pool geo backup policy
|
| GetSynapseGeoBackupPolicyAsync(SynapseGeoBackupPolicyName, CancellationToken) |
Get the specified SQL pool geo backup policy
|
| GetSynapseMaintenanceWindow() |
Gets an object representing a SynapseMaintenanceWindowResource along with the instance operations that can be performed on it in the SynapseSqlPool. |
| GetSynapseMaintenanceWindowOption() |
Gets an object representing a SynapseMaintenanceWindowOptionResource along with the instance operations that can be performed on it in the SynapseSqlPool. |
| GetSynapseMetadataSyncConfiguration() |
Gets an object representing a SynapseMetadataSyncConfigurationResource along with the instance operations that can be performed on it in the SynapseSqlPool. |
| GetSynapseReplicationLink(String, CancellationToken) |
Get SQL pool replication link by name.
|
| GetSynapseReplicationLinkAsync(String, CancellationToken) |
Get SQL pool replication link by name.
|
| GetSynapseReplicationLinks() |
Gets a collection of SynapseReplicationLinkResources in the SynapseSqlPool. |
| GetSynapseRestorePoint(String, CancellationToken) |
Gets a restore point.
|
| GetSynapseRestorePointAsync(String, CancellationToken) |
Gets a restore point.
|
| GetSynapseRestorePoints() |
Gets a collection of SynapseRestorePointResources in the SynapseSqlPool. |
| GetSynapseSqlPoolBlobAuditingPolicy() |
Gets an object representing a SynapseSqlPoolBlobAuditingPolicyResource along with the instance operations that can be performed on it in the SynapseSqlPool. |
| GetSynapseSqlPoolConnectionPolicies() |
Gets a collection of SynapseSqlPoolConnectionPolicyResources in the SynapseSqlPool. |
| GetSynapseSqlPoolConnectionPolicy(SqlPoolConnectionPolicyName, CancellationToken) |
Get a Sql pool's connection policy, which is used with table auditing.
|
| GetSynapseSqlPoolConnectionPolicyAsync(SqlPoolConnectionPolicyName, CancellationToken) |
Get a Sql pool's connection policy, which is used with table auditing.
|
| GetSynapseSqlPoolSchema(String, CancellationToken) |
Get Sql Pool schema
|
| GetSynapseSqlPoolSchemaAsync(String, CancellationToken) |
Get Sql Pool schema
|
| GetSynapseSqlPoolSchemas() |
Gets a collection of SynapseSqlPoolSchemaResources in the SynapseSqlPool. |
| GetSynapseSqlPoolSecurityAlertPolicies() |
Gets a collection of SynapseSqlPoolSecurityAlertPolicyResources in the SynapseSqlPool. |
| GetSynapseSqlPoolSecurityAlertPolicy(SqlPoolSecurityAlertPolicyName, CancellationToken) |
Get a Sql pool's security alert policy.
|
| GetSynapseSqlPoolSecurityAlertPolicyAsync(SqlPoolSecurityAlertPolicyName, CancellationToken) |
Get a Sql pool's security alert policy.
|
| GetSynapseSqlPoolVulnerabilityAssessment(SynapseVulnerabilityAssessmentName, CancellationToken) |
Gets the Sql pool's vulnerability assessment.
|
| GetSynapseSqlPoolVulnerabilityAssessmentAsync(SynapseVulnerabilityAssessmentName, CancellationToken) |
Gets the Sql pool's vulnerability assessment.
|
| GetSynapseSqlPoolVulnerabilityAssessments() |
Gets a collection of SynapseSqlPoolVulnerabilityAssessmentResources in the SynapseSqlPool. |
| GetSynapseTransparentDataEncryption(SynapseTransparentDataEncryptionName, CancellationToken) |
Get a SQL pool's transparent data encryption configuration.
|
| GetSynapseTransparentDataEncryptionAsync(SynapseTransparentDataEncryptionName, CancellationToken) |
Get a SQL pool's transparent data encryption configuration.
|
| GetSynapseTransparentDataEncryptions() |
Gets a collection of SynapseTransparentDataEncryptionResources in the SynapseSqlPool. |
| GetSynapseWorkloadGroup(String, CancellationToken) |
Get a Sql pool's workload group.
|
| GetSynapseWorkloadGroupAsync(String, CancellationToken) |
Get a Sql pool's workload group.
|
| GetSynapseWorkloadGroups() |
Gets a collection of SynapseWorkloadGroupResources in the SynapseSqlPool. |
| GetTagResource() |
Gets an object representing a TagResource along with the instance operations that can be performed on it in the ArmResource. (Inherited from ArmResource) |
| Pause(WaitUntil, CancellationToken) |
Pause a SQL pool. You can call ToObjectFromJson<SynapseSqlPoolData>() against the Value property of the result to get specified type.
|
| PauseAsync(WaitUntil, CancellationToken) |
Pause a SQL pool. You can call ToObjectFromJson<SynapseSqlPoolData>() against the Value property of the result to get specified type.
|
| RemoveTag(String, CancellationToken) |
Removes a tag by key from the resource.
|
| RemoveTagAsync(String, CancellationToken) |
Removes a tag by key from the resource.
|
| Rename(SynapseResourceMoveDefinition, CancellationToken) |
Rename a SQL pool.
|
| RenameAsync(SynapseResourceMoveDefinition, CancellationToken) |
Rename a SQL pool.
|
| Resume(WaitUntil, CancellationToken) |
Resume a SQL pool. You can call ToObjectFromJson<SynapseSqlPoolData>() against the Value property of the result to get specified type.
|
| ResumeAsync(WaitUntil, CancellationToken) |
Resume a SQL pool. You can call ToObjectFromJson<SynapseSqlPoolData>() against the Value property of the result to get specified type.
|
| 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.
|
| TryGetApiVersion(ResourceType, String) |
Gets the api version override if it has been set for the current client options. (Inherited from ArmResource) |
| Update(WaitUntil, SynapseSqlPoolPatch, CancellationToken) |
Apply a partial update to a SQL pool
|
| UpdateAsync(WaitUntil, SynapseSqlPoolPatch, CancellationToken) |
Apply a partial update to a SQL pool
|
| UpdateSqlPoolRecommendedSensitivityLabel(SynapseRecommendedSensitivityLabelUpdateOperationListResult, CancellationToken) |
Update recommended sensitivity labels states of a given SQL Pool using an operations batch.
|
| UpdateSqlPoolRecommendedSensitivityLabelAsync(SynapseRecommendedSensitivityLabelUpdateOperationListResult, CancellationToken) |
Update recommended sensitivity labels states of a given SQL Pool using an operations batch.
|
| UpdateSqlPoolSensitivityLabel(SynapseSensitivityLabelUpdateListResult, CancellationToken) |
Update sensitivity labels of a given SQL Pool using an operations batch.
|
| UpdateSqlPoolSensitivityLabelAsync(SynapseSensitivityLabelUpdateListResult, CancellationToken) |
Update sensitivity labels of a given SQL Pool using an operations batch.
|
Explicit Interface Implementations
| Name | Description |
|---|---|
| IJsonModel<SynapseSqlPoolData>.Create(Utf8JsonReader, ModelReaderWriterOptions) |
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. |
| IJsonModel<SynapseSqlPoolData>.Write(Utf8JsonWriter, ModelReaderWriterOptions) |
Writes the model to the provided Utf8JsonWriter. |
| IPersistableModel<SynapseSqlPoolData>.Create(BinaryData, ModelReaderWriterOptions) |
Converts the provided BinaryData into a model. |
| IPersistableModel<SynapseSqlPoolData>.GetFormatFromOptions(ModelReaderWriterOptions) |
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. |
| IPersistableModel<SynapseSqlPoolData>.Write(ModelReaderWriterOptions) |
Writes the model into a BinaryData. |
