SqlServerResource 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 SqlServer along with the instance operations that can be performed on it. If you have a ResourceIdentifier you can construct a SqlServerResource from an instance of ArmClient using the GetSqlServerResource method. Otherwise you can get one from its parent resource ResourceGroupResource using the GetSqlServer method.
public class SqlServerResource : Azure.ResourceManager.ArmResource, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.Sql.SqlServerData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.Sql.SqlServerData>
type SqlServerResource = class
inherit ArmResource
interface IJsonModel<SqlServerData>
interface IPersistableModel<SqlServerData>
Public Class SqlServerResource
Inherits ArmResource
Implements IJsonModel(Of SqlServerData), IPersistableModel(Of SqlServerData)
- Inheritance
- Implements
Constructors
| Name | Description |
|---|---|
| SqlServerResource() |
Initializes a new instance of SqlServerResource 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) |
| Create(WaitUntil, TdeCertificate, CancellationToken) |
Creates a TDE certificate for a given server.
|
| CreateAsync(WaitUntil, TdeCertificate, CancellationToken) |
Creates a TDE certificate for a given server.
|
| CreateResourceIdentifier(String, String, String) |
Generate the resource identifier for this resource. |
| Delete(WaitUntil, CancellationToken) |
Deletes a server.
|
| DeleteAsync(WaitUntil, CancellationToken) |
Deletes a server.
|
| Get(String, CancellationToken) |
Gets a server.
|
| GetAsync(String, CancellationToken) |
Gets a server.
|
| GetAvailableLocations(CancellationToken) |
Lists all available geo-locations. (Inherited from ArmResource) |
| GetAvailableLocationsAsync(CancellationToken) |
Lists all available geo-locations. (Inherited from ArmResource) |
| GetByServer(CancellationToken) |
Gets a list of replication links.
|
| GetByServerAsync(CancellationToken) |
Gets a list of replication links.
|
| GetElasticPool(String, CancellationToken) |
Gets an elastic pool. |
| GetElasticPoolAsync(String, CancellationToken) |
Gets an elastic pool. |
| GetElasticPools() |
Gets a collection of ElasticPools in the SqlServerResource. |
| GetEncryptionProtector(EncryptionProtectorName, CancellationToken) |
Gets a server encryption protector. |
| GetEncryptionProtectorAsync(EncryptionProtectorName, CancellationToken) |
Gets a server encryption protector. |
| GetEncryptionProtectors() |
Gets a collection of EncryptionProtectors in the SqlServerResource. |
| GetExtendedServerBlobAuditingPolicies() |
Gets a collection of ExtendedServerBlobAuditingPolicies in the SqlServerResource. |
| GetExtendedServerBlobAuditingPolicy(BlobAuditingPolicyName, CancellationToken) |
Gets an extended server's blob auditing policy. |
| GetExtendedServerBlobAuditingPolicyAsync(BlobAuditingPolicyName, CancellationToken) |
Gets an extended server's blob auditing policy. |
| GetFailoverGroup(String, CancellationToken) |
Gets a failover group. |
| GetFailoverGroupAsync(String, CancellationToken) |
Gets a failover group. |
| GetFailoverGroups() |
Gets a collection of FailoverGroups in the SqlServerResource. |
| GetInaccessibleByServer(CancellationToken) |
Gets a list of inaccessible databases in a logical server
|
| GetInaccessibleByServerAsync(CancellationToken) |
Gets a list of inaccessible databases in a logical server
|
| GetIPv6FirewallRule(String, CancellationToken) |
Gets an IPv6 firewall rule. |
| GetIPv6FirewallRuleAsync(String, CancellationToken) |
Gets an IPv6 firewall rule. |
| GetIPv6FirewallRules() |
Gets a collection of IPv6FirewallRules in the SqlServerResource. |
| 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) |
| GetOutboundFirewallRule(String, CancellationToken) |
Gets an outbound firewall rule. |
| GetOutboundFirewallRuleAsync(String, CancellationToken) |
Gets an outbound firewall rule. |
| GetOutboundFirewallRules() |
Gets a collection of OutboundFirewallRules in the SqlServerResource. |
| 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) |
| GetRecoverableDatabase(String, String, String, CancellationToken) |
Gets a recoverable database. |
| GetRecoverableDatabaseAsync(String, String, String, CancellationToken) |
Gets a recoverable database. |
| GetRecoverableDatabases() |
Gets a collection of RecoverableDatabases in the SqlServerResource. |
| GetRestorableDroppedDatabase(String, String, String, CancellationToken) |
Gets a restorable dropped database. |
| GetRestorableDroppedDatabaseAsync(String, String, String, CancellationToken) |
Gets a restorable dropped database. |
| GetRestorableDroppedDatabases() |
Gets a collection of RestorableDroppedDatabases in the SqlServerResource. |
| GetServerAdvancedThreatProtection(AdvancedThreatProtectionName, CancellationToken) |
Get a server's Advanced Threat Protection state. |
| GetServerAdvancedThreatProtectionAsync(AdvancedThreatProtectionName, CancellationToken) |
Get a server's Advanced Threat Protection state. |
| GetServerAdvancedThreatProtections() |
Gets a collection of ServerAdvancedThreatProtections in the SqlServerResource. |
| GetServerOperations(CancellationToken) |
Gets a list of operations performed on the server.
|
| GetServerOperationsAsync(CancellationToken) |
Gets a list of operations performed on the server.
|
| GetServerUsages(CancellationToken) |
Gets server usages.
|
| GetServerUsagesAsync(CancellationToken) |
Gets server usages.
|
| GetSqlDatabase(String, String, String, CancellationToken) |
Gets a database. |
| GetSqlDatabaseAsync(String, String, String, CancellationToken) |
Gets a database. |
| GetSqlDatabases() |
Gets a collection of SqlDatabases in the SqlServerResource. |
| GetSqlFirewallRule(String, CancellationToken) |
Gets a firewall rule. |
| GetSqlFirewallRuleAsync(String, CancellationToken) |
Gets a firewall rule. |
| GetSqlFirewallRules() |
Gets a collection of SqlFirewallRules in the SqlServerResource. |
| GetSqlNetworkSecurityPerimeterConfiguration(String, CancellationToken) |
Gets a network security perimeter configuration. |
| GetSqlNetworkSecurityPerimeterConfigurationAsync(String, CancellationToken) |
Gets a network security perimeter configuration. |
| GetSqlNetworkSecurityPerimeterConfigurations() |
Gets a collection of SqlNetworkSecurityPerimeterConfigurations in the SqlServerResource. |
| GetSqlPrivateEndpointConnection(String, CancellationToken) |
Gets a private endpoint connection. |
| GetSqlPrivateEndpointConnectionAsync(String, CancellationToken) |
Gets a private endpoint connection. |
| GetSqlPrivateEndpointConnections() |
Gets a collection of SqlPrivateEndpointConnections in the SqlServerResource. |
| GetSqlPrivateLinkResource(String, CancellationToken) |
Gets a private link resource for SQL server. |
| GetSqlPrivateLinkResourceAsync(String, CancellationToken) |
Gets a private link resource for SQL server. |
| GetSqlPrivateLinkResources() |
Gets a collection of SqlPrivateLinkResources in the SqlServerResource. |
| GetSqlServerAdvisor(String, CancellationToken) |
Gets a server advisor. |
| GetSqlServerAdvisorAsync(String, CancellationToken) |
Gets a server advisor. |
| GetSqlServerAdvisors() |
Gets a collection of SqlServerAdvisors in the SqlServerResource. |
| GetSqlServerAutomaticTuning() |
Gets an object representing a SqlServerAutomaticTuningResource along with the instance operations that can be performed on it in the SqlServerResource. |
| GetSqlServerAzureADAdministrator(SqlAdministratorName, CancellationToken) |
Gets a Azure Active Directory administrator. |
| GetSqlServerAzureADAdministratorAsync(SqlAdministratorName, CancellationToken) |
Gets a Azure Active Directory administrator. |
| GetSqlServerAzureADAdministrators() |
Gets a collection of SqlServerAzureADAdministrators in the SqlServerResource. |
| GetSqlServerAzureADOnlyAuthentication(AuthenticationName, CancellationToken) |
Gets a specific Azure Active Directory only authentication property. |
| GetSqlServerAzureADOnlyAuthenticationAsync(AuthenticationName, CancellationToken) |
Gets a specific Azure Active Directory only authentication property. |
| GetSqlServerAzureADOnlyAuthentications() |
Gets a collection of SqlServerAzureADOnlyAuthentications in the SqlServerResource. |
| GetSqlServerBlobAuditingPolicies() |
Gets a collection of SqlServerBlobAuditingPolicies in the SqlServerResource. |
| GetSqlServerBlobAuditingPolicy(BlobAuditingPolicyName, CancellationToken) |
Gets a server's blob auditing policy. |
| GetSqlServerBlobAuditingPolicyAsync(BlobAuditingPolicyName, CancellationToken) |
Gets a server's blob auditing policy. |
| GetSqlServerConnectionPolicies() |
Gets a collection of SqlServerConnectionPolicies in the SqlServerResource. |
| GetSqlServerConnectionPolicy(ConnectionPolicyName, CancellationToken) |
Gets a server connection policy. |
| GetSqlServerConnectionPolicyAsync(ConnectionPolicyName, CancellationToken) |
Gets a server connection policy. |
| GetSqlServerDevOpsAuditingSetting(DevOpsAuditingSettingsName, CancellationToken) |
Gets a server's DevOps audit settings. |
| GetSqlServerDevOpsAuditingSettingAsync(DevOpsAuditingSettingsName, CancellationToken) |
Gets a server's DevOps audit settings. |
| GetSqlServerDevOpsAuditingSettings() |
Gets a collection of SqlServerDevOpsAuditingSettings in the SqlServerResource. |
| GetSqlServerDnsAlias(String, CancellationToken) |
Gets a server DNS alias. |
| GetSqlServerDnsAliasAsync(String, CancellationToken) |
Gets a server DNS alias. |
| GetSqlServerDnsAliases() |
Gets a collection of SqlServerDnsAliases in the SqlServerResource. |
| GetSqlServerJobAgent(String, CancellationToken) |
Gets a job agent. |
| GetSqlServerJobAgentAsync(String, CancellationToken) |
Gets a job agent. |
| GetSqlServerJobAgents() |
Gets a collection of SqlServerJobAgents in the SqlServerResource. |
| GetSqlServerKey(String, CancellationToken) |
Gets a server key. |
| GetSqlServerKeyAsync(String, CancellationToken) |
Gets a server key. |
| GetSqlServerKeys() |
Gets a collection of SqlServerKeys in the SqlServerResource. |
| GetSqlServerSecurityAlertPolicies() |
Gets a collection of SqlServerSecurityAlertPolicies in the SqlServerResource. |
| GetSqlServerSecurityAlertPolicy(SqlSecurityAlertPolicyName, CancellationToken) |
Get a server's security alert policy. |
| GetSqlServerSecurityAlertPolicyAsync(SqlSecurityAlertPolicyName, CancellationToken) |
Get a server's security alert policy. |
| GetSqlServerSqlVulnerabilityAssessment(String, CancellationToken) |
Gets SQL Vulnerability Assessment policy. |
| GetSqlServerSqlVulnerabilityAssessmentAsync(String, CancellationToken) |
Gets SQL Vulnerability Assessment policy. |
| GetSqlServerSqlVulnerabilityAssessments() |
Gets a collection of SqlServerSqlVulnerabilityAssessments in the SqlServerResource. |
| GetSqlServerVirtualNetworkRule(String, CancellationToken) |
Gets a virtual network rule. |
| GetSqlServerVirtualNetworkRuleAsync(String, CancellationToken) |
Gets a virtual network rule. |
| GetSqlServerVirtualNetworkRules() |
Gets a collection of SqlServerVirtualNetworkRules in the SqlServerResource. |
| GetSqlServerVulnerabilityAssessment(VulnerabilityAssessmentName, CancellationToken) |
Gets the server's vulnerability assessment. |
| GetSqlServerVulnerabilityAssessmentAsync(VulnerabilityAssessmentName, CancellationToken) |
Gets the server's vulnerability assessment. |
| GetSqlServerVulnerabilityAssessments() |
Gets a collection of SqlServerVulnerabilityAssessments in the SqlServerResource. |
| GetSyncAgent(String, CancellationToken) |
Gets a sync agent. |
| GetSyncAgentAsync(String, CancellationToken) |
Gets a sync agent. |
| GetSyncAgents() |
Gets a collection of SyncAgents in the SqlServerResource. |
| GetTagResource() |
Gets an object representing a TagResource along with the instance operations that can be performed on it in the ArmResource. (Inherited from ArmResource) |
| ImportDatabase(WaitUntil, DatabaseImportDefinition, CancellationToken) |
Imports a bacpac into a new database.
|
| ImportDatabaseAsync(WaitUntil, DatabaseImportDefinition, CancellationToken) |
Imports a bacpac into a new database.
|
| RefreshStatus(WaitUntil, CancellationToken) |
Refresh external governance enablement status.
|
| RefreshStatusAsync(WaitUntil, CancellationToken) |
Refresh external governance enablement status.
|
| 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. |
| TryGetApiVersion(ResourceType, String) |
Gets the api version override if it has been set for the current client options. (Inherited from ArmResource) |
| Update(WaitUntil, SqlServerPatch, CancellationToken) |
Updates a server.
|
| UpdateAsync(WaitUntil, SqlServerPatch, CancellationToken) |
Updates a server.
|
Explicit Interface Implementations
| Name | Description |
|---|---|
| IJsonModel<SqlServerData>.Create(Utf8JsonReader, ModelReaderWriterOptions) |
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. |
| IJsonModel<SqlServerData>.Write(Utf8JsonWriter, ModelReaderWriterOptions) |
Writes the model to the provided Utf8JsonWriter. |
| IPersistableModel<SqlServerData>.Create(BinaryData, ModelReaderWriterOptions) |
Converts the provided BinaryData into a model. |
| IPersistableModel<SqlServerData>.GetFormatFromOptions(ModelReaderWriterOptions) |
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. |
| IPersistableModel<SqlServerData>.Write(ModelReaderWriterOptions) |
Writes the model into a BinaryData. |