Share via


SqlServer Class

Definition

SqlServer.

public class SqlServer : Azure.Provisioning.Primitives.Resource
type SqlServer = class
    inherit Resource
Public Class SqlServer
Inherits Resource
Inheritance

Constructors

SqlServer(String, String)

Creates a new SqlServer.

Properties

AdministratorLogin

Administrator username for the server. Once created it cannot be changed.

AdministratorLoginPassword

The administrator login password (required for server creation).

Administrators

The Azure Active Directory administrator of the server. This can only be used at server create time. If used for server update, it will be ignored or it will result in an error. For updates individual APIs will need to be used.

DependsOn

Declares explicit dependencies on other resources.

(Inherited from Resource)
ExternalGovernanceStatus

Status of external governance.

FederatedClientId

The Client id used for cross tenant CMK scenario.

FullyQualifiedDomainName

The fully qualified domain name of the server.

Id

Gets the Id.

IdentifierName

Gets or sets the the Bicep identifier name of the resource. This can be used to refer to the resource in expressions, but is not the Azure name of the resource. This value can contain letters, numbers, and underscores.

(Inherited from NamedProvisioningConstruct)
Identity

The Azure Active Directory identity of the server.

IsExistingResource

Gets whether this is referencing an existing resource or we're defining a new resource.

(Inherited from Resource)
IsIPv6Enabled

Whether or not to enable IPv6 support for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled'.

KeyId

A CMK URI of the key to use for encryption.

Kind

Kind of sql server. This is metadata used for the Azure portal experience.

Location

Gets or sets the Location.

MinTlsVersion

Minimal TLS version. Allowed values: 'None', 1.0', '1.1', '1.2', '1.3'.

Name

The name of the server.

PrimaryUserAssignedIdentityId

The resource id of a user assigned identity to be used by default.

PrivateEndpointConnections

List of private endpoint connections on a server.

PublicNetworkAccess

Whether or not public endpoint access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' or 'SecuredByPerimeter'.

ResourceType

Gets the type of the resource.

(Inherited from Resource)
ResourceVersion

Gets or sets the version of the resource.

(Inherited from Resource)
RestrictOutboundNetworkAccess

Whether or not to restrict outbound network access for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled'.

State

The state of the server.

SystemData

Gets the SystemData.

Tags

Gets or sets the Tags.

Version

The version of the server.

WorkspaceFeature

Whether or not existing server has a workspace created and if it allows connection from workspace.

Methods

Build(ProvisioningContext)

Compose the resource into a provisioning plan that can be saved as Bicep or deployed directly.

(Inherited from Resource)
Compile()

Compile the resource into a set of Bicep statements.

(Inherited from Resource)
CreateRoleAssignment(SqlBuiltInRole, BicepValue<RoleManagementPrincipalType>, BicepValue<Guid>, String)

Creates a role assignment for a principal that grants access to this SqlServer.

CreateRoleAssignment(SqlBuiltInRole, UserAssignedIdentity)

Creates a role assignment for a user-assigned identity that grants access to this SqlServer.

FromExisting(String, String)

Creates a reference to an existing SqlServer.

GetResources()

Get any resources represented by this object. This will typically only be the object itself for everything but Infrastructure.

(Inherited from Provisionable)
OverrideWithExpression(Expression)

Set this construct to represent the result of an expression. This is primarily meant to be called via FromExpression static methods on specific resources or constructs.

(Inherited from ProvisioningConstruct)
Resolve(ProvisioningContext)

Resolve any resources or properties that were not explicitly specified.

(Inherited from ProvisioningConstruct)
Validate(ProvisioningContext)

Validate the presence of any required members.

(Inherited from Resource)

Applies to