1. Packages
  2. MSSQL
  3. API Docs
  4. Provider
Microsoft SQL Server v0.1.0 published on Tuesday, Oct 8, 2024 by pulumiverse

mssql.Provider

Explore with Pulumi AI

mssql logo
Microsoft SQL Server v0.1.0 published on Tuesday, Oct 8, 2024 by pulumiverse

    The provider type for the mssql package. By default, resources use package-wide configuration settings, however an explicit Provider instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the documentation for more information.

    Create Provider Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Provider(name: string, args?: ProviderArgs, opts?: CustomResourceOptions);
    @overload
    def Provider(resource_name: str,
                 args: Optional[ProviderArgs] = None,
                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def Provider(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 azure_auth: Optional[ProviderAzureAuthArgs] = None,
                 hostname: Optional[str] = None,
                 port: Optional[int] = None,
                 sql_auth: Optional[ProviderSqlAuthArgs] = None)
    func NewProvider(ctx *Context, name string, args *ProviderArgs, opts ...ResourceOption) (*Provider, error)
    public Provider(string name, ProviderArgs? args = null, CustomResourceOptions? opts = null)
    public Provider(String name, ProviderArgs args)
    public Provider(String name, ProviderArgs args, CustomResourceOptions options)
    
    type: pulumi:providers:mssql
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args ProviderArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ProviderArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ProviderArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ProviderArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ProviderArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Provider Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Provider resource accepts the following input properties:

    AzureAuth Pulumiverse.Mssql.Inputs.ProviderAzureAuth
    When provided, Azure AD authentication will be used when connecting.
    Hostname string
    FQDN or IP address of the SQL endpoint. Can be also set using MSSQL_HOSTNAME environment variable. It can also be sourced from the following environment variable: MSSQL_HOSTNAME
    Port int
    TCP port of SQL endpoint. Defaults to 1433. Can be also set using MSSQL_PORT environment variable. It can also be sourced from the following environment variable: MSSQL_PORT
    SqlAuth Pulumiverse.Mssql.Inputs.ProviderSqlAuth
    When provided, SQL authentication will be used when connecting.
    AzureAuth ProviderAzureAuthArgs
    When provided, Azure AD authentication will be used when connecting.
    Hostname string
    FQDN or IP address of the SQL endpoint. Can be also set using MSSQL_HOSTNAME environment variable. It can also be sourced from the following environment variable: MSSQL_HOSTNAME
    Port int
    TCP port of SQL endpoint. Defaults to 1433. Can be also set using MSSQL_PORT environment variable. It can also be sourced from the following environment variable: MSSQL_PORT
    SqlAuth ProviderSqlAuthArgs
    When provided, SQL authentication will be used when connecting.
    azureAuth ProviderAzureAuth
    When provided, Azure AD authentication will be used when connecting.
    hostname String
    FQDN or IP address of the SQL endpoint. Can be also set using MSSQL_HOSTNAME environment variable. It can also be sourced from the following environment variable: MSSQL_HOSTNAME
    port Integer
    TCP port of SQL endpoint. Defaults to 1433. Can be also set using MSSQL_PORT environment variable. It can also be sourced from the following environment variable: MSSQL_PORT
    sqlAuth ProviderSqlAuth
    When provided, SQL authentication will be used when connecting.
    azureAuth ProviderAzureAuth
    When provided, Azure AD authentication will be used when connecting.
    hostname string
    FQDN or IP address of the SQL endpoint. Can be also set using MSSQL_HOSTNAME environment variable. It can also be sourced from the following environment variable: MSSQL_HOSTNAME
    port number
    TCP port of SQL endpoint. Defaults to 1433. Can be also set using MSSQL_PORT environment variable. It can also be sourced from the following environment variable: MSSQL_PORT
    sqlAuth ProviderSqlAuth
    When provided, SQL authentication will be used when connecting.
    azure_auth ProviderAzureAuthArgs
    When provided, Azure AD authentication will be used when connecting.
    hostname str
    FQDN or IP address of the SQL endpoint. Can be also set using MSSQL_HOSTNAME environment variable. It can also be sourced from the following environment variable: MSSQL_HOSTNAME
    port int
    TCP port of SQL endpoint. Defaults to 1433. Can be also set using MSSQL_PORT environment variable. It can also be sourced from the following environment variable: MSSQL_PORT
    sql_auth ProviderSqlAuthArgs
    When provided, SQL authentication will be used when connecting.
    azureAuth Property Map
    When provided, Azure AD authentication will be used when connecting.
    hostname String
    FQDN or IP address of the SQL endpoint. Can be also set using MSSQL_HOSTNAME environment variable. It can also be sourced from the following environment variable: MSSQL_HOSTNAME
    port Number
    TCP port of SQL endpoint. Defaults to 1433. Can be also set using MSSQL_PORT environment variable. It can also be sourced from the following environment variable: MSSQL_PORT
    sqlAuth Property Map
    When provided, SQL authentication will be used when connecting.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    ProviderAzureAuth, ProviderAzureAuthArgs

    ClientId string
    Service Principal client (application) ID. When omitted, default, chained set of credentials will be used.
    ClientSecret string
    Service Principal secret. When omitted, default, chained set of credentials will be used.
    TenantId string
    Azure AD tenant ID. Required only if Azure SQL Server's tenant is different than Service Principal's.
    ClientId string
    Service Principal client (application) ID. When omitted, default, chained set of credentials will be used.
    ClientSecret string
    Service Principal secret. When omitted, default, chained set of credentials will be used.
    TenantId string
    Azure AD tenant ID. Required only if Azure SQL Server's tenant is different than Service Principal's.
    clientId String
    Service Principal client (application) ID. When omitted, default, chained set of credentials will be used.
    clientSecret String
    Service Principal secret. When omitted, default, chained set of credentials will be used.
    tenantId String
    Azure AD tenant ID. Required only if Azure SQL Server's tenant is different than Service Principal's.
    clientId string
    Service Principal client (application) ID. When omitted, default, chained set of credentials will be used.
    clientSecret string
    Service Principal secret. When omitted, default, chained set of credentials will be used.
    tenantId string
    Azure AD tenant ID. Required only if Azure SQL Server's tenant is different than Service Principal's.
    client_id str
    Service Principal client (application) ID. When omitted, default, chained set of credentials will be used.
    client_secret str
    Service Principal secret. When omitted, default, chained set of credentials will be used.
    tenant_id str
    Azure AD tenant ID. Required only if Azure SQL Server's tenant is different than Service Principal's.
    clientId String
    Service Principal client (application) ID. When omitted, default, chained set of credentials will be used.
    clientSecret String
    Service Principal secret. When omitted, default, chained set of credentials will be used.
    tenantId String
    Azure AD tenant ID. Required only if Azure SQL Server's tenant is different than Service Principal's.

    ProviderSqlAuth, ProviderSqlAuthArgs

    Password string
    Password for SQL authentication.
    Username string
    User name for SQL authentication.
    Password string
    Password for SQL authentication.
    Username string
    User name for SQL authentication.
    password String
    Password for SQL authentication.
    username String
    User name for SQL authentication.
    password string
    Password for SQL authentication.
    username string
    User name for SQL authentication.
    password str
    Password for SQL authentication.
    username str
    User name for SQL authentication.
    password String
    Password for SQL authentication.
    username String
    User name for SQL authentication.

    Package Details

    Repository
    mssql pulumiverse/pulumi-mssql
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the mssql Terraform Provider.
    mssql logo
    Microsoft SQL Server v0.1.0 published on Tuesday, Oct 8, 2024 by pulumiverse