Server

Manages a Microsoft SQL Azure Database Server.

Note: All arguments including the administrator login and password will be stored in the raw state as plain-text. Read more about sensitive data in state.

Create a Server Resource

new Server(name: string, args: ServerArgs, opts?: CustomResourceOptions);

def Server(resource_name, opts=None, administrator_login=None, administrator_login_password=None, azuread_administrator=None, connection_policy=None, extended_auditing_policy=None, identity=None, location=None, name=None, public_network_access_enabled=None, resource_group_name=None, tags=None, version=None, __props__=None);

func NewServer(ctx *Context, name string, args ServerArgs, opts ...ResourceOption) (*Server, error)

public Server(string name, ServerArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args ServerArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args ServerArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ServerArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

Server Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The Server resource accepts the following input properties:

AdministratorLogin string: The administrator login name for the new server. Changing this forces a new resource to be created.
AdministratorLoginPassword string: The password associated with the administrator_login user. Needs to comply with Azure’s Password Policy
ResourceGroupName string: The name of the resource group in which to create the Microsoft SQL Server.
Version string: The version for the new server. Valid values are: 2.0 (for v11 server) and 12.0 (for v12 server).
AzureadAdministrator ServerAzureadAdministratorArgs: An azuread_administrator block as defined below.
ConnectionPolicy string: The connection policy the server will use. Possible values are Default, Proxy, and Redirect. Defaults to Default.
ExtendedAuditingPolicy ServerExtendedAuditingPolicyArgs: A extended_auditing_policy block as defined below.
Identity ServerIdentityArgs: An identity block as defined below.
Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name string: The name of the Microsoft SQL Server. This needs to be globally unique within Azure.
PublicNetworkAccessEnabled bool: Whether or not public network access is allowed for this server. Defaults to true.
Tags Dictionary<string, string>: A mapping of tags to assign to the resource.

AdministratorLogin string: The administrator login name for the new server. Changing this forces a new resource to be created.
AdministratorLoginPassword string: The password associated with the administrator_login user. Needs to comply with Azure’s Password Policy
ResourceGroupName string: The name of the resource group in which to create the Microsoft SQL Server.
Version string: The version for the new server. Valid values are: 2.0 (for v11 server) and 12.0 (for v12 server).
AzureadAdministrator ServerAzureadAdministrator: An azuread_administrator block as defined below.
ConnectionPolicy string: The connection policy the server will use. Possible values are Default, Proxy, and Redirect. Defaults to Default.
ExtendedAuditingPolicy ServerExtendedAuditingPolicy: A extended_auditing_policy block as defined below.
Identity ServerIdentity: An identity block as defined below.
Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name string: The name of the Microsoft SQL Server. This needs to be globally unique within Azure.
PublicNetworkAccessEnabled bool: Whether or not public network access is allowed for this server. Defaults to true.
Tags map[string]string: A mapping of tags to assign to the resource.

administratorLogin string: The administrator login name for the new server. Changing this forces a new resource to be created.
administratorLoginPassword string: The password associated with the administrator_login user. Needs to comply with Azure’s Password Policy
resourceGroupName string: The name of the resource group in which to create the Microsoft SQL Server.
version string: The version for the new server. Valid values are: 2.0 (for v11 server) and 12.0 (for v12 server).
azureadAdministrator ServerAzureadAdministrator: An azuread_administrator block as defined below.
connectionPolicy string: The connection policy the server will use. Possible values are Default, Proxy, and Redirect. Defaults to Default.
extendedAuditingPolicy ServerExtendedAuditingPolicy: A extended_auditing_policy block as defined below.
identity ServerIdentity: An identity block as defined below.
location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name string: The name of the Microsoft SQL Server. This needs to be globally unique within Azure.
publicNetworkAccessEnabled boolean: Whether or not public network access is allowed for this server. Defaults to true.
tags {[key: string]: string}: A mapping of tags to assign to the resource.

administrator_login str: The administrator login name for the new server. Changing this forces a new resource to be created.
administrator_login_password str: The password associated with the administrator_login user. Needs to comply with Azure’s Password Policy
resource_group_name str: The name of the resource group in which to create the Microsoft SQL Server.
version str: The version for the new server. Valid values are: 2.0 (for v11 server) and 12.0 (for v12 server).
azuread_administrator Dict[ServerAzureadAdministrator]: An azuread_administrator block as defined below.
connection_policy str: The connection policy the server will use. Possible values are Default, Proxy, and Redirect. Defaults to Default.
extended_auditing_policy Dict[ServerExtendedAuditingPolicy]: A extended_auditing_policy block as defined below.
identity Dict[ServerIdentity]: An identity block as defined below.
location str: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name str: The name of the Microsoft SQL Server. This needs to be globally unique within Azure.
public_network_access_enabled bool: Whether or not public network access is allowed for this server. Defaults to true.
tags Dict[str, str]: A mapping of tags to assign to the resource.

Outputs

All input properties are implicitly available as output properties. Additionally, the Server resource produces the following output properties:

FullyQualifiedDomainName string: The fully qualified domain name of the Azure SQL Server (e.g. myServerName.database.windows.net)
Id string: The provider-assigned unique ID for this managed resource.

FullyQualifiedDomainName string: The fully qualified domain name of the Azure SQL Server (e.g. myServerName.database.windows.net)
Id string: The provider-assigned unique ID for this managed resource.

fullyQualifiedDomainName string: The fully qualified domain name of the Azure SQL Server (e.g. myServerName.database.windows.net)
id string: The provider-assigned unique ID for this managed resource.

fully_qualified_domain_name str: The fully qualified domain name of the Azure SQL Server (e.g. myServerName.database.windows.net)
id str: The provider-assigned unique ID for this managed resource.

Look up an Existing Server Resource

Get an existing Server resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ServerState, opts?: CustomResourceOptions): Server

static get(resource_name, id, opts=None, administrator_login=None, administrator_login_password=None, azuread_administrator=None, connection_policy=None, extended_auditing_policy=None, fully_qualified_domain_name=None, identity=None, location=None, name=None, public_network_access_enabled=None, resource_group_name=None, tags=None, version=None, __props__=None);

func GetServer(ctx *Context, name string, id IDInput, state *ServerState, opts ...ResourceOption) (*Server, error)

public static Server Get(string name, Input<string> id, ServerState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

AdministratorLogin string: The administrator login name for the new server. Changing this forces a new resource to be created.
AdministratorLoginPassword string: The password associated with the administrator_login user. Needs to comply with Azure’s Password Policy
AzureadAdministrator ServerAzureadAdministratorArgs: An azuread_administrator block as defined below.
ConnectionPolicy string: The connection policy the server will use. Possible values are Default, Proxy, and Redirect. Defaults to Default.
ExtendedAuditingPolicy ServerExtendedAuditingPolicyArgs: A extended_auditing_policy block as defined below.
FullyQualifiedDomainName string: The fully qualified domain name of the Azure SQL Server (e.g. myServerName.database.windows.net)
Identity ServerIdentityArgs: An identity block as defined below.
Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name string: The name of the Microsoft SQL Server. This needs to be globally unique within Azure.
PublicNetworkAccessEnabled bool: Whether or not public network access is allowed for this server. Defaults to true.
ResourceGroupName string: The name of the resource group in which to create the Microsoft SQL Server.
Tags Dictionary<string, string>: A mapping of tags to assign to the resource.
Version string: The version for the new server. Valid values are: 2.0 (for v11 server) and 12.0 (for v12 server).

AdministratorLogin string: The administrator login name for the new server. Changing this forces a new resource to be created.
AdministratorLoginPassword string: The password associated with the administrator_login user. Needs to comply with Azure’s Password Policy
AzureadAdministrator ServerAzureadAdministrator: An azuread_administrator block as defined below.
ConnectionPolicy string: The connection policy the server will use. Possible values are Default, Proxy, and Redirect. Defaults to Default.
ExtendedAuditingPolicy ServerExtendedAuditingPolicy: A extended_auditing_policy block as defined below.
FullyQualifiedDomainName string: The fully qualified domain name of the Azure SQL Server (e.g. myServerName.database.windows.net)
Identity ServerIdentity: An identity block as defined below.
Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name string: The name of the Microsoft SQL Server. This needs to be globally unique within Azure.
PublicNetworkAccessEnabled bool: Whether or not public network access is allowed for this server. Defaults to true.
ResourceGroupName string: The name of the resource group in which to create the Microsoft SQL Server.
Tags map[string]string: A mapping of tags to assign to the resource.
Version string: The version for the new server. Valid values are: 2.0 (for v11 server) and 12.0 (for v12 server).

administratorLogin string: The administrator login name for the new server. Changing this forces a new resource to be created.
administratorLoginPassword string: The password associated with the administrator_login user. Needs to comply with Azure’s Password Policy
azureadAdministrator ServerAzureadAdministrator: An azuread_administrator block as defined below.
connectionPolicy string: The connection policy the server will use. Possible values are Default, Proxy, and Redirect. Defaults to Default.
extendedAuditingPolicy ServerExtendedAuditingPolicy: A extended_auditing_policy block as defined below.
fullyQualifiedDomainName string: The fully qualified domain name of the Azure SQL Server (e.g. myServerName.database.windows.net)
identity ServerIdentity: An identity block as defined below.
location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name string: The name of the Microsoft SQL Server. This needs to be globally unique within Azure.
publicNetworkAccessEnabled boolean: Whether or not public network access is allowed for this server. Defaults to true.
resourceGroupName string: The name of the resource group in which to create the Microsoft SQL Server.
tags {[key: string]: string}: A mapping of tags to assign to the resource.
version string: The version for the new server. Valid values are: 2.0 (for v11 server) and 12.0 (for v12 server).

administrator_login str: The administrator login name for the new server. Changing this forces a new resource to be created.
administrator_login_password str: The password associated with the administrator_login user. Needs to comply with Azure’s Password Policy
azuread_administrator Dict[ServerAzureadAdministrator]: An azuread_administrator block as defined below.
connection_policy str: The connection policy the server will use. Possible values are Default, Proxy, and Redirect. Defaults to Default.
extended_auditing_policy Dict[ServerExtendedAuditingPolicy]: A extended_auditing_policy block as defined below.
fully_qualified_domain_name str: The fully qualified domain name of the Azure SQL Server (e.g. myServerName.database.windows.net)
identity Dict[ServerIdentity]: An identity block as defined below.
location str: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name str: The name of the Microsoft SQL Server. This needs to be globally unique within Azure.
public_network_access_enabled bool: Whether or not public network access is allowed for this server. Defaults to true.
resource_group_name str: The name of the resource group in which to create the Microsoft SQL Server.
tags Dict[str, str]: A mapping of tags to assign to the resource.
version str: The version for the new server. Valid values are: 2.0 (for v11 server) and 12.0 (for v12 server).

Supporting Types

ServerAzureadAdministrator

See the input and output API doc for this type.

LoginUsername string: (Required) The login username of the Azure AD Administrator of this SQL Server.
ObjectId string: (Required) The object id of the Azure AD Administrator of this SQL Server.
TenantId string: (Optional) The tenant id of the Azure AD Administrator of this SQL Server.

LoginUsername string: (Required) The login username of the Azure AD Administrator of this SQL Server.
ObjectId string: (Required) The object id of the Azure AD Administrator of this SQL Server.
TenantId string: (Optional) The tenant id of the Azure AD Administrator of this SQL Server.

loginUsername string: (Required) The login username of the Azure AD Administrator of this SQL Server.
objectId string: (Required) The object id of the Azure AD Administrator of this SQL Server.
tenantId string: (Optional) The tenant id of the Azure AD Administrator of this SQL Server.

loginUsername str: (Required) The login username of the Azure AD Administrator of this SQL Server.
object_id str: (Required) The object id of the Azure AD Administrator of this SQL Server.
tenant_id str: (Optional) The tenant id of the Azure AD Administrator of this SQL Server.

ServerExtendedAuditingPolicy

See the input and output API doc for this type.

StorageAccountAccessKey string: (Required) Specifies the access key to use for the auditing storage account.
StorageEndpoint string: (Required) Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net).
RetentionInDays int: (Optional) Specifies the number of days to retain logs for in the storage account.
StorageAccountAccessKeyIsSecondary bool: (Optional) Specifies whether storage_account_access_key value is the storage’s secondary key.

StorageAccountAccessKey string: (Required) Specifies the access key to use for the auditing storage account.
StorageEndpoint string: (Required) Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net).
RetentionInDays int: (Optional) Specifies the number of days to retain logs for in the storage account.
StorageAccountAccessKeyIsSecondary bool: (Optional) Specifies whether storage_account_access_key value is the storage’s secondary key.

storageAccountAccessKey string: (Required) Specifies the access key to use for the auditing storage account.
storageEndpoint string: (Required) Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net).
retentionInDays number: (Optional) Specifies the number of days to retain logs for in the storage account.
storageAccountAccessKeyIsSecondary boolean: (Optional) Specifies whether storage_account_access_key value is the storage’s secondary key.

storage_account_access_key str: (Required) Specifies the access key to use for the auditing storage account.
storage_endpoint str: (Required) Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net).
retention_in_days float: (Optional) Specifies the number of days to retain logs for in the storage account.
storageAccountAccessKeyIsSecondary bool: (Optional) Specifies whether storage_account_access_key value is the storage’s secondary key.

ServerIdentity

See the input and output API doc for this type.

Type string: Specifies the identity type of the Microsoft SQL Server. At this time the only allowed value is SystemAssigned.
PrincipalId string: The Principal ID for the Service Principal associated with the Identity of this SQL Server.
TenantId string: (Optional) The tenant id of the Azure AD Administrator of this SQL Server.

Type string: Specifies the identity type of the Microsoft SQL Server. At this time the only allowed value is SystemAssigned.
PrincipalId string: The Principal ID for the Service Principal associated with the Identity of this SQL Server.
TenantId string: (Optional) The tenant id of the Azure AD Administrator of this SQL Server.

type string: Specifies the identity type of the Microsoft SQL Server. At this time the only allowed value is SystemAssigned.
principalId string: The Principal ID for the Service Principal associated with the Identity of this SQL Server.
tenantId string: (Optional) The tenant id of the Azure AD Administrator of this SQL Server.

type str: Specifies the identity type of the Microsoft SQL Server. At this time the only allowed value is SystemAssigned.
principal_id str: The Principal ID for the Service Principal associated with the Identity of this SQL Server.
tenant_id str: (Optional) The tenant id of the Azure AD Administrator of this SQL Server.

Package Details

Repository: https://github.com/pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

Server

Create a Server Resource

Server Resource Properties

Inputs

Outputs

Look up an Existing Server Resource

Supporting Types

ServerAzureadAdministrator

ServerExtendedAuditingPolicy

ServerIdentity

Package Details

On This Page