akeyless.GatewayMigrationAzureKv

akeyless 2.0.1, Apr 27 26

Viewing docs for akeyless 2.0.1
published on Monday, Apr 27, 2026 by akeyless-community

akeyless-community/terraform-provider-akeyless

Viewing docs for akeyless 2.0.1
published on Monday, Apr 27, 2026 by akeyless-community

akeyless-community/terraform-provider-akeyless

Create GatewayMigrationAzureKv Resource

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

Constructor syntax

new GatewayMigrationAzureKv(name: string, args: GatewayMigrationAzureKvArgs, opts?: CustomResourceOptions);

@overload
def GatewayMigrationAzureKv(resource_name: str,
                            args: GatewayMigrationAzureKvArgs,
                            opts: Optional[ResourceOptions] = None)

@overload
def GatewayMigrationAzureKv(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            target_location: Optional[str] = None,
                            azure_client_id: Optional[str] = None,
                            azure_kv_name: Optional[str] = None,
                            azure_secret: Optional[str] = None,
                            azure_tenant_id: Optional[str] = None,
                            expiration_event_ins: Optional[Sequence[str]] = None,
                            gateway_migration_azure_kv_id: Optional[str] = None,
                            name: Optional[str] = None,
                            protection_key: Optional[str] = None)

func NewGatewayMigrationAzureKv(ctx *Context, name string, args GatewayMigrationAzureKvArgs, opts ...ResourceOption) (*GatewayMigrationAzureKv, error)

public GatewayMigrationAzureKv(string name, GatewayMigrationAzureKvArgs args, CustomResourceOptions? opts = null)

public GatewayMigrationAzureKv(String name, GatewayMigrationAzureKvArgs args)
public GatewayMigrationAzureKv(String name, GatewayMigrationAzureKvArgs args, CustomResourceOptions options)

type: akeyless:GatewayMigrationAzureKv
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

resource "akeyless_gatewaymigrationazurekv" "name" {
    # resource properties
}

Parameters

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

name string: The unique name of the resource.
args GatewayMigrationAzureKvArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args GatewayMigrationAzureKvArgs: 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 gatewayMigrationAzureKvResource = new Akeyless.GatewayMigrationAzureKv("gatewayMigrationAzureKvResource", new()
{
    TargetLocation = "string",
    AzureClientId = "string",
    AzureKvName = "string",
    AzureSecret = "string",
    AzureTenantId = "string",
    ExpirationEventIns = new[]
    {
        "string",
    },
    GatewayMigrationAzureKvId = "string",
    Name = "string",
    ProtectionKey = "string",
});

example, err := akeyless.NewGatewayMigrationAzureKv(ctx, "gatewayMigrationAzureKvResource", &akeyless.GatewayMigrationAzureKvArgs{
	TargetLocation: pulumi.String("string"),
	AzureClientId:  pulumi.String("string"),
	AzureKvName:    pulumi.String("string"),
	AzureSecret:    pulumi.String("string"),
	AzureTenantId:  pulumi.String("string"),
	ExpirationEventIns: pulumi.StringArray{
		pulumi.String("string"),
	},
	GatewayMigrationAzureKvId: pulumi.String("string"),
	Name:                      pulumi.String("string"),
	ProtectionKey:             pulumi.String("string"),
})

resource "akeyless_gatewaymigrationazurekv" "gatewayMigrationAzureKvResource" {
  target_location               = "string"
  azure_client_id               = "string"
  azure_kv_name                 = "string"
  azure_secret                  = "string"
  azure_tenant_id               = "string"
  expiration_event_ins          = ["string"]
  gateway_migration_azure_kv_id = "string"
  name                          = "string"
  protection_key                = "string"
}

var gatewayMigrationAzureKvResource = new GatewayMigrationAzureKv("gatewayMigrationAzureKvResource", GatewayMigrationAzureKvArgs.builder()
    .targetLocation("string")
    .azureClientId("string")
    .azureKvName("string")
    .azureSecret("string")
    .azureTenantId("string")
    .expirationEventIns("string")
    .gatewayMigrationAzureKvId("string")
    .name("string")
    .protectionKey("string")
    .build());

gateway_migration_azure_kv_resource = akeyless.GatewayMigrationAzureKv("gatewayMigrationAzureKvResource",
    target_location="string",
    azure_client_id="string",
    azure_kv_name="string",
    azure_secret="string",
    azure_tenant_id="string",
    expiration_event_ins=["string"],
    gateway_migration_azure_kv_id="string",
    name="string",
    protection_key="string")

const gatewayMigrationAzureKvResource = new akeyless.GatewayMigrationAzureKv("gatewayMigrationAzureKvResource", {
    targetLocation: "string",
    azureClientId: "string",
    azureKvName: "string",
    azureSecret: "string",
    azureTenantId: "string",
    expirationEventIns: ["string"],
    gatewayMigrationAzureKvId: "string",
    name: "string",
    protectionKey: "string",
});

type: akeyless:GatewayMigrationAzureKv
properties:
    azureClientId: string
    azureKvName: string
    azureSecret: string
    azureTenantId: string
    expirationEventIns:
        - string
    gatewayMigrationAzureKvId: string
    name: string
    protectionKey: string
    targetLocation: string

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

TargetLocation string: Target location in Akeyless for imported secrets
AzureClientId string: Azure Key Vault Access client ID, should be Azure AD App with a service principal (relevant only for Azure Key Vault migration)
AzureKvName string: Azure Key Vault Name (relevant only for Azure Key Vault migration)
AzureSecret string: Azure Key Vault secret (relevant only for Azure Key Vault migration)
AzureTenantId string: Azure Key Vault Access tenant ID (relevant only for Azure Key Vault migration)
ExpirationEventIns List<string>: How many days before the expiration of the certificate would you like to be notified.
GatewayMigrationAzureKvId string: The ID of this resource.
Name string: Migration name
ProtectionKey string: The name of the key that protects the classic key value (if empty, the account default key will be used)

TargetLocation string: Target location in Akeyless for imported secrets
AzureClientId string: Azure Key Vault Access client ID, should be Azure AD App with a service principal (relevant only for Azure Key Vault migration)
AzureKvName string: Azure Key Vault Name (relevant only for Azure Key Vault migration)
AzureSecret string: Azure Key Vault secret (relevant only for Azure Key Vault migration)
AzureTenantId string: Azure Key Vault Access tenant ID (relevant only for Azure Key Vault migration)
ExpirationEventIns []string: How many days before the expiration of the certificate would you like to be notified.
GatewayMigrationAzureKvId string: The ID of this resource.
Name string: Migration name
ProtectionKey string: The name of the key that protects the classic key value (if empty, the account default key will be used)

target_location string: Target location in Akeyless for imported secrets
azure_client_id string: Azure Key Vault Access client ID, should be Azure AD App with a service principal (relevant only for Azure Key Vault migration)
azure_kv_name string: Azure Key Vault Name (relevant only for Azure Key Vault migration)
azure_secret string: Azure Key Vault secret (relevant only for Azure Key Vault migration)
azure_tenant_id string: Azure Key Vault Access tenant ID (relevant only for Azure Key Vault migration)
expiration_event_ins list(string): How many days before the expiration of the certificate would you like to be notified.
gateway_migration_azure_kv_id string: The ID of this resource.
name string: Migration name
protection_key string: The name of the key that protects the classic key value (if empty, the account default key will be used)

targetLocation String: Target location in Akeyless for imported secrets
azureClientId String: Azure Key Vault Access client ID, should be Azure AD App with a service principal (relevant only for Azure Key Vault migration)
azureKvName String: Azure Key Vault Name (relevant only for Azure Key Vault migration)
azureSecret String: Azure Key Vault secret (relevant only for Azure Key Vault migration)
azureTenantId String: Azure Key Vault Access tenant ID (relevant only for Azure Key Vault migration)
expirationEventIns List<String>: How many days before the expiration of the certificate would you like to be notified.
gatewayMigrationAzureKvId String: The ID of this resource.
name String: Migration name
protectionKey String: The name of the key that protects the classic key value (if empty, the account default key will be used)

targetLocation string: Target location in Akeyless for imported secrets
azureClientId string: Azure Key Vault Access client ID, should be Azure AD App with a service principal (relevant only for Azure Key Vault migration)
azureKvName string: Azure Key Vault Name (relevant only for Azure Key Vault migration)
azureSecret string: Azure Key Vault secret (relevant only for Azure Key Vault migration)
azureTenantId string: Azure Key Vault Access tenant ID (relevant only for Azure Key Vault migration)
expirationEventIns string[]: How many days before the expiration of the certificate would you like to be notified.
gatewayMigrationAzureKvId string: The ID of this resource.
name string: Migration name
protectionKey string: The name of the key that protects the classic key value (if empty, the account default key will be used)

target_location str: Target location in Akeyless for imported secrets
azure_client_id str: Azure Key Vault Access client ID, should be Azure AD App with a service principal (relevant only for Azure Key Vault migration)
azure_kv_name str: Azure Key Vault Name (relevant only for Azure Key Vault migration)
azure_secret str: Azure Key Vault secret (relevant only for Azure Key Vault migration)
azure_tenant_id str: Azure Key Vault Access tenant ID (relevant only for Azure Key Vault migration)
expiration_event_ins Sequence[str]: How many days before the expiration of the certificate would you like to be notified.
gateway_migration_azure_kv_id str: The ID of this resource.
name str: Migration name
protection_key str: The name of the key that protects the classic key value (if empty, the account default key will be used)

targetLocation String: Target location in Akeyless for imported secrets
azureClientId String: Azure Key Vault Access client ID, should be Azure AD App with a service principal (relevant only for Azure Key Vault migration)
azureKvName String: Azure Key Vault Name (relevant only for Azure Key Vault migration)
azureSecret String: Azure Key Vault secret (relevant only for Azure Key Vault migration)
azureTenantId String: Azure Key Vault Access tenant ID (relevant only for Azure Key Vault migration)
expirationEventIns List<String>: How many days before the expiration of the certificate would you like to be notified.
gatewayMigrationAzureKvId String: The ID of this resource.
name String: Migration name
protectionKey String: The name of the key that protects the classic key value (if empty, the account default key will be used)

Outputs

All input properties are implicitly available as output properties. Additionally, the GatewayMigrationAzureKv 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.
migration_id 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 GatewayMigrationAzureKv Resource

Get an existing GatewayMigrationAzureKv 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?: GatewayMigrationAzureKvState, opts?: CustomResourceOptions): GatewayMigrationAzureKv

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        azure_client_id: Optional[str] = None,
        azure_kv_name: Optional[str] = None,
        azure_secret: Optional[str] = None,
        azure_tenant_id: Optional[str] = None,
        expiration_event_ins: Optional[Sequence[str]] = None,
        gateway_migration_azure_kv_id: Optional[str] = None,
        migration_id: Optional[str] = None,
        name: Optional[str] = None,
        protection_key: Optional[str] = None,
        target_location: Optional[str] = None) -> GatewayMigrationAzureKv

func GetGatewayMigrationAzureKv(ctx *Context, name string, id IDInput, state *GatewayMigrationAzureKvState, opts ...ResourceOption) (*GatewayMigrationAzureKv, error)

public static GatewayMigrationAzureKv Get(string name, Input<string> id, GatewayMigrationAzureKvState? state, CustomResourceOptions? opts = null)

public static GatewayMigrationAzureKv get(String name, Output<String> id, GatewayMigrationAzureKvState state, CustomResourceOptions options)

resources:  _:    type: akeyless:GatewayMigrationAzureKv    get:      id: ${id}

import {
  to = akeyless_gatewaymigrationazurekv.example
  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:

AzureClientId string: Azure Key Vault Access client ID, should be Azure AD App with a service principal (relevant only for Azure Key Vault migration)
AzureKvName string: Azure Key Vault Name (relevant only for Azure Key Vault migration)
AzureSecret string: Azure Key Vault secret (relevant only for Azure Key Vault migration)
AzureTenantId string: Azure Key Vault Access tenant ID (relevant only for Azure Key Vault migration)
ExpirationEventIns List<string>: How many days before the expiration of the certificate would you like to be notified.
GatewayMigrationAzureKvId string: The ID of this resource.
MigrationId string: Migration ID
Name string: Migration name
ProtectionKey string: The name of the key that protects the classic key value (if empty, the account default key will be used)
TargetLocation string: Target location in Akeyless for imported secrets

AzureClientId string: Azure Key Vault Access client ID, should be Azure AD App with a service principal (relevant only for Azure Key Vault migration)
AzureKvName string: Azure Key Vault Name (relevant only for Azure Key Vault migration)
AzureSecret string: Azure Key Vault secret (relevant only for Azure Key Vault migration)
AzureTenantId string: Azure Key Vault Access tenant ID (relevant only for Azure Key Vault migration)
ExpirationEventIns []string: How many days before the expiration of the certificate would you like to be notified.
GatewayMigrationAzureKvId string: The ID of this resource.
MigrationId string: Migration ID
Name string: Migration name
ProtectionKey string: The name of the key that protects the classic key value (if empty, the account default key will be used)
TargetLocation string: Target location in Akeyless for imported secrets

azure_client_id string: Azure Key Vault Access client ID, should be Azure AD App with a service principal (relevant only for Azure Key Vault migration)
azure_kv_name string: Azure Key Vault Name (relevant only for Azure Key Vault migration)
azure_secret string: Azure Key Vault secret (relevant only for Azure Key Vault migration)
azure_tenant_id string: Azure Key Vault Access tenant ID (relevant only for Azure Key Vault migration)
expiration_event_ins list(string): How many days before the expiration of the certificate would you like to be notified.
gateway_migration_azure_kv_id string: The ID of this resource.
migration_id string: Migration ID
name string: Migration name
protection_key string: The name of the key that protects the classic key value (if empty, the account default key will be used)
target_location string: Target location in Akeyless for imported secrets

azureClientId String: Azure Key Vault Access client ID, should be Azure AD App with a service principal (relevant only for Azure Key Vault migration)
azureKvName String: Azure Key Vault Name (relevant only for Azure Key Vault migration)
azureSecret String: Azure Key Vault secret (relevant only for Azure Key Vault migration)
azureTenantId String: Azure Key Vault Access tenant ID (relevant only for Azure Key Vault migration)
expirationEventIns List<String>: How many days before the expiration of the certificate would you like to be notified.
gatewayMigrationAzureKvId String: The ID of this resource.
migrationId String: Migration ID
name String: Migration name
protectionKey String: The name of the key that protects the classic key value (if empty, the account default key will be used)
targetLocation String: Target location in Akeyless for imported secrets

azureClientId string: Azure Key Vault Access client ID, should be Azure AD App with a service principal (relevant only for Azure Key Vault migration)
azureKvName string: Azure Key Vault Name (relevant only for Azure Key Vault migration)
azureSecret string: Azure Key Vault secret (relevant only for Azure Key Vault migration)
azureTenantId string: Azure Key Vault Access tenant ID (relevant only for Azure Key Vault migration)
expirationEventIns string[]: How many days before the expiration of the certificate would you like to be notified.
gatewayMigrationAzureKvId string: The ID of this resource.
migrationId string: Migration ID
name string: Migration name
protectionKey string: The name of the key that protects the classic key value (if empty, the account default key will be used)
targetLocation string: Target location in Akeyless for imported secrets

azure_client_id str: Azure Key Vault Access client ID, should be Azure AD App with a service principal (relevant only for Azure Key Vault migration)
azure_kv_name str: Azure Key Vault Name (relevant only for Azure Key Vault migration)
azure_secret str: Azure Key Vault secret (relevant only for Azure Key Vault migration)
azure_tenant_id str: Azure Key Vault Access tenant ID (relevant only for Azure Key Vault migration)
expiration_event_ins Sequence[str]: How many days before the expiration of the certificate would you like to be notified.
gateway_migration_azure_kv_id str: The ID of this resource.
migration_id str: Migration ID
name str: Migration name
protection_key str: The name of the key that protects the classic key value (if empty, the account default key will be used)
target_location str: Target location in Akeyless for imported secrets

azureClientId String: Azure Key Vault Access client ID, should be Azure AD App with a service principal (relevant only for Azure Key Vault migration)
azureKvName String: Azure Key Vault Name (relevant only for Azure Key Vault migration)
azureSecret String: Azure Key Vault secret (relevant only for Azure Key Vault migration)
azureTenantId String: Azure Key Vault Access tenant ID (relevant only for Azure Key Vault migration)
expirationEventIns List<String>: How many days before the expiration of the certificate would you like to be notified.
gatewayMigrationAzureKvId String: The ID of this resource.
migrationId String: Migration ID
name String: Migration name
protectionKey String: The name of the key that protects the classic key value (if empty, the account default key will be used)
targetLocation String: Target location in Akeyless for imported secrets