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.ArmResourcepublic 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 ArmResourcetype SqlServerResource = class
inherit ArmResource
interface IJsonModel<SqlServerData>
interface IPersistableModel<SqlServerData>Public Class SqlServerResource
Inherits ArmResourcePublic Class SqlServerResource
Inherits ArmResource
Implements IJsonModel(Of SqlServerData), IPersistableModel(Of SqlServerData)- Inheritance
- Implements
Constructors
| SqlServerResource() |
Initializes a new instance of the SqlServerResource class for mocking. |
Fields
| ResourceType |
Gets the resource type for the operations. |
Properties
| 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
| 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) |
Generate the resource identifier of a SqlServerResource instance. |
| CreateTdeCertificate(WaitUntil, TdeCertificate, CancellationToken) |
Creates a TDE certificate for a given server.
|
| CreateTdeCertificateAsync(WaitUntil, TdeCertificate, CancellationToken) |
Creates a TDE certificate for a given server.
|
| 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) |
| GetElasticPool(String, CancellationToken) |
Gets an elastic pool.
|
| GetElasticPoolAsync(String, CancellationToken) |
Gets an elastic pool.
|
| GetElasticPools() |
Gets a collection of ElasticPoolResources in the SqlServer. |
| GetEncryptionProtector(EncryptionProtectorName, CancellationToken) |
Gets a server encryption protector.
|
| GetEncryptionProtectorAsync(EncryptionProtectorName, CancellationToken) |
Gets a server encryption protector.
|
| GetEncryptionProtectors() |
Gets a collection of EncryptionProtectorResources in the SqlServer. |
| GetExtendedServerBlobAuditingPolicies() |
Gets a collection of ExtendedServerBlobAuditingPolicyResources in the SqlServer. |
| 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 FailoverGroupResources in the SqlServer. |
| GetInaccessibleDatabases(CancellationToken) |
Gets a list of inaccessible databases in a logical server
|
| GetInaccessibleDatabasesAsync(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 IPv6FirewallRuleResources in the SqlServer. |
| 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 OutboundFirewallRuleResources in the SqlServer. |
| 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 RecoverableDatabaseResources in the SqlServer. |
| GetReplicationLinks(CancellationToken) |
Gets a list of replication links.
|
| GetReplicationLinksAsync(CancellationToken) |
Gets a list of replication links.
|
| 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 RestorableDroppedDatabaseResources in the SqlServer. |
| 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 ServerAdvancedThreatProtectionResources in the SqlServer. |
| GetServerOperations(CancellationToken) |
Gets a list of operations performed on the server.
|
| GetServerOperationsAsync(CancellationToken) |
Gets a list of operations performed on the server.
|
| GetServerUsages(CancellationToken) |
Returns server usages.
|
| GetServerUsagesAsync(CancellationToken) |
Returns server usages.
|
| GetServiceObjective(String, CancellationToken) |
Gets a database service objective.
|
| GetServiceObjectiveAsync(String, CancellationToken) |
Gets a database service objective.
|
| GetServiceObjectives() |
Gets a collection of ServiceObjectiveResources in the SqlServer. |
| GetSqlDatabase(String, String, String, CancellationToken) |
Gets a database.
|
| GetSqlDatabaseAsync(String, String, String, CancellationToken) |
Gets a database.
|
| GetSqlDatabases() |
Gets a collection of SqlDatabaseResources in the SqlServer. |
| GetSqlFirewallRule(String, CancellationToken) |
Gets a firewall rule.
|
| GetSqlFirewallRuleAsync(String, CancellationToken) |
Gets a firewall rule.
|
| GetSqlFirewallRules() |
Gets a collection of SqlFirewallRuleResources in the SqlServer. |
| GetSqlPrivateEndpointConnection(String, CancellationToken) |
Gets a private endpoint connection.
|
| GetSqlPrivateEndpointConnectionAsync(String, CancellationToken) |
Gets a private endpoint connection.
|
| GetSqlPrivateEndpointConnections() |
Gets a collection of SqlPrivateEndpointConnectionResources in the SqlServer. |
| 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 SqlServer. |
| GetSqlServerAdvisor(String, CancellationToken) |
Gets a server advisor.
|
| GetSqlServerAdvisorAsync(String, CancellationToken) |
Gets a server advisor.
|
| GetSqlServerAdvisors() |
Gets a collection of SqlServerAdvisorResources in the SqlServer. |
| GetSqlServerAutomaticTuning() |
Gets an object representing a SqlServerAutomaticTuningResource along with the instance operations that can be performed on it in the SqlServer. |
| GetSqlServerAzureADAdministrator(SqlAdministratorName, CancellationToken) |
Gets a Azure Active Directory administrator.
|
| GetSqlServerAzureADAdministratorAsync(SqlAdministratorName, CancellationToken) |
Gets a Azure Active Directory administrator.
|
| GetSqlServerAzureADAdministrators() |
Gets a collection of SqlServerAzureADAdministratorResources in the SqlServer. |
| 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 SqlServerAzureADOnlyAuthenticationResources in the SqlServer. |
| GetSqlServerBlobAuditingPolicies() |
Gets a collection of SqlServerBlobAuditingPolicyResources in the SqlServer. |
| GetSqlServerBlobAuditingPolicy(BlobAuditingPolicyName, CancellationToken) |
Gets a server's blob auditing policy.
|
| GetSqlServerBlobAuditingPolicyAsync(BlobAuditingPolicyName, CancellationToken) |
Gets a server's blob auditing policy.
|
| GetSqlServerCommunicationLink(String, CancellationToken) |
Returns a server communication link.
|
| GetSqlServerCommunicationLinkAsync(String, CancellationToken) |
Returns a server communication link.
|
| GetSqlServerCommunicationLinks() |
Gets a collection of SqlServerCommunicationLinkResources in the SqlServer. |
| GetSqlServerConnectionPolicies() |
Gets a collection of SqlServerConnectionPolicyResources in the SqlServer. |
| GetSqlServerConnectionPolicy(ConnectionPolicyName, CancellationToken) |
Gets a server connection policy
|
| GetSqlServerConnectionPolicyAsync(ConnectionPolicyName, CancellationToken) |
Gets a server connection policy
|
| GetSqlServerDevOpsAuditingSetting(String, CancellationToken) |
Gets a server's DevOps audit settings.
|
| GetSqlServerDevOpsAuditingSettingAsync(String, CancellationToken) |
Gets a server's DevOps audit settings.
|
| GetSqlServerDevOpsAuditingSettings() |
Gets a collection of SqlServerDevOpsAuditingSettingResources in the SqlServer. |
| GetSqlServerDnsAlias(String, CancellationToken) |
Gets a server DNS alias.
|
| GetSqlServerDnsAliasAsync(String, CancellationToken) |
Gets a server DNS alias.
|
| GetSqlServerDnsAliases() |
Gets a collection of SqlServerDnsAliasResources in the SqlServer. |
| GetSqlServerJobAgent(String, CancellationToken) |
Gets a job agent.
|
| GetSqlServerJobAgentAsync(String, CancellationToken) |
Gets a job agent.
|
| GetSqlServerJobAgents() |
Gets a collection of SqlServerJobAgentResources in the SqlServer. |
| GetSqlServerKey(String, CancellationToken) |
Gets a server key.
|
| GetSqlServerKeyAsync(String, CancellationToken) |
Gets a server key.
|
| GetSqlServerKeys() |
Gets a collection of SqlServerKeyResources in the SqlServer. |
| GetSqlServerSecurityAlertPolicies() |
Gets a collection of SqlServerSecurityAlertPolicyResources in the SqlServer. |
| GetSqlServerSecurityAlertPolicy(SqlSecurityAlertPolicyName, CancellationToken) |
Get a server's security alert policy.
|
| GetSqlServerSecurityAlertPolicyAsync(SqlSecurityAlertPolicyName, CancellationToken) |
Get a server's security alert policy.
|
| GetSqlServerSqlVulnerabilityAssessment(VulnerabilityAssessmentName, CancellationToken) |
Gets SQL Vulnerability Assessment policy.
|
| GetSqlServerSqlVulnerabilityAssessmentAsync(VulnerabilityAssessmentName, CancellationToken) |
Gets SQL Vulnerability Assessment policy.
|
| GetSqlServerSqlVulnerabilityAssessments() |
Gets a collection of SqlServerSqlVulnerabilityAssessmentResources in the SqlServer. |
| GetSqlServerVirtualNetworkRule(String, CancellationToken) |
Gets a virtual network rule.
|
| GetSqlServerVirtualNetworkRuleAsync(String, CancellationToken) |
Gets a virtual network rule.
|
| GetSqlServerVirtualNetworkRules() |
Gets a collection of SqlServerVirtualNetworkRuleResources in the SqlServer. |
| GetSqlServerVulnerabilityAssessment(VulnerabilityAssessmentName, CancellationToken) |
Gets the server's vulnerability assessment.
|
| GetSqlServerVulnerabilityAssessmentAsync(VulnerabilityAssessmentName, CancellationToken) |
Gets the server's vulnerability assessment.
|
| GetSqlServerVulnerabilityAssessments() |
Gets a collection of SqlServerVulnerabilityAssessmentResources in the SqlServer. |
| GetSyncAgent(String, CancellationToken) |
Gets a sync agent.
|
| GetSyncAgentAsync(String, CancellationToken) |
Gets a sync agent.
|
| GetSyncAgents() |
Gets a collection of SyncAgentResources in the SqlServer. |
| 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
| 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. |
Extension Methods
| GetAuthorizationRoleDefinition(ArmResource, ResourceIdentifier, CancellationToken) |
Get role definition by name (GUID).
|
| GetAuthorizationRoleDefinitionAsync(ArmResource, ResourceIdentifier, CancellationToken) |
Get role definition by name (GUID).
|
| GetAuthorizationRoleDefinitions(ArmResource) |
Gets a collection of AuthorizationRoleDefinitionResources in the ArmResource. MockingTo mock this method, please mock GetAuthorizationRoleDefinitions() instead. |
| GetDenyAssignment(ArmResource, String, CancellationToken) |
Get the specified deny assignment.
|
| GetDenyAssignmentAsync(ArmResource, String, CancellationToken) |
Get the specified deny assignment.
|
| GetDenyAssignments(ArmResource) |
Gets a collection of DenyAssignmentResources in the ArmResource. MockingTo mock this method, please mock GetDenyAssignments() instead. |
| GetRoleAssignment(ArmResource, String, String, CancellationToken) |
Get a role assignment by scope and name.
|
| GetRoleAssignmentAsync(ArmResource, String, String, CancellationToken) |
Get a role assignment by scope and name.
|
| GetRoleAssignments(ArmResource) |
Gets a collection of RoleAssignmentResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignments() instead. |
| GetRoleAssignmentSchedule(ArmResource, String, CancellationToken) |
Get the specified role assignment schedule for a resource scope
|
| GetRoleAssignmentScheduleAsync(ArmResource, String, CancellationToken) |
Get the specified role assignment schedule for a resource scope
|
| GetRoleAssignmentScheduleInstance(ArmResource, String, CancellationToken) |
Gets the specified role assignment schedule instance.
|
| GetRoleAssignmentScheduleInstanceAsync(ArmResource, String, CancellationToken) |
Gets the specified role assignment schedule instance.
|
| GetRoleAssignmentScheduleInstances(ArmResource) |
Gets a collection of RoleAssignmentScheduleInstanceResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignmentScheduleInstances() instead. |
| GetRoleAssignmentScheduleRequest(ArmResource, String, CancellationToken) |
Get the specified role assignment schedule request.
|
| GetRoleAssignmentScheduleRequestAsync(ArmResource, String, CancellationToken) |
Get the specified role assignment schedule request.
|
| GetRoleAssignmentScheduleRequests(ArmResource) |
Gets a collection of RoleAssignmentScheduleRequestResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignmentScheduleRequests() instead. |
| GetRoleAssignmentSchedules(ArmResource) |
Gets a collection of RoleAssignmentScheduleResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignmentSchedules() instead. |
| GetRoleEligibilitySchedule(ArmResource, String, CancellationToken) |
Get the specified role eligibility schedule for a resource scope
|
| GetRoleEligibilityScheduleAsync(ArmResource, String, CancellationToken) |
Get the specified role eligibility schedule for a resource scope
|
| GetRoleEligibilityScheduleInstance(ArmResource, String, CancellationToken) |
Gets the specified role eligibility schedule instance.
|
| GetRoleEligibilityScheduleInstanceAsync(ArmResource, String, CancellationToken) |
Gets the specified role eligibility schedule instance.
|
| GetRoleEligibilityScheduleInstances(ArmResource) |
Gets a collection of RoleEligibilityScheduleInstanceResources in the ArmResource. MockingTo mock this method, please mock GetRoleEligibilityScheduleInstances() instead. |
| GetRoleEligibilityScheduleRequest(ArmResource, String, CancellationToken) |
Get the specified role eligibility schedule request.
|
| GetRoleEligibilityScheduleRequestAsync(ArmResource, String, CancellationToken) |
Get the specified role eligibility schedule request.
|
| GetRoleEligibilityScheduleRequests(ArmResource) |
Gets a collection of RoleEligibilityScheduleRequestResources in the ArmResource. MockingTo mock this method, please mock GetRoleEligibilityScheduleRequests() instead. |
| GetRoleEligibilitySchedules(ArmResource) |
Gets a collection of RoleEligibilityScheduleResources in the ArmResource. MockingTo mock this method, please mock GetRoleEligibilitySchedules() instead. |
| GetRoleManagementPolicies(ArmResource) |
Gets a collection of RoleManagementPolicyResources in the ArmResource. MockingTo mock this method, please mock GetRoleManagementPolicies() instead. |
| GetRoleManagementPolicy(ArmResource, String, CancellationToken) |
Get the specified role management policy for a resource scope
|
| GetRoleManagementPolicyAssignment(ArmResource, String, CancellationToken) |
Get the specified role management policy assignment for a resource scope
|
| GetRoleManagementPolicyAssignmentAsync(ArmResource, String, CancellationToken) |
Get the specified role management policy assignment for a resource scope
|
| GetRoleManagementPolicyAssignments(ArmResource) |
Gets a collection of RoleManagementPolicyAssignmentResources in the ArmResource. MockingTo mock this method, please mock GetRoleManagementPolicyAssignments() instead. |
| GetRoleManagementPolicyAsync(ArmResource, String, CancellationToken) |
Get the specified role management policy for a resource scope
|
| GetSystemAssignedIdentity(ArmResource) |
Gets an object representing a SystemAssignedIdentityResource along with the instance operations that can be performed on it in the ArmResource. MockingTo mock this method, please mock GetSystemAssignedIdentity() instead. |
| GetLinkerResource(ArmResource, String, CancellationToken) |
Returns Linker resource for a given name.
|
| GetLinkerResourceAsync(ArmResource, String, CancellationToken) |
Returns Linker resource for a given name.
|
| GetLinkerResources(ArmResource) |
Gets a collection of LinkerResources in the ArmResource. MockingTo mock this method, please mock GetLinkerResources() instead. |
