@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 9.21 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* An Azure SQL Database server.
*
* Uses Azure REST API version 2023-08-01. In version 2.x of the Azure Native provider, it used API version 2021-11-01.
*
* Other available API versions: 2014-04-01, 2015-05-01-preview, 2019-06-01-preview, 2020-02-02-preview, 2020-08-01-preview, 2020-11-01-preview, 2021-02-01-preview, 2021-05-01-preview, 2021-08-01-preview, 2021-11-01, 2021-11-01-preview, 2022-02-01-preview, 2022-05-01-preview, 2022-08-01-preview, 2022-11-01-preview, 2023-02-01-preview, 2023-05-01-preview, 2023-08-01-preview, 2024-05-01-preview, 2024-11-01-preview. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native sql [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*
* **Warning:** when `AzureADOnlyAuthentication` is enabled, the Azure SQL API rejects any `AdministratorLoginPassword`, even if it is the same as the current one.
*
* According to the Azure team, this API design owes to the following reasons:
* - Changing the password is not allowed when Entra-only authentication is enabled because it could lead to invalid templates.
* - Any updates containing the same, unchanged password are also rejected because different behavior for same vs different passwords would be a vector for brute forcing the password.
*
* To work around this, you can comment out `AdministratorLoginPassword` when enabling `AzureADOnlyAuthentication`. To update the password, you can disable `AzureADOnlyAuthentication` and re-enable it after the update.
*
* For more details and discussion please see [this issue](https://github.com/pulumi/pulumi-azure-native/issues/2937).
*/
export declare class Server extends pulumi.CustomResource {
/**
* Get an existing Server resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): Server;
/**
* Returns true if the given object is an instance of Server. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Server;
/**
* Administrator username for the server. Once created it cannot be changed.
*/
readonly administratorLogin: pulumi.Output<string | undefined>;
/**
* 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.
*/
readonly administrators: pulumi.Output<outputs.sql.ServerExternalAdministratorResponse | undefined>;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* Status of external governance.
*/
readonly externalGovernanceStatus: pulumi.Output<string>;
/**
* The Client id used for cross tenant CMK scenario
*/
readonly federatedClientId: pulumi.Output<string | undefined>;
/**
* The fully qualified domain name of the server.
*/
readonly fullyQualifiedDomainName: pulumi.Output<string>;
/**
* The Azure Active Directory identity of the server.
*/
readonly identity: pulumi.Output<outputs.sql.ResourceIdentityResponse | undefined>;
/**
* Whether or not to enable IPv6 support for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled'
*/
readonly isIPv6Enabled: pulumi.Output<string | undefined>;
/**
* A CMK URI of the key to use for encryption.
*/
readonly keyId: pulumi.Output<string | undefined>;
/**
* Kind of sql server. This is metadata used for the Azure portal experience.
*/
readonly kind: pulumi.Output<string>;
/**
* Resource location.
*/
readonly location: pulumi.Output<string>;
/**
* Minimal TLS version. Allowed values: 'None', 1.0', '1.1', '1.2', '1.3'
*/
readonly minimalTlsVersion: pulumi.Output<string | undefined>;
/**
* Resource name.
*/
readonly name: pulumi.Output<string>;
/**
* The resource id of a user assigned identity to be used by default.
*/
readonly primaryUserAssignedIdentityId: pulumi.Output<string | undefined>;
/**
* List of private endpoint connections on a server
*/
readonly privateEndpointConnections: pulumi.Output<outputs.sql.ServerPrivateEndpointConnectionResponse[]>;
/**
* 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'
*/
readonly publicNetworkAccess: pulumi.Output<string | undefined>;
/**
* Whether or not to restrict outbound network access for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled'
*/
readonly restrictOutboundNetworkAccess: pulumi.Output<string | undefined>;
/**
* The state of the server.
*/
readonly state: pulumi.Output<string>;
/**
* Resource tags.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* Resource type.
*/
readonly type: pulumi.Output<string>;
/**
* The version of the server.
*/
readonly version: pulumi.Output<string | undefined>;
/**
* Whether or not existing server has a workspace created and if it allows connection from workspace
*/
readonly workspaceFeature: pulumi.Output<string>;
/**
* Create a Server resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: ServerArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a Server resource.
*/
export interface ServerArgs {
/**
* Administrator username for the server. Once created it cannot be changed.
*/
administratorLogin?: pulumi.Input<string>;
/**
* The administrator login password (required for server creation).
*/
administratorLoginPassword?: pulumi.Input<string>;
/**
* 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.
*/
administrators?: pulumi.Input<inputs.sql.ServerExternalAdministratorArgs>;
/**
* The Client id used for cross tenant CMK scenario
*/
federatedClientId?: pulumi.Input<string>;
/**
* The Azure Active Directory identity of the server.
*/
identity?: pulumi.Input<inputs.sql.ResourceIdentityArgs>;
/**
* Whether or not to enable IPv6 support for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled'
*/
isIPv6Enabled?: pulumi.Input<string | enums.sql.ServerNetworkAccessFlag>;
/**
* A CMK URI of the key to use for encryption.
*/
keyId?: pulumi.Input<string>;
/**
* Resource location.
*/
location?: pulumi.Input<string>;
/**
* Minimal TLS version. Allowed values: 'None', 1.0', '1.1', '1.2', '1.3'
*/
minimalTlsVersion?: pulumi.Input<string | enums.sql.MinimalTlsVersion>;
/**
* The resource id of a user assigned identity to be used by default.
*/
primaryUserAssignedIdentityId?: pulumi.Input<string>;
/**
* 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'
*/
publicNetworkAccess?: pulumi.Input<string | enums.sql.ServerPublicNetworkAccessFlag>;
/**
* The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
*/
resourceGroupName: pulumi.Input<string>;
/**
* Whether or not to restrict outbound network access for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled'
*/
restrictOutboundNetworkAccess?: pulumi.Input<string | enums.sql.ServerNetworkAccessFlag>;
/**
* The name of the server.
*/
serverName?: pulumi.Input<string>;
/**
* Resource tags.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* The version of the server.
*/
version?: pulumi.Input<string>;
}