Module sql

This page documents the language specification for the azure package. If you're looking for help working with the inputs, outputs, or functions of azure resources in a Pulumi program, please see the resource documentation for examples and API reference.

Resources

Resource ActiveDirectoryAdministrator

class ActiveDirectoryAdministrator extends CustomResource

Allows you to set a user or group as the AD administrator for an Azure SQL server

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const current = azure.core.getClientConfig({});
const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West US"});
const exampleSqlServer = new azure.sql.SqlServer("exampleSqlServer", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    version: "12.0",
    administratorLogin: "4dm1n157r470r",
    administratorLoginPassword: "4-v3ry-53cr37-p455w0rd",
});
const exampleActiveDirectoryAdministrator = new azure.sql.ActiveDirectoryAdministrator("exampleActiveDirectoryAdministrator", {
    serverName: exampleSqlServer.name,
    resourceGroupName: exampleResourceGroup.name,
    login: "sqladmin",
    tenantId: current.then(current => current.tenantId),
    objectId: current.then(current => current.objectId),
});

constructor

new ActiveDirectoryAdministrator(name: string, args: ActiveDirectoryAdministratorArgs, opts?: pulumi.CustomResourceOptions)

Create a ActiveDirectoryAdministrator resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ActiveDirectoryAdministratorState, opts?: pulumi.CustomResourceOptions): ActiveDirectoryAdministrator

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ActiveDirectoryAdministrator

Returns true if the given object is an instance of ActiveDirectoryAdministrator. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

public login: pulumi.Output<string>;

The login name of the principal to set as the server administrator

property objectId

public objectId: pulumi.Output<string>;

The ID of the principal to set as the server administrator

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

The name of the resource group for the SQL server. Changing this forces a new resource to be created.

property serverName

public serverName: pulumi.Output<string>;

The name of the SQL Server on which to set the administrator. Changing this forces a new resource to be created.

property tenantId

public tenantId: pulumi.Output<string>;

The Azure Tenant ID

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Database

class Database extends CustomResource

Allows you to manage an Azure SQL Database

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West US"});
const exampleSqlServer = new azure.sql.SqlServer("exampleSqlServer", {
    resourceGroupName: exampleResourceGroup.name,
    location: "West US",
    version: "12.0",
    administratorLogin: "4dm1n157r470r",
    administratorLoginPassword: "4-v3ry-53cr37-p455w0rd",
    tags: {
        environment: "production",
    },
});
const exampleAccount = new azure.storage.Account("exampleAccount", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    accountTier: "Standard",
    accountReplicationType: "LRS",
});
const exampleDatabase = new azure.sql.Database("exampleDatabase", {
    resourceGroupName: exampleResourceGroup.name,
    location: "West US",
    serverName: exampleSqlServer.name,
    extended_auditing_policy: {
        storageEndpoint: exampleAccount.primaryBlobEndpoint,
        storageAccountAccessKey: exampleAccount.primaryAccessKey,
        storageAccountAccessKeyIsSecondary: true,
        retentionInDays: 6,
    },
    tags: {
        environment: "production",
    },
});

constructor

new Database(name: string, args: DatabaseArgs, opts?: pulumi.CustomResourceOptions)

Create a Database resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: DatabaseState, opts?: pulumi.CustomResourceOptions): Database

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Database

Returns true if the given object is an instance of Database. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property collation

public collation: pulumi.Output<string>;

The name of the collation. Applies only if createMode is Default. Azure default is SQL_LATIN1_GENERAL_CP1_CI_AS. Changing this forces a new resource to be created.

property createMode

public createMode: pulumi.Output<string | undefined>;

Specifies how to create the database. Valid values are: Default, Copy, OnlineSecondary, NonReadableSecondary, PointInTimeRestore, Recovery, Restore or RestoreLongTermRetentionBackup. Must be Default to create a new database. Defaults to Default. Please see Azure SQL Database REST API

property creationDate

public creationDate: pulumi.Output<string>;

The creation date of the SQL Database.

property defaultSecondaryLocation

public defaultSecondaryLocation: pulumi.Output<string>;

The default secondary location of the SQL Database.

property edition

public edition: pulumi.Output<string>;

The edition of the database to be created. Applies only if createMode is Default. Valid values are: Basic, Standard, Premium, DataWarehouse, Business, BusinessCritical, Free, GeneralPurpose, Hyperscale, Premium, PremiumRS, Standard, Stretch, System, System2, or Web. Please see Azure SQL Database Service Tiers.

property elasticPoolName

public elasticPoolName: pulumi.Output<string>;

The name of the elastic database pool.

property encryption

public encryption: pulumi.Output<string>;

property extendedAuditingPolicy

public extendedAuditingPolicy: pulumi.Output<DatabaseExtendedAuditingPolicy | undefined>;

A extendedAuditingPolicy block as defined below.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property import

public import: pulumi.Output<DatabaseImport | undefined>;

A Database Import block as documented below. createMode must be set to Default.

property location

public location: pulumi.Output<string>;

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

property maxSizeBytes

public maxSizeBytes: pulumi.Output<string>;

The maximum size that the database can grow to. Applies only if createMode is Default. Please see Azure SQL Database Service Tiers.

property maxSizeGb

public maxSizeGb: pulumi.Output<string>;

property name

public name: pulumi.Output<string>;

The name of the database.

property readScale

public readScale: pulumi.Output<boolean | undefined>;

Read-only connections will be redirected to a high-available replica. Please see Use read-only replicas to load-balance read-only query workloads.

property requestedServiceObjectiveId

public requestedServiceObjectiveId: pulumi.Output<string>;

A GUID/UUID corresponding to a configured Service Level Objective for the Azure SQL database which can be used to configure a performance level. .

property requestedServiceObjectiveName

public requestedServiceObjectiveName: pulumi.Output<string>;

The service objective name for the database. Valid values depend on edition and location and may include S0, S1, S2, S3, P1, P2, P4, P6, P11 and ElasticPool. You can list the available names with the cli: shell az sql db list-editions -l westus --edition Standard -o table. For further information please see Azure CLI - az sql db.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

The name of the resource group in which to create the database. This must be the same as Database Server resource group currently.

property restorePointInTime

public restorePointInTime: pulumi.Output<string>;

The point in time for the restore. Only applies if createMode is PointInTimeRestore e.g. 2013-11-08T22:00:40Z

property serverName

public serverName: pulumi.Output<string>;

The name of the SQL Server on which to create the database.

property sourceDatabaseDeletionDate

public sourceDatabaseDeletionDate: pulumi.Output<string>;

The deletion date time of the source database. Only applies to deleted databases where createMode is PointInTimeRestore.

property sourceDatabaseId

public sourceDatabaseId: pulumi.Output<string>;

The URI of the source database if createMode value is not Default.

property tags

public tags: pulumi.Output<{[key: string]: string} | undefined>;

A mapping of tags to assign to the resource.

property threatDetectionPolicy

public threatDetectionPolicy: pulumi.Output<DatabaseThreatDetectionPolicy>;

Threat detection policy configuration. The threatDetectionPolicy block supports fields documented below.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property zoneRedundant

public zoneRedundant: pulumi.Output<boolean | undefined>;

Whether or not this database is zone redundant, which means the replicas of this database will be spread across multiple availability zones.

Resource ElasticPool

class ElasticPool extends CustomResource

Allows you to manage an Azure SQL Elastic Pool.

NOTE: - This version of the Elasticpool resource is being deprecated and should no longer be used. Please use the azure.mssql.ElasticPool version instead.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West US"});
const exampleSqlServer = new azure.sql.SqlServer("exampleSqlServer", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    version: "12.0",
    administratorLogin: "4dm1n157r470r",
    administratorLoginPassword: "4-v3ry-53cr37-p455w0rd",
});
const exampleElasticPool = new azure.sql.ElasticPool("exampleElasticPool", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    serverName: exampleSqlServer.name,
    edition: "Basic",
    dtu: 50,
    dbDtuMin: 0,
    dbDtuMax: 5,
    poolSize: 5000,
});

constructor

new ElasticPool(name: string, args: ElasticPoolArgs, opts?: pulumi.CustomResourceOptions)

Create a ElasticPool resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ElasticPoolState, opts?: pulumi.CustomResourceOptions): ElasticPool

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ElasticPool

Returns true if the given object is an instance of ElasticPool. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property creationDate

public creationDate: pulumi.Output<string>;

The creation date of the SQL Elastic Pool.

property dbDtuMax

public dbDtuMax: pulumi.Output<number>;

The maximum DTU which will be guaranteed to all databases in the elastic pool to be created.

property dbDtuMin

public dbDtuMin: pulumi.Output<number>;

The minimum DTU which will be guaranteed to all databases in the elastic pool to be created.

property dtu

public dtu: pulumi.Output<number>;

The total shared DTU for the elastic pool. Valid values depend on the edition which has been defined. Refer to Azure SQL Database Service Tiers for valid combinations.

property edition

public edition: pulumi.Output<string>;

The edition of the elastic pool to be created. Valid values are Basic, Standard, and Premium. Refer to Azure SQL Database Service Tiers for details. Changing this forces a new resource to be created.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property location

public location: pulumi.Output<string>;

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

property name

public name: pulumi.Output<string>;

The name of the elastic pool. This needs to be globally unique. Changing this forces a new resource to be created.

property poolSize

public poolSize: pulumi.Output<number>;

The maximum size in MB that all databases in the elastic pool can grow to. The maximum size must be consistent with combination of edition and dtu and the limits documented in Azure SQL Database Service Tiers. If not defined when creating an elastic pool, the value is set to the size implied by edition and dtu.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

The name of the resource group in which to create the elastic pool. This must be the same as the resource group of the underlying SQL server.

property serverName

public serverName: pulumi.Output<string>;

The name of the SQL Server on which to create the elastic pool. Changing this forces a new resource to be created.

property tags

public tags: pulumi.Output<{[key: string]: string} | undefined>;

A mapping of tags to assign to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource FailoverGroup

class FailoverGroup extends CustomResource

Create a failover group of databases on a collection of Azure SQL servers.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "uksouth"});
const primary = new azure.sql.SqlServer("primary", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    version: "12.0",
    administratorLogin: "sqladmin",
    administratorLoginPassword: `pa$$w0rd`,
});
const secondary = new azure.sql.SqlServer("secondary", {
    resourceGroupName: exampleResourceGroup.name,
    location: "northeurope",
    version: "12.0",
    administratorLogin: "sqladmin",
    administratorLoginPassword: `pa$$w0rd`,
});
const db1 = new azure.sql.Database("db1", {
    resourceGroupName: primary.resourceGroupName,
    location: primary.location,
    serverName: primary.name,
});
const exampleFailoverGroup = new azure.sql.FailoverGroup("exampleFailoverGroup", {
    resourceGroupName: primary.resourceGroupName,
    serverName: primary.name,
    databases: [db1.id],
    partner_servers: [{
        id: secondary.id,
    }],
    read_write_endpoint_failover_policy: {
        mode: "Automatic",
        graceMinutes: 60,
    },
});

constructor

new FailoverGroup(name: string, args: FailoverGroupArgs, opts?: pulumi.CustomResourceOptions)

Create a FailoverGroup resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: FailoverGroupState, opts?: pulumi.CustomResourceOptions): FailoverGroup

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is FailoverGroup

Returns true if the given object is an instance of FailoverGroup. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property databases

public databases: pulumi.Output<string[] | undefined>;

A list of database ids to add to the failover group

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property location

public location: pulumi.Output<string>;

the location of the failover group.

property name

public name: pulumi.Output<string>;

The name of the failover group. Changing this forces a new resource to be created.

property partnerServers

public partnerServers: pulumi.Output<FailoverGroupPartnerServer[]>;

A list of secondary servers as documented below

property readWriteEndpointFailoverPolicy

public readWriteEndpointFailoverPolicy: pulumi.Output<FailoverGroupReadWriteEndpointFailoverPolicy>;

A read/write policy as documented below

property readonlyEndpointFailoverPolicy

public readonlyEndpointFailoverPolicy: pulumi.Output<FailoverGroupReadonlyEndpointFailoverPolicy>;

a read-only policy as documented below

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

The name of the resource group containing the SQL server

property role

public role: pulumi.Output<string>;

local replication role of the failover group instance.

property serverName

public serverName: pulumi.Output<string>;

The name of the primary SQL server. Changing this forces a new resource to be created.

property tags

public tags: pulumi.Output<{[key: string]: string} | undefined>;

A mapping of tags to assign to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource FirewallRule

class FirewallRule extends CustomResource

Allows you to manage an Azure SQL Firewall Rule

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West US"});
const exampleSqlServer = new azure.sql.SqlServer("exampleSqlServer", {
    resourceGroupName: exampleResourceGroup.name,
    location: "West US",
    version: "12.0",
    administratorLogin: "4dm1n157r470r",
    administratorLoginPassword: "4-v3ry-53cr37-p455w0rd",
});
const exampleFirewallRule = new azure.sql.FirewallRule("exampleFirewallRule", {
    resourceGroupName: exampleResourceGroup.name,
    serverName: exampleSqlServer.name,
    startIpAddress: "10.0.17.62",
    endIpAddress: "10.0.17.62",
});

constructor

new FirewallRule(name: string, args: FirewallRuleArgs, opts?: pulumi.CustomResourceOptions)

Create a FirewallRule resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: FirewallRuleState, opts?: pulumi.CustomResourceOptions): FirewallRule

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is FirewallRule

Returns true if the given object is an instance of FirewallRule. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property endIpAddress

public endIpAddress: pulumi.Output<string>;

The ending IP address to allow through the firewall for this rule.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name of the firewall rule.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

The name of the resource group in which to create the sql server.

property serverName

public serverName: pulumi.Output<string>;

The name of the SQL Server on which to create the Firewall Rule.

property startIpAddress

public startIpAddress: pulumi.Output<string>;

The starting IP address to allow through the firewall for this rule.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource SqlServer

class SqlServer extends CustomResource

Manages a Microsoft SQL Azure Database Server.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West US"});
const exampleAccount = new azure.storage.Account("exampleAccount", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    accountTier: "Standard",
    accountReplicationType: "LRS",
});
const exampleSqlServer = new azure.sql.SqlServer("exampleSqlServer", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    version: "12.0",
    administratorLogin: "mradministrator",
    administratorLoginPassword: "thisIsDog11",
    extended_auditing_policy: {
        storageEndpoint: exampleAccount.primaryBlobEndpoint,
        storageAccountAccessKey: exampleAccount.primaryAccessKey,
        storageAccountAccessKeyIsSecondary: true,
        retentionInDays: 6,
    },
    tags: {
        environment: "production",
    },
});

constructor

new SqlServer(name: string, args: SqlServerArgs, opts?: pulumi.CustomResourceOptions)

Create a SqlServer resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: SqlServerState, opts?: pulumi.CustomResourceOptions): SqlServer

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is SqlServer

Returns true if the given object is an instance of SqlServer. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property administratorLogin

public administratorLogin: pulumi.Output<string>;

The administrator login name for the new server. Changing this forces a new resource to be created.

property administratorLoginPassword

public administratorLoginPassword: pulumi.Output<string>;

The password associated with the administratorLogin user. Needs to comply with Azure’s Password Policy

property connectionPolicy

public connectionPolicy: pulumi.Output<string | undefined>;

The connection policy the server will use. Possible values are Default, Proxy, and Redirect. Defaults to Default.

property extendedAuditingPolicy

public extendedAuditingPolicy: pulumi.Output<SqlServerExtendedAuditingPolicy | undefined>;

A extendedAuditingPolicy block as defined below.

property fullyQualifiedDomainName

public fullyQualifiedDomainName: pulumi.Output<string>;

The fully qualified domain name of the Azure SQL Server (e.g. myServerName.database.windows.net)

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property identity

public identity: pulumi.Output<SqlServerIdentity | undefined>;

An identity block as defined below.

property location

public location: pulumi.Output<string>;

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

property name

public name: pulumi.Output<string>;

The name of the Microsoft SQL Server. This needs to be globally unique within Azure.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

The name of the resource group in which to create the Microsoft SQL Server.

property tags

public tags: pulumi.Output<{[key: string]: string} | undefined>;

A mapping of tags to assign to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property version

public version: pulumi.Output<string>;

The version for the new server. Valid values are: 2.0 (for v11 server) and 12.0 (for v12 server).

Resource VirtualNetworkRule

class VirtualNetworkRule extends CustomResource

Allows you to add, update, or remove an Azure SQL server to a subnet of a virtual network.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = new azure.core.ResourceGroup("example", {location: "West US"});
const vnet = new azure.network.VirtualNetwork("vnet", {
    addressSpaces: ["10.7.29.0/29"],
    location: example.location,
    resourceGroupName: example.name,
});
const subnet = new azure.network.Subnet("subnet", {
    resourceGroupName: example.name,
    virtualNetworkName: vnet.name,
    addressPrefix: "10.7.29.0/29",
    serviceEndpoints: ["Microsoft.Sql"],
});
const sqlserver = new azure.sql.SqlServer("sqlserver", {
    resourceGroupName: example.name,
    location: example.location,
    version: "12.0",
    administratorLogin: "4dm1n157r470r",
    administratorLoginPassword: "4-v3ry-53cr37-p455w0rd",
});
const sqlvnetrule = new azure.sql.VirtualNetworkRule("sqlvnetrule", {
    resourceGroupName: example.name,
    serverName: sqlserver.name,
    subnetId: subnet.id,
});

constructor

new VirtualNetworkRule(name: string, args: VirtualNetworkRuleArgs, opts?: pulumi.CustomResourceOptions)

Create a VirtualNetworkRule resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: VirtualNetworkRuleState, opts?: pulumi.CustomResourceOptions): VirtualNetworkRule

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is VirtualNetworkRule

Returns true if the given object is an instance of VirtualNetworkRule. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property ignoreMissingVnetServiceEndpoint

public ignoreMissingVnetServiceEndpoint: pulumi.Output<boolean | undefined>;

Create the virtual network rule before the subnet has the virtual network service endpoint enabled. The default value is false.

property name

public name: pulumi.Output<string>;

The name of the SQL virtual network rule. Changing this forces a new resource to be created. Cannot be empty and must only contain alphanumeric characters and hyphens. Cannot start with a number, and cannot start or end with a hyphen.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

The name of the resource group where the SQL server resides. Changing this forces a new resource to be created.

property serverName

public serverName: pulumi.Output<string>;

The name of the SQL Server to which this SQL virtual network rule will be applied to. Changing this forces a new resource to be created.

property subnetId

public subnetId: pulumi.Output<string>;

The ID of the subnet that the SQL server will be connected to.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Functions

Function getDatabase

getDatabase(args: GetDatabaseArgs, opts?: pulumi.InvokeOptions): Promise<GetDatabaseResult>

Use this data source to access information about an existing SQL Azure Database.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = azure.sql.getDatabase({
    name: "example_db",
    serverName: "example_db_server",
    resourceGroupName: "example-resources",
});
export const sqlDatabaseId = example.then(example => example.id);

Function getServer

getServer(args: GetServerArgs, opts?: pulumi.InvokeOptions): Promise<GetServerResult>

Use this data source to access information about an existing SQL Azure Database Server.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = azure.sql.getServer({
    name: "examplesqlservername",
    resourceGroupName: "example-resources",
});
export const sqlServerId = example.then(example => example.id);

Others

interface ActiveDirectoryAdministratorArgs

interface ActiveDirectoryAdministratorArgs

The set of arguments for constructing a ActiveDirectoryAdministrator resource.

login: pulumi.Input<string>;

The login name of the principal to set as the server administrator

property objectId

objectId: pulumi.Input<string>;

The ID of the principal to set as the server administrator

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

The name of the resource group for the SQL server. Changing this forces a new resource to be created.

property serverName

serverName: pulumi.Input<string>;

The name of the SQL Server on which to set the administrator. Changing this forces a new resource to be created.

property tenantId

tenantId: pulumi.Input<string>;

The Azure Tenant ID

interface ActiveDirectoryAdministratorState

interface ActiveDirectoryAdministratorState

Input properties used for looking up and filtering ActiveDirectoryAdministrator resources.

login?: pulumi.Input<string>;

The login name of the principal to set as the server administrator

property objectId

objectId?: pulumi.Input<string>;

The ID of the principal to set as the server administrator

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

The name of the resource group for the SQL server. Changing this forces a new resource to be created.

property serverName

serverName?: pulumi.Input<string>;

The name of the SQL Server on which to set the administrator. Changing this forces a new resource to be created.

property tenantId

tenantId?: pulumi.Input<string>;

The Azure Tenant ID

interface DatabaseArgs

interface DatabaseArgs

The set of arguments for constructing a Database resource.

property collation

collation?: pulumi.Input<string>;

The name of the collation. Applies only if createMode is Default. Azure default is SQL_LATIN1_GENERAL_CP1_CI_AS. Changing this forces a new resource to be created.

property createMode

createMode?: pulumi.Input<string>;

property edition

edition?: pulumi.Input<string>;

property elasticPoolName

elasticPoolName?: pulumi.Input<string>;

The name of the elastic database pool.

property extendedAuditingPolicy

extendedAuditingPolicy?: pulumi.Input<DatabaseExtendedAuditingPolicy>;

A extendedAuditingPolicy block as defined below.

property import

import?: pulumi.Input<DatabaseImport>;

A Database Import block as documented below. createMode must be set to Default.

property location

location?: pulumi.Input<string>;

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

property maxSizeBytes

maxSizeBytes?: pulumi.Input<string>;

The maximum size that the database can grow to. Applies only if createMode is Default. Please see Azure SQL Database Service Tiers.

property maxSizeGb

maxSizeGb?: pulumi.Input<string>;

property name

name?: pulumi.Input<string>;

The name of the database.

property readScale

readScale?: pulumi.Input<boolean>;

Read-only connections will be redirected to a high-available replica. Please see Use read-only replicas to load-balance read-only query workloads.

property requestedServiceObjectiveId

requestedServiceObjectiveId?: pulumi.Input<string>;

A GUID/UUID corresponding to a configured Service Level Objective for the Azure SQL database which can be used to configure a performance level. .

property requestedServiceObjectiveName

requestedServiceObjectiveName?: pulumi.Input<string>;

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

The name of the resource group in which to create the database. This must be the same as Database Server resource group currently.

property restorePointInTime

restorePointInTime?: pulumi.Input<string>;

The point in time for the restore. Only applies if createMode is PointInTimeRestore e.g. 2013-11-08T22:00:40Z

property serverName

serverName: pulumi.Input<string>;

The name of the SQL Server on which to create the database.

property sourceDatabaseDeletionDate

sourceDatabaseDeletionDate?: pulumi.Input<string>;

The deletion date time of the source database. Only applies to deleted databases where createMode is PointInTimeRestore.

property sourceDatabaseId

sourceDatabaseId?: pulumi.Input<string>;

The URI of the source database if createMode value is not Default.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

property threatDetectionPolicy

threatDetectionPolicy?: pulumi.Input<DatabaseThreatDetectionPolicy>;

Threat detection policy configuration. The threatDetectionPolicy block supports fields documented below.

property zoneRedundant

zoneRedundant?: pulumi.Input<boolean>;

Whether or not this database is zone redundant, which means the replicas of this database will be spread across multiple availability zones.

interface DatabaseState

interface DatabaseState

Input properties used for looking up and filtering Database resources.

property collation

collation?: pulumi.Input<string>;

The name of the collation. Applies only if createMode is Default. Azure default is SQL_LATIN1_GENERAL_CP1_CI_AS. Changing this forces a new resource to be created.

property createMode

createMode?: pulumi.Input<string>;

property creationDate

creationDate?: pulumi.Input<string>;

The creation date of the SQL Database.

property defaultSecondaryLocation

defaultSecondaryLocation?: pulumi.Input<string>;

The default secondary location of the SQL Database.

property edition

edition?: pulumi.Input<string>;

property elasticPoolName

elasticPoolName?: pulumi.Input<string>;

The name of the elastic database pool.

property encryption

encryption?: pulumi.Input<string>;

property extendedAuditingPolicy

extendedAuditingPolicy?: pulumi.Input<DatabaseExtendedAuditingPolicy>;

A extendedAuditingPolicy block as defined below.

property import

import?: pulumi.Input<DatabaseImport>;

A Database Import block as documented below. createMode must be set to Default.

property location

location?: pulumi.Input<string>;

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

property maxSizeBytes

maxSizeBytes?: pulumi.Input<string>;

The maximum size that the database can grow to. Applies only if createMode is Default. Please see Azure SQL Database Service Tiers.

property maxSizeGb

maxSizeGb?: pulumi.Input<string>;

property name

name?: pulumi.Input<string>;

The name of the database.

property readScale

readScale?: pulumi.Input<boolean>;

Read-only connections will be redirected to a high-available replica. Please see Use read-only replicas to load-balance read-only query workloads.

property requestedServiceObjectiveId

requestedServiceObjectiveId?: pulumi.Input<string>;

A GUID/UUID corresponding to a configured Service Level Objective for the Azure SQL database which can be used to configure a performance level. .

property requestedServiceObjectiveName

requestedServiceObjectiveName?: pulumi.Input<string>;

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

The name of the resource group in which to create the database. This must be the same as Database Server resource group currently.

property restorePointInTime

restorePointInTime?: pulumi.Input<string>;

The point in time for the restore. Only applies if createMode is PointInTimeRestore e.g. 2013-11-08T22:00:40Z

property serverName

serverName?: pulumi.Input<string>;

The name of the SQL Server on which to create the database.

property sourceDatabaseDeletionDate

sourceDatabaseDeletionDate?: pulumi.Input<string>;

The deletion date time of the source database. Only applies to deleted databases where createMode is PointInTimeRestore.

property sourceDatabaseId

sourceDatabaseId?: pulumi.Input<string>;

The URI of the source database if createMode value is not Default.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

property threatDetectionPolicy

threatDetectionPolicy?: pulumi.Input<DatabaseThreatDetectionPolicy>;

Threat detection policy configuration. The threatDetectionPolicy block supports fields documented below.

property zoneRedundant

zoneRedundant?: pulumi.Input<boolean>;

Whether or not this database is zone redundant, which means the replicas of this database will be spread across multiple availability zones.

interface ElasticPoolArgs

interface ElasticPoolArgs

The set of arguments for constructing a ElasticPool resource.

property dbDtuMax

dbDtuMax?: pulumi.Input<number>;

The maximum DTU which will be guaranteed to all databases in the elastic pool to be created.

property dbDtuMin

dbDtuMin?: pulumi.Input<number>;

The minimum DTU which will be guaranteed to all databases in the elastic pool to be created.

property dtu

dtu: pulumi.Input<number>;

The total shared DTU for the elastic pool. Valid values depend on the edition which has been defined. Refer to Azure SQL Database Service Tiers for valid combinations.

property edition

edition: pulumi.Input<string>;

property location

location?: pulumi.Input<string>;

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

property name

name?: pulumi.Input<string>;

The name of the elastic pool. This needs to be globally unique. Changing this forces a new resource to be created.

property poolSize

poolSize?: pulumi.Input<number>;

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

The name of the resource group in which to create the elastic pool. This must be the same as the resource group of the underlying SQL server.

property serverName

serverName: pulumi.Input<string>;

The name of the SQL Server on which to create the elastic pool. Changing this forces a new resource to be created.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

interface ElasticPoolState

interface ElasticPoolState

Input properties used for looking up and filtering ElasticPool resources.

property creationDate

creationDate?: pulumi.Input<string>;

The creation date of the SQL Elastic Pool.

property dbDtuMax

dbDtuMax?: pulumi.Input<number>;

The maximum DTU which will be guaranteed to all databases in the elastic pool to be created.

property dbDtuMin

dbDtuMin?: pulumi.Input<number>;

The minimum DTU which will be guaranteed to all databases in the elastic pool to be created.

property dtu

dtu?: pulumi.Input<number>;

The total shared DTU for the elastic pool. Valid values depend on the edition which has been defined. Refer to Azure SQL Database Service Tiers for valid combinations.

property edition

edition?: pulumi.Input<string>;

property location

location?: pulumi.Input<string>;

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

property name

name?: pulumi.Input<string>;

The name of the elastic pool. This needs to be globally unique. Changing this forces a new resource to be created.

property poolSize

poolSize?: pulumi.Input<number>;

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

The name of the resource group in which to create the elastic pool. This must be the same as the resource group of the underlying SQL server.

property serverName

serverName?: pulumi.Input<string>;

The name of the SQL Server on which to create the elastic pool. Changing this forces a new resource to be created.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

interface FailoverGroupArgs

interface FailoverGroupArgs

The set of arguments for constructing a FailoverGroup resource.

property databases

databases?: pulumi.Input<pulumi.Input<string>[]>;

A list of database ids to add to the failover group

property name

name?: pulumi.Input<string>;

The name of the failover group. Changing this forces a new resource to be created.

property partnerServers

partnerServers: pulumi.Input<pulumi.Input<FailoverGroupPartnerServer>[]>;

A list of secondary servers as documented below

property readWriteEndpointFailoverPolicy

readWriteEndpointFailoverPolicy: pulumi.Input<FailoverGroupReadWriteEndpointFailoverPolicy>;

A read/write policy as documented below

property readonlyEndpointFailoverPolicy

readonlyEndpointFailoverPolicy?: pulumi.Input<FailoverGroupReadonlyEndpointFailoverPolicy>;

a read-only policy as documented below

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

The name of the resource group containing the SQL server

property serverName

serverName: pulumi.Input<string>;

The name of the primary SQL server. Changing this forces a new resource to be created.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

interface FailoverGroupState

interface FailoverGroupState

Input properties used for looking up and filtering FailoverGroup resources.

property databases

databases?: pulumi.Input<pulumi.Input<string>[]>;

A list of database ids to add to the failover group

property location

location?: pulumi.Input<string>;

the location of the failover group.

property name

name?: pulumi.Input<string>;

The name of the failover group. Changing this forces a new resource to be created.

property partnerServers

partnerServers?: pulumi.Input<pulumi.Input<FailoverGroupPartnerServer>[]>;

A list of secondary servers as documented below

property readWriteEndpointFailoverPolicy

readWriteEndpointFailoverPolicy?: pulumi.Input<FailoverGroupReadWriteEndpointFailoverPolicy>;

A read/write policy as documented below

property readonlyEndpointFailoverPolicy

readonlyEndpointFailoverPolicy?: pulumi.Input<FailoverGroupReadonlyEndpointFailoverPolicy>;

a read-only policy as documented below

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

The name of the resource group containing the SQL server

property role

role?: pulumi.Input<string>;

local replication role of the failover group instance.

property serverName

serverName?: pulumi.Input<string>;

The name of the primary SQL server. Changing this forces a new resource to be created.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

interface FirewallRuleArgs

interface FirewallRuleArgs

The set of arguments for constructing a FirewallRule resource.

property endIpAddress

endIpAddress: pulumi.Input<string>;

The ending IP address to allow through the firewall for this rule.

property name

name?: pulumi.Input<string>;

The name of the firewall rule.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

The name of the resource group in which to create the sql server.

property serverName

serverName: pulumi.Input<string>;

The name of the SQL Server on which to create the Firewall Rule.

property startIpAddress

startIpAddress: pulumi.Input<string>;

The starting IP address to allow through the firewall for this rule.

interface FirewallRuleState

interface FirewallRuleState

Input properties used for looking up and filtering FirewallRule resources.

property endIpAddress

endIpAddress?: pulumi.Input<string>;

The ending IP address to allow through the firewall for this rule.

property name

name?: pulumi.Input<string>;

The name of the firewall rule.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

The name of the resource group in which to create the sql server.

property serverName

serverName?: pulumi.Input<string>;

The name of the SQL Server on which to create the Firewall Rule.

property startIpAddress

startIpAddress?: pulumi.Input<string>;

The starting IP address to allow through the firewall for this rule.

interface GetDatabaseArgs

interface GetDatabaseArgs

A collection of arguments for invoking getDatabase.

property name

name: string;

The name of the SQL Database.

property resourceGroupName

resourceGroupName: string;

Specifies the name of the Resource Group where the Azure SQL Database exists.

property serverName

serverName: string;

The name of the SQL Server.

property tags

tags?: undefined | {[key: string]: string};

A mapping of tags assigned to the resource.

interface GetDatabaseResult

interface GetDatabaseResult

A collection of values returned by getDatabase.

property collation

collation: string;

The name of the collation.

property defaultSecondaryLocation

defaultSecondaryLocation: string;

The default secondary location of the SQL Database.

property edition

edition: string;

The edition of the database.

property elasticPoolName

elasticPoolName: string;

The name of the elastic database pool the database belongs to.

property failoverGroupId

failoverGroupId: string;

The ID of the failover group the database belongs to.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property location

location: string;

The location of the Resource Group in which the SQL Server exists.

property name

name: string;

The name of the database.

property readScale

readScale: boolean;

Indicate if read-only connections will be redirected to a high-available replica.

property resourceGroupName

resourceGroupName: string;

The name of the resource group in which the database resides. This will always be the same resource group as the Database Server.

property serverName

serverName: string;

The name of the SQL Server on which to create the database.

property tags

tags?: undefined | {[key: string]: string};

A mapping of tags assigned to the resource.

interface GetServerArgs

interface GetServerArgs

A collection of arguments for invoking getServer.

property name

name: string;

The name of the SQL Server.

property resourceGroupName

resourceGroupName: string;

Specifies the name of the Resource Group where the SQL Server exists.

interface GetServerResult

interface GetServerResult

A collection of values returned by getServer.

property administratorLogin

administratorLogin: string;

The administrator username of the SQL Server.

property fqdn

fqdn: string;

The fully qualified domain name of the SQL Server.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property identities

identities: GetServerIdentity[];

An identity block as defined below.

property location

location: string;

The location of the Resource Group in which the SQL Server exists.

property name

name: string;

property resourceGroupName

resourceGroupName: string;

property tags

tags: {[key: string]: string};

A mapping of tags assigned to the resource.

property version

version: string;

The version of the SQL Server.

interface SqlServerArgs

interface SqlServerArgs

The set of arguments for constructing a SqlServer resource.

property administratorLogin

administratorLogin: pulumi.Input<string>;

The administrator login name for the new server. Changing this forces a new resource to be created.

property administratorLoginPassword

administratorLoginPassword: pulumi.Input<string>;

The password associated with the administratorLogin user. Needs to comply with Azure’s Password Policy

property connectionPolicy

connectionPolicy?: pulumi.Input<string>;

The connection policy the server will use. Possible values are Default, Proxy, and Redirect. Defaults to Default.

property extendedAuditingPolicy

extendedAuditingPolicy?: pulumi.Input<SqlServerExtendedAuditingPolicy>;

A extendedAuditingPolicy block as defined below.

property identity

identity?: pulumi.Input<SqlServerIdentity>;

An identity block as defined below.

property location

location?: pulumi.Input<string>;

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

property name

name?: pulumi.Input<string>;

The name of the Microsoft SQL Server. This needs to be globally unique within Azure.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

The name of the resource group in which to create the Microsoft SQL Server.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

property version

version: pulumi.Input<string>;

The version for the new server. Valid values are: 2.0 (for v11 server) and 12.0 (for v12 server).

interface SqlServerState

interface SqlServerState

Input properties used for looking up and filtering SqlServer resources.

property administratorLogin

administratorLogin?: pulumi.Input<string>;

The administrator login name for the new server. Changing this forces a new resource to be created.

property administratorLoginPassword

administratorLoginPassword?: pulumi.Input<string>;

The password associated with the administratorLogin user. Needs to comply with Azure’s Password Policy

property connectionPolicy

connectionPolicy?: pulumi.Input<string>;

The connection policy the server will use. Possible values are Default, Proxy, and Redirect. Defaults to Default.

property extendedAuditingPolicy

extendedAuditingPolicy?: pulumi.Input<SqlServerExtendedAuditingPolicy>;

A extendedAuditingPolicy block as defined below.

property fullyQualifiedDomainName

fullyQualifiedDomainName?: pulumi.Input<string>;

The fully qualified domain name of the Azure SQL Server (e.g. myServerName.database.windows.net)

property identity

identity?: pulumi.Input<SqlServerIdentity>;

An identity block as defined below.

property location

location?: pulumi.Input<string>;

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

property name

name?: pulumi.Input<string>;

The name of the Microsoft SQL Server. This needs to be globally unique within Azure.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

The name of the resource group in which to create the Microsoft SQL Server.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

property version

version?: pulumi.Input<string>;

The version for the new server. Valid values are: 2.0 (for v11 server) and 12.0 (for v12 server).

interface VirtualNetworkRuleArgs

interface VirtualNetworkRuleArgs

The set of arguments for constructing a VirtualNetworkRule resource.

property ignoreMissingVnetServiceEndpoint

ignoreMissingVnetServiceEndpoint?: pulumi.Input<boolean>;

Create the virtual network rule before the subnet has the virtual network service endpoint enabled. The default value is false.

property name

name?: pulumi.Input<string>;

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

The name of the resource group where the SQL server resides. Changing this forces a new resource to be created.

property serverName

serverName: pulumi.Input<string>;

The name of the SQL Server to which this SQL virtual network rule will be applied to. Changing this forces a new resource to be created.

property subnetId

subnetId: pulumi.Input<string>;

The ID of the subnet that the SQL server will be connected to.

interface VirtualNetworkRuleState

interface VirtualNetworkRuleState

Input properties used for looking up and filtering VirtualNetworkRule resources.

property ignoreMissingVnetServiceEndpoint

ignoreMissingVnetServiceEndpoint?: pulumi.Input<boolean>;

Create the virtual network rule before the subnet has the virtual network service endpoint enabled. The default value is false.

property name

name?: pulumi.Input<string>;

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

The name of the resource group where the SQL server resides. Changing this forces a new resource to be created.

property serverName

serverName?: pulumi.Input<string>;

The name of the SQL Server to which this SQL virtual network rule will be applied to. Changing this forces a new resource to be created.

property subnetId

subnetId?: pulumi.Input<string>;

The ID of the subnet that the SQL server will be connected to.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

Module sql

Resources

Functions

Others

Resources

Example Usage

Example Usage

Example Usage

Example Usage

Example Usage

Example Usage

Example Usage

Functions

Example Usage

Example Usage

Others