1. Packages
  2. Packages
  3. Akeyless Provider
  4. API Docs
  5. GatewayMigrationActiveDirectory
Viewing docs for akeyless 2.0.1
published on Monday, Apr 27, 2026 by akeyless-community
Schema (JSON)
akeyless-community/terraform-provider-akeyless

akeyless.GatewayMigrationActiveDirectory

Viewing docs for akeyless 2.0.1
published on Monday, Apr 27, 2026 by akeyless-community
Schema (JSON)
akeyless-community/terraform-provider-akeyless

    Active Directory Migration resource

    Create GatewayMigrationActiveDirectory Resource

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

    Constructor syntax

    new GatewayMigrationActiveDirectory(name: string, args: GatewayMigrationActiveDirectoryArgs, opts?: CustomResourceOptions);
    @overload
def GatewayMigrationActiveDirectory(resource_name: str,
                                    args: GatewayMigrationActiveDirectoryArgs,
                                    opts: Optional[ResourceOptions] = None)

@overload
def GatewayMigrationActiveDirectory(resource_name: str,
                                    opts: Optional[ResourceOptions] = None,
                                    target_location: Optional[str] = None,
                                    ad_sra_enable_rdp: Optional[str] = None,
                                    gateway_migration_active_directory_id: Optional[str] = None,
                                    ad_discover_services: Optional[str] = None,
                                    ad_discovery_types: Optional[Sequence[str]] = None,
                                    ad_domain_name: Optional[str] = None,
                                    ad_domain_users_path_template: Optional[str] = None,
                                    ad_local_users_ignore: Optional[str] = None,
                                    ad_local_users_path_template: Optional[str] = None,
                                    ad_os_filter: Optional[str] = None,
                                    ad_rotation_hour: Optional[float] = None,
                                    ad_rotation_interval: Optional[float] = None,
                                    ad_auto_rotate: Optional[str] = None,
                                    ad_discover_iis_app: Optional[str] = None,
                                    ad_target_name: Optional[str] = None,
                                    ad_ssh_port: Optional[str] = None,
                                    ad_targets_path_template: Optional[str] = None,
                                    ad_targets_type: Optional[str] = None,
                                    ad_user_base_dn: Optional[str] = None,
                                    ad_user_groups: Optional[str] = None,
                                    ad_winrm_over_http: Optional[str] = None,
                                    ad_winrm_port: Optional[str] = None,
                                    ad_target_format: Optional[str] = None,
                                    name: Optional[str] = None,
                                    protection_key: Optional[str] = None,
                                    ad_computer_base_dn: Optional[str] = None)
    func NewGatewayMigrationActiveDirectory(ctx *Context, name string, args GatewayMigrationActiveDirectoryArgs, opts ...ResourceOption) (*GatewayMigrationActiveDirectory, error)
    public GatewayMigrationActiveDirectory(string name, GatewayMigrationActiveDirectoryArgs args, CustomResourceOptions? opts = null)
    public GatewayMigrationActiveDirectory(String name, GatewayMigrationActiveDirectoryArgs args)
public GatewayMigrationActiveDirectory(String name, GatewayMigrationActiveDirectoryArgs args, CustomResourceOptions options)

    type: akeyless:GatewayMigrationActiveDirectory
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 GatewayMigrationActiveDirectoryArgs
    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 GatewayMigrationActiveDirectoryArgs
    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 GatewayMigrationActiveDirectoryArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GatewayMigrationActiveDirectoryArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GatewayMigrationActiveDirectoryArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var gatewayMigrationActiveDirectoryResource = new Akeyless.GatewayMigrationActiveDirectory("gatewayMigrationActiveDirectoryResource", new()
{
    TargetLocation = "string",
    AdSraEnableRdp = "string",
    GatewayMigrationActiveDirectoryId = "string",
    AdDiscoverServices = "string",
    AdDiscoveryTypes = new[]
    {
        "string",
    },
    AdDomainName = "string",
    AdDomainUsersPathTemplate = "string",
    AdLocalUsersIgnore = "string",
    AdLocalUsersPathTemplate = "string",
    AdOsFilter = "string",
    AdRotationHour = 0,
    AdRotationInterval = 0,
    AdAutoRotate = "string",
    AdDiscoverIisApp = "string",
    AdTargetName = "string",
    AdSshPort = "string",
    AdTargetsPathTemplate = "string",
    AdTargetsType = "string",
    AdUserBaseDn = "string",
    AdUserGroups = "string",
    AdWinrmOverHttp = "string",
    AdWinrmPort = "string",
    AdTargetFormat = "string",
    Name = "string",
    ProtectionKey = "string",
    AdComputerBaseDn = "string",
});

    example, err := akeyless.NewGatewayMigrationActiveDirectory(ctx, "gatewayMigrationActiveDirectoryResource", &akeyless.GatewayMigrationActiveDirectoryArgs{
	TargetLocation:                    pulumi.String("string"),
	AdSraEnableRdp:                    pulumi.String("string"),
	GatewayMigrationActiveDirectoryId: pulumi.String("string"),
	AdDiscoverServices:                pulumi.String("string"),
	AdDiscoveryTypes: pulumi.StringArray{
		pulumi.String("string"),
	},
	AdDomainName:              pulumi.String("string"),
	AdDomainUsersPathTemplate: pulumi.String("string"),
	AdLocalUsersIgnore:        pulumi.String("string"),
	AdLocalUsersPathTemplate:  pulumi.String("string"),
	AdOsFilter:                pulumi.String("string"),
	AdRotationHour:            pulumi.Float64(0),
	AdRotationInterval:        pulumi.Float64(0),
	AdAutoRotate:              pulumi.String("string"),
	AdDiscoverIisApp:          pulumi.String("string"),
	AdTargetName:              pulumi.String("string"),
	AdSshPort:                 pulumi.String("string"),
	AdTargetsPathTemplate:     pulumi.String("string"),
	AdTargetsType:             pulumi.String("string"),
	AdUserBaseDn:              pulumi.String("string"),
	AdUserGroups:              pulumi.String("string"),
	AdWinrmOverHttp:           pulumi.String("string"),
	AdWinrmPort:               pulumi.String("string"),
	AdTargetFormat:            pulumi.String("string"),
	Name:                      pulumi.String("string"),
	ProtectionKey:             pulumi.String("string"),
	AdComputerBaseDn:          pulumi.String("string"),
})

    var gatewayMigrationActiveDirectoryResource = new GatewayMigrationActiveDirectory("gatewayMigrationActiveDirectoryResource", GatewayMigrationActiveDirectoryArgs.builder()
    .targetLocation("string")
    .adSraEnableRdp("string")
    .gatewayMigrationActiveDirectoryId("string")
    .adDiscoverServices("string")
    .adDiscoveryTypes("string")
    .adDomainName("string")
    .adDomainUsersPathTemplate("string")
    .adLocalUsersIgnore("string")
    .adLocalUsersPathTemplate("string")
    .adOsFilter("string")
    .adRotationHour(0.0)
    .adRotationInterval(0.0)
    .adAutoRotate("string")
    .adDiscoverIisApp("string")
    .adTargetName("string")
    .adSshPort("string")
    .adTargetsPathTemplate("string")
    .adTargetsType("string")
    .adUserBaseDn("string")
    .adUserGroups("string")
    .adWinrmOverHttp("string")
    .adWinrmPort("string")
    .adTargetFormat("string")
    .name("string")
    .protectionKey("string")
    .adComputerBaseDn("string")
    .build());

    gateway_migration_active_directory_resource = akeyless.GatewayMigrationActiveDirectory("gatewayMigrationActiveDirectoryResource",
    target_location="string",
    ad_sra_enable_rdp="string",
    gateway_migration_active_directory_id="string",
    ad_discover_services="string",
    ad_discovery_types=["string"],
    ad_domain_name="string",
    ad_domain_users_path_template="string",
    ad_local_users_ignore="string",
    ad_local_users_path_template="string",
    ad_os_filter="string",
    ad_rotation_hour=float(0),
    ad_rotation_interval=float(0),
    ad_auto_rotate="string",
    ad_discover_iis_app="string",
    ad_target_name="string",
    ad_ssh_port="string",
    ad_targets_path_template="string",
    ad_targets_type="string",
    ad_user_base_dn="string",
    ad_user_groups="string",
    ad_winrm_over_http="string",
    ad_winrm_port="string",
    ad_target_format="string",
    name="string",
    protection_key="string",
    ad_computer_base_dn="string")

    const gatewayMigrationActiveDirectoryResource = new akeyless.GatewayMigrationActiveDirectory("gatewayMigrationActiveDirectoryResource", {
    targetLocation: "string",
    adSraEnableRdp: "string",
    gatewayMigrationActiveDirectoryId: "string",
    adDiscoverServices: "string",
    adDiscoveryTypes: ["string"],
    adDomainName: "string",
    adDomainUsersPathTemplate: "string",
    adLocalUsersIgnore: "string",
    adLocalUsersPathTemplate: "string",
    adOsFilter: "string",
    adRotationHour: 0,
    adRotationInterval: 0,
    adAutoRotate: "string",
    adDiscoverIisApp: "string",
    adTargetName: "string",
    adSshPort: "string",
    adTargetsPathTemplate: "string",
    adTargetsType: "string",
    adUserBaseDn: "string",
    adUserGroups: "string",
    adWinrmOverHttp: "string",
    adWinrmPort: "string",
    adTargetFormat: "string",
    name: "string",
    protectionKey: "string",
    adComputerBaseDn: "string",
});

    type: akeyless:GatewayMigrationActiveDirectory
properties:
    adAutoRotate: string
    adComputerBaseDn: string
    adDiscoverIisApp: string
    adDiscoverServices: string
    adDiscoveryTypes:
        - string
    adDomainName: string
    adDomainUsersPathTemplate: string
    adLocalUsersIgnore: string
    adLocalUsersPathTemplate: string
    adOsFilter: string
    adRotationHour: 0
    adRotationInterval: 0
    adSraEnableRdp: string
    adSshPort: string
    adTargetFormat: string
    adTargetName: string
    adTargetsPathTemplate: string
    adTargetsType: string
    adUserBaseDn: string
    adUserGroups: string
    adWinrmOverHttp: string
    adWinrmPort: string
    gatewayMigrationActiveDirectoryId: string
    name: string
    protectionKey: string
    targetLocation: string

    GatewayMigrationActiveDirectory 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 GatewayMigrationActiveDirectory resource accepts the following input properties:

    TargetLocation string
    Target location in Akeyless for imported secrets
    AdAutoRotate string
    Enable/Disable automatic/recurrent rotation for migrated secrets
    AdComputerBaseDn string
    Distinguished Name of Computer objects to search in Active Directory
    AdDiscoverIisApp string
    Enable/Disable discovery of IIS application from each domain server
    AdDiscoverServices string
    Enable/Disable discovery of Windows services from each domain server
    AdDiscoveryTypes List<string>
    Set migration discovery types (domain-users, computers, local-users)
    AdDomainName string
    Active Directory Domain Name
    AdDomainUsersPathTemplate string
    Path location template for migrating domain users as Rotated Secrets
    AdLocalUsersIgnore string
    Comma-separated list of Local Users which should not be migrated
    AdLocalUsersPathTemplate string
    Path location template for migrating local users as Rotated Secrets
    AdOsFilter string
    Filter by Operating System to run the migration
    AdRotationHour double
    The hour of the scheduled rotation in UTC
    AdRotationInterval double
    The number of days to wait between every automatic rotation [1-365]
    AdSraEnableRdp string
    Enable/Disable RDP Secure Remote Access for the migrated local users rotated secrets
    AdSshPort string
    Set the SSH Port for further connection to the domain servers
    AdTargetFormat string
    Target format for computers migration (linked/regular)
    AdTargetName string
    Active Directory LDAP Target Name
    AdTargetsPathTemplate string
    Path location template for migrating domain servers as SSH/Windows Targets
    AdTargetsType string
    Set the target type of the domain servers [ssh/windows]
    AdUserBaseDn string
    Distinguished Name of User objects to search in Active Directory
    AdUserGroups string
    Comma-separated list of domain groups from which privileged domain users will be migrated
    AdWinrmOverHttp string
    Use WinRM over HTTP
    AdWinrmPort string
    Set the WinRM Port for further connection to the domain servers
    GatewayMigrationActiveDirectoryId string
    The ID of this resource.
    Name string
    Migration name
    ProtectionKey string
    The name of a key that used to encrypt the secret value (if empty, the account default protectionKey key will be used)
    TargetLocation string
    Target location in Akeyless for imported secrets
    AdAutoRotate string
    Enable/Disable automatic/recurrent rotation for migrated secrets
    AdComputerBaseDn string
    Distinguished Name of Computer objects to search in Active Directory
    AdDiscoverIisApp string
    Enable/Disable discovery of IIS application from each domain server
    AdDiscoverServices string
    Enable/Disable discovery of Windows services from each domain server
    AdDiscoveryTypes []string
    Set migration discovery types (domain-users, computers, local-users)
    AdDomainName string
    Active Directory Domain Name
    AdDomainUsersPathTemplate string
    Path location template for migrating domain users as Rotated Secrets
    AdLocalUsersIgnore string
    Comma-separated list of Local Users which should not be migrated
    AdLocalUsersPathTemplate string
    Path location template for migrating local users as Rotated Secrets
    AdOsFilter string
    Filter by Operating System to run the migration
    AdRotationHour float64
    The hour of the scheduled rotation in UTC
    AdRotationInterval float64
    The number of days to wait between every automatic rotation [1-365]
    AdSraEnableRdp string
    Enable/Disable RDP Secure Remote Access for the migrated local users rotated secrets
    AdSshPort string
    Set the SSH Port for further connection to the domain servers
    AdTargetFormat string
    Target format for computers migration (linked/regular)
    AdTargetName string
    Active Directory LDAP Target Name
    AdTargetsPathTemplate string
    Path location template for migrating domain servers as SSH/Windows Targets
    AdTargetsType string
    Set the target type of the domain servers [ssh/windows]
    AdUserBaseDn string
    Distinguished Name of User objects to search in Active Directory
    AdUserGroups string
    Comma-separated list of domain groups from which privileged domain users will be migrated
    AdWinrmOverHttp string
    Use WinRM over HTTP
    AdWinrmPort string
    Set the WinRM Port for further connection to the domain servers
    GatewayMigrationActiveDirectoryId string
    The ID of this resource.
    Name string
    Migration name
    ProtectionKey string
    The name of a key that used to encrypt the secret value (if empty, the account default protectionKey key will be used)
    targetLocation String
    Target location in Akeyless for imported secrets
    adAutoRotate String
    Enable/Disable automatic/recurrent rotation for migrated secrets
    adComputerBaseDn String
    Distinguished Name of Computer objects to search in Active Directory
    adDiscoverIisApp String
    Enable/Disable discovery of IIS application from each domain server
    adDiscoverServices String
    Enable/Disable discovery of Windows services from each domain server
    adDiscoveryTypes List<String>
    Set migration discovery types (domain-users, computers, local-users)
    adDomainName String
    Active Directory Domain Name
    adDomainUsersPathTemplate String
    Path location template for migrating domain users as Rotated Secrets
    adLocalUsersIgnore String
    Comma-separated list of Local Users which should not be migrated
    adLocalUsersPathTemplate String
    Path location template for migrating local users as Rotated Secrets
    adOsFilter String
    Filter by Operating System to run the migration
    adRotationHour Double
    The hour of the scheduled rotation in UTC
    adRotationInterval Double
    The number of days to wait between every automatic rotation [1-365]
    adSraEnableRdp String
    Enable/Disable RDP Secure Remote Access for the migrated local users rotated secrets
    adSshPort String
    Set the SSH Port for further connection to the domain servers
    adTargetFormat String
    Target format for computers migration (linked/regular)
    adTargetName String
    Active Directory LDAP Target Name
    adTargetsPathTemplate String
    Path location template for migrating domain servers as SSH/Windows Targets
    adTargetsType String
    Set the target type of the domain servers [ssh/windows]
    adUserBaseDn String
    Distinguished Name of User objects to search in Active Directory
    adUserGroups String
    Comma-separated list of domain groups from which privileged domain users will be migrated
    adWinrmOverHttp String
    Use WinRM over HTTP
    adWinrmPort String
    Set the WinRM Port for further connection to the domain servers
    gatewayMigrationActiveDirectoryId String
    The ID of this resource.
    name String
    Migration name
    protectionKey String
    The name of a key that used to encrypt the secret value (if empty, the account default protectionKey key will be used)
    targetLocation string
    Target location in Akeyless for imported secrets
    adAutoRotate string
    Enable/Disable automatic/recurrent rotation for migrated secrets
    adComputerBaseDn string
    Distinguished Name of Computer objects to search in Active Directory
    adDiscoverIisApp string
    Enable/Disable discovery of IIS application from each domain server
    adDiscoverServices string
    Enable/Disable discovery of Windows services from each domain server
    adDiscoveryTypes string[]
    Set migration discovery types (domain-users, computers, local-users)
    adDomainName string
    Active Directory Domain Name
    adDomainUsersPathTemplate string
    Path location template for migrating domain users as Rotated Secrets
    adLocalUsersIgnore string
    Comma-separated list of Local Users which should not be migrated
    adLocalUsersPathTemplate string
    Path location template for migrating local users as Rotated Secrets
    adOsFilter string
    Filter by Operating System to run the migration
    adRotationHour number
    The hour of the scheduled rotation in UTC
    adRotationInterval number
    The number of days to wait between every automatic rotation [1-365]
    adSraEnableRdp string
    Enable/Disable RDP Secure Remote Access for the migrated local users rotated secrets
    adSshPort string
    Set the SSH Port for further connection to the domain servers
    adTargetFormat string
    Target format for computers migration (linked/regular)
    adTargetName string
    Active Directory LDAP Target Name
    adTargetsPathTemplate string
    Path location template for migrating domain servers as SSH/Windows Targets
    adTargetsType string
    Set the target type of the domain servers [ssh/windows]
    adUserBaseDn string
    Distinguished Name of User objects to search in Active Directory
    adUserGroups string
    Comma-separated list of domain groups from which privileged domain users will be migrated
    adWinrmOverHttp string
    Use WinRM over HTTP
    adWinrmPort string
    Set the WinRM Port for further connection to the domain servers
    gatewayMigrationActiveDirectoryId string
    The ID of this resource.
    name string
    Migration name
    protectionKey string
    The name of a key that used to encrypt the secret value (if empty, the account default protectionKey key will be used)
    target_location str
    Target location in Akeyless for imported secrets
    ad_auto_rotate str
    Enable/Disable automatic/recurrent rotation for migrated secrets
    ad_computer_base_dn str
    Distinguished Name of Computer objects to search in Active Directory
    ad_discover_iis_app str
    Enable/Disable discovery of IIS application from each domain server
    ad_discover_services str
    Enable/Disable discovery of Windows services from each domain server
    ad_discovery_types Sequence[str]
    Set migration discovery types (domain-users, computers, local-users)
    ad_domain_name str
    Active Directory Domain Name
    ad_domain_users_path_template str
    Path location template for migrating domain users as Rotated Secrets
    ad_local_users_ignore str
    Comma-separated list of Local Users which should not be migrated
    ad_local_users_path_template str
    Path location template for migrating local users as Rotated Secrets
    ad_os_filter str
    Filter by Operating System to run the migration
    ad_rotation_hour float
    The hour of the scheduled rotation in UTC
    ad_rotation_interval float
    The number of days to wait between every automatic rotation [1-365]
    ad_sra_enable_rdp str
    Enable/Disable RDP Secure Remote Access for the migrated local users rotated secrets
    ad_ssh_port str
    Set the SSH Port for further connection to the domain servers
    ad_target_format str
    Target format for computers migration (linked/regular)
    ad_target_name str
    Active Directory LDAP Target Name
    ad_targets_path_template str
    Path location template for migrating domain servers as SSH/Windows Targets
    ad_targets_type str
    Set the target type of the domain servers [ssh/windows]
    ad_user_base_dn str
    Distinguished Name of User objects to search in Active Directory
    ad_user_groups str
    Comma-separated list of domain groups from which privileged domain users will be migrated
    ad_winrm_over_http str
    Use WinRM over HTTP
    ad_winrm_port str
    Set the WinRM Port for further connection to the domain servers
    gateway_migration_active_directory_id str
    The ID of this resource.
    name str
    Migration name
    protection_key str
    The name of a key that used to encrypt the secret value (if empty, the account default protectionKey key will be used)
    targetLocation String
    Target location in Akeyless for imported secrets
    adAutoRotate String
    Enable/Disable automatic/recurrent rotation for migrated secrets
    adComputerBaseDn String
    Distinguished Name of Computer objects to search in Active Directory
    adDiscoverIisApp String
    Enable/Disable discovery of IIS application from each domain server
    adDiscoverServices String
    Enable/Disable discovery of Windows services from each domain server
    adDiscoveryTypes List<String>
    Set migration discovery types (domain-users, computers, local-users)
    adDomainName String
    Active Directory Domain Name
    adDomainUsersPathTemplate String
    Path location template for migrating domain users as Rotated Secrets
    adLocalUsersIgnore String
    Comma-separated list of Local Users which should not be migrated
    adLocalUsersPathTemplate String
    Path location template for migrating local users as Rotated Secrets
    adOsFilter String
    Filter by Operating System to run the migration
    adRotationHour Number
    The hour of the scheduled rotation in UTC
    adRotationInterval Number
    The number of days to wait between every automatic rotation [1-365]
    adSraEnableRdp String
    Enable/Disable RDP Secure Remote Access for the migrated local users rotated secrets
    adSshPort String
    Set the SSH Port for further connection to the domain servers
    adTargetFormat String
    Target format for computers migration (linked/regular)
    adTargetName String
    Active Directory LDAP Target Name
    adTargetsPathTemplate String
    Path location template for migrating domain servers as SSH/Windows Targets
    adTargetsType String
    Set the target type of the domain servers [ssh/windows]
    adUserBaseDn String
    Distinguished Name of User objects to search in Active Directory
    adUserGroups String
    Comma-separated list of domain groups from which privileged domain users will be migrated
    adWinrmOverHttp String
    Use WinRM over HTTP
    adWinrmPort String
    Set the WinRM Port for further connection to the domain servers
    gatewayMigrationActiveDirectoryId String
    The ID of this resource.
    name String
    Migration name
    protectionKey String
    The name of a key that used to encrypt the secret value (if empty, the account default protectionKey key will be used)

    Outputs

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

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

    Look up Existing GatewayMigrationActiveDirectory Resource

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

    public static get(name: string, id: Input<ID>, state?: GatewayMigrationActiveDirectoryState, opts?: CustomResourceOptions): GatewayMigrationActiveDirectory
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        ad_auto_rotate: Optional[str] = None,
        ad_computer_base_dn: Optional[str] = None,
        ad_discover_iis_app: Optional[str] = None,
        ad_discover_services: Optional[str] = None,
        ad_discovery_types: Optional[Sequence[str]] = None,
        ad_domain_name: Optional[str] = None,
        ad_domain_users_path_template: Optional[str] = None,
        ad_local_users_ignore: Optional[str] = None,
        ad_local_users_path_template: Optional[str] = None,
        ad_os_filter: Optional[str] = None,
        ad_rotation_hour: Optional[float] = None,
        ad_rotation_interval: Optional[float] = None,
        ad_sra_enable_rdp: Optional[str] = None,
        ad_ssh_port: Optional[str] = None,
        ad_target_format: Optional[str] = None,
        ad_target_name: Optional[str] = None,
        ad_targets_path_template: Optional[str] = None,
        ad_targets_type: Optional[str] = None,
        ad_user_base_dn: Optional[str] = None,
        ad_user_groups: Optional[str] = None,
        ad_winrm_over_http: Optional[str] = None,
        ad_winrm_port: Optional[str] = None,
        gateway_migration_active_directory_id: Optional[str] = None,
        migration_id: Optional[str] = None,
        name: Optional[str] = None,
        protection_key: Optional[str] = None,
        target_location: Optional[str] = None) -> GatewayMigrationActiveDirectory
    func GetGatewayMigrationActiveDirectory(ctx *Context, name string, id IDInput, state *GatewayMigrationActiveDirectoryState, opts ...ResourceOption) (*GatewayMigrationActiveDirectory, error)
    public static GatewayMigrationActiveDirectory Get(string name, Input<string> id, GatewayMigrationActiveDirectoryState? state, CustomResourceOptions? opts = null)
    public static GatewayMigrationActiveDirectory get(String name, Output<String> id, GatewayMigrationActiveDirectoryState state, CustomResourceOptions options)
    resources:  _:    type: akeyless:GatewayMigrationActiveDirectory    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AdAutoRotate string
    Enable/Disable automatic/recurrent rotation for migrated secrets
    AdComputerBaseDn string
    Distinguished Name of Computer objects to search in Active Directory
    AdDiscoverIisApp string
    Enable/Disable discovery of IIS application from each domain server
    AdDiscoverServices string
    Enable/Disable discovery of Windows services from each domain server
    AdDiscoveryTypes List<string>
    Set migration discovery types (domain-users, computers, local-users)
    AdDomainName string
    Active Directory Domain Name
    AdDomainUsersPathTemplate string
    Path location template for migrating domain users as Rotated Secrets
    AdLocalUsersIgnore string
    Comma-separated list of Local Users which should not be migrated
    AdLocalUsersPathTemplate string
    Path location template for migrating local users as Rotated Secrets
    AdOsFilter string
    Filter by Operating System to run the migration
    AdRotationHour double
    The hour of the scheduled rotation in UTC
    AdRotationInterval double
    The number of days to wait between every automatic rotation [1-365]
    AdSraEnableRdp string
    Enable/Disable RDP Secure Remote Access for the migrated local users rotated secrets
    AdSshPort string
    Set the SSH Port for further connection to the domain servers
    AdTargetFormat string
    Target format for computers migration (linked/regular)
    AdTargetName string
    Active Directory LDAP Target Name
    AdTargetsPathTemplate string
    Path location template for migrating domain servers as SSH/Windows Targets
    AdTargetsType string
    Set the target type of the domain servers [ssh/windows]
    AdUserBaseDn string
    Distinguished Name of User objects to search in Active Directory
    AdUserGroups string
    Comma-separated list of domain groups from which privileged domain users will be migrated
    AdWinrmOverHttp string
    Use WinRM over HTTP
    AdWinrmPort string
    Set the WinRM Port for further connection to the domain servers
    GatewayMigrationActiveDirectoryId string
    The ID of this resource.
    MigrationId string
    Migration ID
    Name string
    Migration name
    ProtectionKey string
    The name of a key that used to encrypt the secret value (if empty, the account default protectionKey key will be used)
    TargetLocation string
    Target location in Akeyless for imported secrets
    AdAutoRotate string
    Enable/Disable automatic/recurrent rotation for migrated secrets
    AdComputerBaseDn string
    Distinguished Name of Computer objects to search in Active Directory
    AdDiscoverIisApp string
    Enable/Disable discovery of IIS application from each domain server
    AdDiscoverServices string
    Enable/Disable discovery of Windows services from each domain server
    AdDiscoveryTypes []string
    Set migration discovery types (domain-users, computers, local-users)
    AdDomainName string
    Active Directory Domain Name
    AdDomainUsersPathTemplate string
    Path location template for migrating domain users as Rotated Secrets
    AdLocalUsersIgnore string
    Comma-separated list of Local Users which should not be migrated
    AdLocalUsersPathTemplate string
    Path location template for migrating local users as Rotated Secrets
    AdOsFilter string
    Filter by Operating System to run the migration
    AdRotationHour float64
    The hour of the scheduled rotation in UTC
    AdRotationInterval float64
    The number of days to wait between every automatic rotation [1-365]
    AdSraEnableRdp string
    Enable/Disable RDP Secure Remote Access for the migrated local users rotated secrets
    AdSshPort string
    Set the SSH Port for further connection to the domain servers
    AdTargetFormat string
    Target format for computers migration (linked/regular)
    AdTargetName string
    Active Directory LDAP Target Name
    AdTargetsPathTemplate string
    Path location template for migrating domain servers as SSH/Windows Targets
    AdTargetsType string
    Set the target type of the domain servers [ssh/windows]
    AdUserBaseDn string
    Distinguished Name of User objects to search in Active Directory
    AdUserGroups string
    Comma-separated list of domain groups from which privileged domain users will be migrated
    AdWinrmOverHttp string
    Use WinRM over HTTP
    AdWinrmPort string
    Set the WinRM Port for further connection to the domain servers
    GatewayMigrationActiveDirectoryId string
    The ID of this resource.
    MigrationId string
    Migration ID
    Name string
    Migration name
    ProtectionKey string
    The name of a key that used to encrypt the secret value (if empty, the account default protectionKey key will be used)
    TargetLocation string
    Target location in Akeyless for imported secrets
    adAutoRotate String
    Enable/Disable automatic/recurrent rotation for migrated secrets
    adComputerBaseDn String
    Distinguished Name of Computer objects to search in Active Directory
    adDiscoverIisApp String
    Enable/Disable discovery of IIS application from each domain server
    adDiscoverServices String
    Enable/Disable discovery of Windows services from each domain server
    adDiscoveryTypes List<String>
    Set migration discovery types (domain-users, computers, local-users)
    adDomainName String
    Active Directory Domain Name
    adDomainUsersPathTemplate String
    Path location template for migrating domain users as Rotated Secrets
    adLocalUsersIgnore String
    Comma-separated list of Local Users which should not be migrated
    adLocalUsersPathTemplate String
    Path location template for migrating local users as Rotated Secrets
    adOsFilter String
    Filter by Operating System to run the migration
    adRotationHour Double
    The hour of the scheduled rotation in UTC
    adRotationInterval Double
    The number of days to wait between every automatic rotation [1-365]
    adSraEnableRdp String
    Enable/Disable RDP Secure Remote Access for the migrated local users rotated secrets
    adSshPort String
    Set the SSH Port for further connection to the domain servers
    adTargetFormat String
    Target format for computers migration (linked/regular)
    adTargetName String
    Active Directory LDAP Target Name
    adTargetsPathTemplate String
    Path location template for migrating domain servers as SSH/Windows Targets
    adTargetsType String
    Set the target type of the domain servers [ssh/windows]
    adUserBaseDn String
    Distinguished Name of User objects to search in Active Directory
    adUserGroups String
    Comma-separated list of domain groups from which privileged domain users will be migrated
    adWinrmOverHttp String
    Use WinRM over HTTP
    adWinrmPort String
    Set the WinRM Port for further connection to the domain servers
    gatewayMigrationActiveDirectoryId String
    The ID of this resource.
    migrationId String
    Migration ID
    name String
    Migration name
    protectionKey String
    The name of a key that used to encrypt the secret value (if empty, the account default protectionKey key will be used)
    targetLocation String
    Target location in Akeyless for imported secrets
    adAutoRotate string
    Enable/Disable automatic/recurrent rotation for migrated secrets
    adComputerBaseDn string
    Distinguished Name of Computer objects to search in Active Directory
    adDiscoverIisApp string
    Enable/Disable discovery of IIS application from each domain server
    adDiscoverServices string
    Enable/Disable discovery of Windows services from each domain server
    adDiscoveryTypes string[]
    Set migration discovery types (domain-users, computers, local-users)
    adDomainName string
    Active Directory Domain Name
    adDomainUsersPathTemplate string
    Path location template for migrating domain users as Rotated Secrets
    adLocalUsersIgnore string
    Comma-separated list of Local Users which should not be migrated
    adLocalUsersPathTemplate string
    Path location template for migrating local users as Rotated Secrets
    adOsFilter string
    Filter by Operating System to run the migration
    adRotationHour number
    The hour of the scheduled rotation in UTC
    adRotationInterval number
    The number of days to wait between every automatic rotation [1-365]
    adSraEnableRdp string
    Enable/Disable RDP Secure Remote Access for the migrated local users rotated secrets
    adSshPort string
    Set the SSH Port for further connection to the domain servers
    adTargetFormat string
    Target format for computers migration (linked/regular)
    adTargetName string
    Active Directory LDAP Target Name
    adTargetsPathTemplate string
    Path location template for migrating domain servers as SSH/Windows Targets
    adTargetsType string
    Set the target type of the domain servers [ssh/windows]
    adUserBaseDn string
    Distinguished Name of User objects to search in Active Directory
    adUserGroups string
    Comma-separated list of domain groups from which privileged domain users will be migrated
    adWinrmOverHttp string
    Use WinRM over HTTP
    adWinrmPort string
    Set the WinRM Port for further connection to the domain servers
    gatewayMigrationActiveDirectoryId string
    The ID of this resource.
    migrationId string
    Migration ID
    name string
    Migration name
    protectionKey string
    The name of a key that used to encrypt the secret value (if empty, the account default protectionKey key will be used)
    targetLocation string
    Target location in Akeyless for imported secrets
    ad_auto_rotate str
    Enable/Disable automatic/recurrent rotation for migrated secrets
    ad_computer_base_dn str
    Distinguished Name of Computer objects to search in Active Directory
    ad_discover_iis_app str
    Enable/Disable discovery of IIS application from each domain server
    ad_discover_services str
    Enable/Disable discovery of Windows services from each domain server
    ad_discovery_types Sequence[str]
    Set migration discovery types (domain-users, computers, local-users)
    ad_domain_name str
    Active Directory Domain Name
    ad_domain_users_path_template str
    Path location template for migrating domain users as Rotated Secrets
    ad_local_users_ignore str
    Comma-separated list of Local Users which should not be migrated
    ad_local_users_path_template str
    Path location template for migrating local users as Rotated Secrets
    ad_os_filter str
    Filter by Operating System to run the migration
    ad_rotation_hour float
    The hour of the scheduled rotation in UTC
    ad_rotation_interval float
    The number of days to wait between every automatic rotation [1-365]
    ad_sra_enable_rdp str
    Enable/Disable RDP Secure Remote Access for the migrated local users rotated secrets
    ad_ssh_port str
    Set the SSH Port for further connection to the domain servers
    ad_target_format str
    Target format for computers migration (linked/regular)
    ad_target_name str
    Active Directory LDAP Target Name
    ad_targets_path_template str
    Path location template for migrating domain servers as SSH/Windows Targets
    ad_targets_type str
    Set the target type of the domain servers [ssh/windows]
    ad_user_base_dn str
    Distinguished Name of User objects to search in Active Directory
    ad_user_groups str
    Comma-separated list of domain groups from which privileged domain users will be migrated
    ad_winrm_over_http str
    Use WinRM over HTTP
    ad_winrm_port str
    Set the WinRM Port for further connection to the domain servers
    gateway_migration_active_directory_id str
    The ID of this resource.
    migration_id str
    Migration ID
    name str
    Migration name
    protection_key str
    The name of a key that used to encrypt the secret value (if empty, the account default protectionKey key will be used)
    target_location str
    Target location in Akeyless for imported secrets
    adAutoRotate String
    Enable/Disable automatic/recurrent rotation for migrated secrets
    adComputerBaseDn String
    Distinguished Name of Computer objects to search in Active Directory
    adDiscoverIisApp String
    Enable/Disable discovery of IIS application from each domain server
    adDiscoverServices String
    Enable/Disable discovery of Windows services from each domain server
    adDiscoveryTypes List<String>
    Set migration discovery types (domain-users, computers, local-users)
    adDomainName String
    Active Directory Domain Name
    adDomainUsersPathTemplate String
    Path location template for migrating domain users as Rotated Secrets
    adLocalUsersIgnore String
    Comma-separated list of Local Users which should not be migrated
    adLocalUsersPathTemplate String
    Path location template for migrating local users as Rotated Secrets
    adOsFilter String
    Filter by Operating System to run the migration
    adRotationHour Number
    The hour of the scheduled rotation in UTC
    adRotationInterval Number
    The number of days to wait between every automatic rotation [1-365]
    adSraEnableRdp String
    Enable/Disable RDP Secure Remote Access for the migrated local users rotated secrets
    adSshPort String
    Set the SSH Port for further connection to the domain servers
    adTargetFormat String
    Target format for computers migration (linked/regular)
    adTargetName String
    Active Directory LDAP Target Name
    adTargetsPathTemplate String
    Path location template for migrating domain servers as SSH/Windows Targets
    adTargetsType String
    Set the target type of the domain servers [ssh/windows]
    adUserBaseDn String
    Distinguished Name of User objects to search in Active Directory
    adUserGroups String
    Comma-separated list of domain groups from which privileged domain users will be migrated
    adWinrmOverHttp String
    Use WinRM over HTTP
    adWinrmPort String
    Set the WinRM Port for further connection to the domain servers
    gatewayMigrationActiveDirectoryId String
    The ID of this resource.
    migrationId String
    Migration ID
    name String
    Migration name
    protectionKey String
    The name of a key that used to encrypt the secret value (if empty, the account default protectionKey key will be used)
    targetLocation String
    Target location in Akeyless for imported secrets

    Package Details

    Repository
    akeyless akeyless-community/terraform-provider-akeyless
    License
    Notes
    This Pulumi package is based on the akeyless Terraform Provider.
    Viewing docs for akeyless 2.0.1
    published on Monday, Apr 27, 2026 by akeyless-community
    Schema (JSON)
    akeyless-community/terraform-provider-akeyless
      Try Pulumi Cloud free. Your team will thank you.