Resource Type: dsc_sqldatabaseuser

Defined in:
lib/puppet/type/dsc_sqldatabaseuser.rb

Overview

The DSC SqlDatabaseUser resource type. Automatically generated from version 16.6.0

Properties

  • dsc_asymmetrickeyname

    Specifies the name of the asymmetric key to associate with the database user. This must be specified if parameter UserType is set to ‘’AsymmetricKey’‘.

  • dsc_authenticationtype

    Returns the authentication type of the login connected to the database user. This will return either ‘’Windows’‘, `’Instance’‘, or `’None’‘. The value `’Windows’‘ means the login is using _Windows Authentication_, `’Instance’‘ means that the login is using _SQL Authentication_, and `’None’‘ means that the database user have no login connected to it.

  • dsc_certificatename

    Specifies the name of the certificate to associate with the database user. This must be specified if parameter UserType is set to ‘’Certificate’‘.

  • dsc_databaseisupdateable

    Returns if the database is updatable. If the database is updatable, this will return ‘$true`. Otherwise it will return `$false`.

  • dsc_ensure

    Specifies if the database user should be present or absent. If ‘’Present’‘ then the database user will be added to the database and, if needed, the login mapping will be updated. If `’Absent’‘ then the database user will be removed from the database. Default value is `’Present’‘.

  • dsc_loginname

    Specifies the name of the login to associate with the database user. This must be specified if parameter UserType is set to ‘’Login’‘.

  • dsc_logintype

    Returns the login type of the login connected to the database user. If no login is connected to the database user this returns ‘$null`.

  • dsc_servername

    Specifies the host name of the _SQL Server_ on which the instance exist. Default value is the current computer name.

  • dsc_usertype

    Specifies the type of the database user. Default value is ‘’NoLogin’‘.

Parameters

  • dsc_databasename (namevar)

    Specifies the name of the database in which to configure the database user.

  • dsc_force

    Specifies if it is allowed to re-create the database user if either the user type, the asymmetric key, or the certificate changes. Default value is ‘$false` not allowing database users to be re-created.

  • dsc_instancename (namevar)

    Specifies the _SQL Server_ instance in which the database exist.

  • dsc_name (namevar)

    Specifies the name of the database user to be added or removed.

  • dsc_psdscrunascredential
  • dsc_timeout

    The maximum time in seconds to wait for the DSC resource to complete.

  • name (namevar)

    Description of the purpose for this resource declaration.

  • validation_mode (defaults to: property)

    Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).