New-R1DataSourceType
New-R1DataSourceType
SYNOPSIS
Creates a data source type.
SYNTAX
Ldap (Default)
New-R1DataSourceType -name <String> [-description <String>] [-icon <String>] -isLdap <Boolean> [-WhatIf]
[-Confirm] [<CommonParameters>]
Database
New-R1DataSourceType -name <String> [-description <String>] [-icon <String>] -driverClass <String>
-urlPattern <String> [-WhatIf] [-Confirm] [<CommonParameters>]
Custom
New-R1DataSourceType -name <String> [-description <String>] [-icon <String>] -javaClassName <String>
[-pluginName <String>] [-meta <Object[]>] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Creates a data source type. Which kind is created is decided by the parameters supplied: an LDAP type needs isLdap, a database type needs a driver class and URL pattern, and a custom type needs a Java class name.
EXAMPLES
Example 1
New-R1DataSourceType -name 'My LDAP' -isLdap $true
Creates an LDAP data source type.
Example 2
New-R1DataSourceType -name 'My DB' -driverClass 'org.postgresql.Driver' -urlPattern 'jdbc:postgresql://{host}:{port}/{database}'
Creates a database data source type.
Example 3
New-R1DataSourceType -name 'My Custom' -javaClassName 'com.example.Connector' -pluginName 'example'
Creates a custom data source type provided by a plugin.
PARAMETERS
-name
The name of the data source type.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-description
A description of the data source type.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-icon
The icon shown for the type in the control panel.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-isLdap
——————————————————————————— ldap
Type: Boolean
Parameter Sets: Ldap
Aliases:
Required: True
Position: Named
Default value: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-driverClass
—————————————————————————– database
Type: String
Parameter Sets: Database
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-urlPattern
The pattern used to build the JDBC URL.
Type: String
Parameter Sets: Database
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-javaClassName
——————————————————————————- custom
Type: String
Parameter Sets: Custom
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-pluginName
The name of the plugin.
Type: String
Parameter Sets: Custom
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-meta
The property descriptors of the type, each describing one setting a data source of this type carries.
Type: Object[]
Parameter Sets: Custom
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.