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

akeyless.TargetAzure

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

    Azure Target resource

    Create TargetAzure Resource

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

    Constructor syntax

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

@overload
def TargetAzure(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                client_id: Optional[str] = None,
                client_secret: Optional[str] = None,
                connection_type: Optional[str] = None,
                description: Optional[str] = None,
                keep_prev_version: Optional[str] = None,
                key: Optional[str] = None,
                max_versions: Optional[str] = None,
                name: Optional[str] = None,
                resource_group_name: Optional[str] = None,
                resource_name_: Optional[str] = None,
                subscription_id: Optional[str] = None,
                target_azure_id: Optional[str] = None,
                tenant_id: Optional[str] = None,
                use_gw_cloud_identity: Optional[bool] = None)
    func NewTargetAzure(ctx *Context, name string, args *TargetAzureArgs, opts ...ResourceOption) (*TargetAzure, error)
    public TargetAzure(string name, TargetAzureArgs? args = null, CustomResourceOptions? opts = null)
    public TargetAzure(String name, TargetAzureArgs args)
public TargetAzure(String name, TargetAzureArgs args, CustomResourceOptions options)

    type: akeyless:TargetAzure
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 TargetAzureArgs
    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 TargetAzureArgs
    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 TargetAzureArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TargetAzureArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TargetAzureArgs
    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 targetAzureResource = new Akeyless.TargetAzure("targetAzureResource", new()
{
    ClientId = "string",
    ClientSecret = "string",
    ConnectionType = "string",
    Description = "string",
    KeepPrevVersion = "string",
    Key = "string",
    MaxVersions = "string",
    Name = "string",
    ResourceGroupName = "string",
    ResourceName = "string",
    SubscriptionId = "string",
    TargetAzureId = "string",
    TenantId = "string",
    UseGwCloudIdentity = false,
});

    example, err := akeyless.NewTargetAzure(ctx, "targetAzureResource", &akeyless.TargetAzureArgs{
	ClientId:           pulumi.String("string"),
	ClientSecret:       pulumi.String("string"),
	ConnectionType:     pulumi.String("string"),
	Description:        pulumi.String("string"),
	KeepPrevVersion:    pulumi.String("string"),
	Key:                pulumi.String("string"),
	MaxVersions:        pulumi.String("string"),
	Name:               pulumi.String("string"),
	ResourceGroupName:  pulumi.String("string"),
	ResourceName:       pulumi.String("string"),
	SubscriptionId:     pulumi.String("string"),
	TargetAzureId:      pulumi.String("string"),
	TenantId:           pulumi.String("string"),
	UseGwCloudIdentity: pulumi.Bool(false),
})

    var targetAzureResource = new TargetAzure("targetAzureResource", TargetAzureArgs.builder()
    .clientId("string")
    .clientSecret("string")
    .connectionType("string")
    .description("string")
    .keepPrevVersion("string")
    .key("string")
    .maxVersions("string")
    .name("string")
    .resourceGroupName("string")
    .resourceName("string")
    .subscriptionId("string")
    .targetAzureId("string")
    .tenantId("string")
    .useGwCloudIdentity(false)
    .build());

    target_azure_resource = akeyless.TargetAzure("targetAzureResource",
    client_id="string",
    client_secret="string",
    connection_type="string",
    description="string",
    keep_prev_version="string",
    key="string",
    max_versions="string",
    name="string",
    resource_group_name="string",
    resource_name_="string",
    subscription_id="string",
    target_azure_id="string",
    tenant_id="string",
    use_gw_cloud_identity=False)

    const targetAzureResource = new akeyless.TargetAzure("targetAzureResource", {
    clientId: "string",
    clientSecret: "string",
    connectionType: "string",
    description: "string",
    keepPrevVersion: "string",
    key: "string",
    maxVersions: "string",
    name: "string",
    resourceGroupName: "string",
    resourceName: "string",
    subscriptionId: "string",
    targetAzureId: "string",
    tenantId: "string",
    useGwCloudIdentity: false,
});

    type: akeyless:TargetAzure
properties:
    clientId: string
    clientSecret: string
    connectionType: string
    description: string
    keepPrevVersion: string
    key: string
    maxVersions: string
    name: string
    resourceGroupName: string
    resourceName: string
    subscriptionId: string
    targetAzureId: string
    tenantId: string
    useGwCloudIdentity: false

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

    ClientId string
    Azure client/application id
    ClientSecret string
    Azure client secret
    ConnectionType string
    Type of connection [credentials/cloud-identity]
    Description string
    Description of the object
    KeepPrevVersion string
    Whether to keep previous version [true/false]. If not set, use default according to account settings
    Key string
    Key name. The key is used to encrypt the target secret value. If the key name is not specified, the account default protection key is used
    MaxVersions string
    Set the maximum number of versions, limited by the account settings defaults
    Name string
    Target name
    ResourceGroupName string
    The Resource Group name in your Azure subscription
    ResourceName string
    The name of the relevant Resource
    SubscriptionId string
    Azure Subscription Id
    TargetAzureId string
    The ID of this resource.
    TenantId string
    Azure tenant id
    UseGwCloudIdentity bool
    Use the GW's Cloud IAM
    ClientId string
    Azure client/application id
    ClientSecret string
    Azure client secret
    ConnectionType string
    Type of connection [credentials/cloud-identity]
    Description string
    Description of the object
    KeepPrevVersion string
    Whether to keep previous version [true/false]. If not set, use default according to account settings
    Key string
    Key name. The key is used to encrypt the target secret value. If the key name is not specified, the account default protection key is used
    MaxVersions string
    Set the maximum number of versions, limited by the account settings defaults
    Name string
    Target name
    ResourceGroupName string
    The Resource Group name in your Azure subscription
    ResourceName string
    The name of the relevant Resource
    SubscriptionId string
    Azure Subscription Id
    TargetAzureId string
    The ID of this resource.
    TenantId string
    Azure tenant id
    UseGwCloudIdentity bool
    Use the GW's Cloud IAM
    clientId String
    Azure client/application id
    clientSecret String
    Azure client secret
    connectionType String
    Type of connection [credentials/cloud-identity]
    description String
    Description of the object
    keepPrevVersion String
    Whether to keep previous version [true/false]. If not set, use default according to account settings
    key String
    Key name. The key is used to encrypt the target secret value. If the key name is not specified, the account default protection key is used
    maxVersions String
    Set the maximum number of versions, limited by the account settings defaults
    name String
    Target name
    resourceGroupName String
    The Resource Group name in your Azure subscription
    resourceName String
    The name of the relevant Resource
    subscriptionId String
    Azure Subscription Id
    targetAzureId String
    The ID of this resource.
    tenantId String
    Azure tenant id
    useGwCloudIdentity Boolean
    Use the GW's Cloud IAM
    clientId string
    Azure client/application id
    clientSecret string
    Azure client secret
    connectionType string
    Type of connection [credentials/cloud-identity]
    description string
    Description of the object
    keepPrevVersion string
    Whether to keep previous version [true/false]. If not set, use default according to account settings
    key string
    Key name. The key is used to encrypt the target secret value. If the key name is not specified, the account default protection key is used
    maxVersions string
    Set the maximum number of versions, limited by the account settings defaults
    name string
    Target name
    resourceGroupName string
    The Resource Group name in your Azure subscription
    resourceName string
    The name of the relevant Resource
    subscriptionId string
    Azure Subscription Id
    targetAzureId string
    The ID of this resource.
    tenantId string
    Azure tenant id
    useGwCloudIdentity boolean
    Use the GW's Cloud IAM
    client_id str
    Azure client/application id
    client_secret str
    Azure client secret
    connection_type str
    Type of connection [credentials/cloud-identity]
    description str
    Description of the object
    keep_prev_version str
    Whether to keep previous version [true/false]. If not set, use default according to account settings
    key str
    Key name. The key is used to encrypt the target secret value. If the key name is not specified, the account default protection key is used
    max_versions str
    Set the maximum number of versions, limited by the account settings defaults
    name str
    Target name
    resource_group_name str
    The Resource Group name in your Azure subscription
    resource_name str
    The name of the relevant Resource
    subscription_id str
    Azure Subscription Id
    target_azure_id str
    The ID of this resource.
    tenant_id str
    Azure tenant id
    use_gw_cloud_identity bool
    Use the GW's Cloud IAM
    clientId String
    Azure client/application id
    clientSecret String
    Azure client secret
    connectionType String
    Type of connection [credentials/cloud-identity]
    description String
    Description of the object
    keepPrevVersion String
    Whether to keep previous version [true/false]. If not set, use default according to account settings
    key String
    Key name. The key is used to encrypt the target secret value. If the key name is not specified, the account default protection key is used
    maxVersions String
    Set the maximum number of versions, limited by the account settings defaults
    name String
    Target name
    resourceGroupName String
    The Resource Group name in your Azure subscription
    resourceName String
    The name of the relevant Resource
    subscriptionId String
    Azure Subscription Id
    targetAzureId String
    The ID of this resource.
    tenantId String
    Azure tenant id
    useGwCloudIdentity Boolean
    Use the GW's Cloud IAM

    Outputs

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

    Look up Existing TargetAzure Resource

    Get an existing TargetAzure 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?: TargetAzureState, opts?: CustomResourceOptions): TargetAzure
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        client_id: Optional[str] = None,
        client_secret: Optional[str] = None,
        connection_type: Optional[str] = None,
        description: Optional[str] = None,
        keep_prev_version: Optional[str] = None,
        key: Optional[str] = None,
        max_versions: Optional[str] = None,
        name: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        resource_name: Optional[str] = None,
        subscription_id: Optional[str] = None,
        target_azure_id: Optional[str] = None,
        tenant_id: Optional[str] = None,
        use_gw_cloud_identity: Optional[bool] = None) -> TargetAzure
    func GetTargetAzure(ctx *Context, name string, id IDInput, state *TargetAzureState, opts ...ResourceOption) (*TargetAzure, error)
    public static TargetAzure Get(string name, Input<string> id, TargetAzureState? state, CustomResourceOptions? opts = null)
    public static TargetAzure get(String name, Output<String> id, TargetAzureState state, CustomResourceOptions options)
    resources:  _:    type: akeyless:TargetAzure    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:
    ClientId string
    Azure client/application id
    ClientSecret string
    Azure client secret
    ConnectionType string
    Type of connection [credentials/cloud-identity]
    Description string
    Description of the object
    KeepPrevVersion string
    Whether to keep previous version [true/false]. If not set, use default according to account settings
    Key string
    Key name. The key is used to encrypt the target secret value. If the key name is not specified, the account default protection key is used
    MaxVersions string
    Set the maximum number of versions, limited by the account settings defaults
    Name string
    Target name
    ResourceGroupName string
    The Resource Group name in your Azure subscription
    ResourceName string
    The name of the relevant Resource
    SubscriptionId string
    Azure Subscription Id
    TargetAzureId string
    The ID of this resource.
    TenantId string
    Azure tenant id
    UseGwCloudIdentity bool
    Use the GW's Cloud IAM
    ClientId string
    Azure client/application id
    ClientSecret string
    Azure client secret
    ConnectionType string
    Type of connection [credentials/cloud-identity]
    Description string
    Description of the object
    KeepPrevVersion string
    Whether to keep previous version [true/false]. If not set, use default according to account settings
    Key string
    Key name. The key is used to encrypt the target secret value. If the key name is not specified, the account default protection key is used
    MaxVersions string
    Set the maximum number of versions, limited by the account settings defaults
    Name string
    Target name
    ResourceGroupName string
    The Resource Group name in your Azure subscription
    ResourceName string
    The name of the relevant Resource
    SubscriptionId string
    Azure Subscription Id
    TargetAzureId string
    The ID of this resource.
    TenantId string
    Azure tenant id
    UseGwCloudIdentity bool
    Use the GW's Cloud IAM
    clientId String
    Azure client/application id
    clientSecret String
    Azure client secret
    connectionType String
    Type of connection [credentials/cloud-identity]
    description String
    Description of the object
    keepPrevVersion String
    Whether to keep previous version [true/false]. If not set, use default according to account settings
    key String
    Key name. The key is used to encrypt the target secret value. If the key name is not specified, the account default protection key is used
    maxVersions String
    Set the maximum number of versions, limited by the account settings defaults
    name String
    Target name
    resourceGroupName String
    The Resource Group name in your Azure subscription
    resourceName String
    The name of the relevant Resource
    subscriptionId String
    Azure Subscription Id
    targetAzureId String
    The ID of this resource.
    tenantId String
    Azure tenant id
    useGwCloudIdentity Boolean
    Use the GW's Cloud IAM
    clientId string
    Azure client/application id
    clientSecret string
    Azure client secret
    connectionType string
    Type of connection [credentials/cloud-identity]
    description string
    Description of the object
    keepPrevVersion string
    Whether to keep previous version [true/false]. If not set, use default according to account settings
    key string
    Key name. The key is used to encrypt the target secret value. If the key name is not specified, the account default protection key is used
    maxVersions string
    Set the maximum number of versions, limited by the account settings defaults
    name string
    Target name
    resourceGroupName string
    The Resource Group name in your Azure subscription
    resourceName string
    The name of the relevant Resource
    subscriptionId string
    Azure Subscription Id
    targetAzureId string
    The ID of this resource.
    tenantId string
    Azure tenant id
    useGwCloudIdentity boolean
    Use the GW's Cloud IAM
    client_id str
    Azure client/application id
    client_secret str
    Azure client secret
    connection_type str
    Type of connection [credentials/cloud-identity]
    description str
    Description of the object
    keep_prev_version str
    Whether to keep previous version [true/false]. If not set, use default according to account settings
    key str
    Key name. The key is used to encrypt the target secret value. If the key name is not specified, the account default protection key is used
    max_versions str
    Set the maximum number of versions, limited by the account settings defaults
    name str
    Target name
    resource_group_name str
    The Resource Group name in your Azure subscription
    resource_name str
    The name of the relevant Resource
    subscription_id str
    Azure Subscription Id
    target_azure_id str
    The ID of this resource.
    tenant_id str
    Azure tenant id
    use_gw_cloud_identity bool
    Use the GW's Cloud IAM
    clientId String
    Azure client/application id
    clientSecret String
    Azure client secret
    connectionType String
    Type of connection [credentials/cloud-identity]
    description String
    Description of the object
    keepPrevVersion String
    Whether to keep previous version [true/false]. If not set, use default according to account settings
    key String
    Key name. The key is used to encrypt the target secret value. If the key name is not specified, the account default protection key is used
    maxVersions String
    Set the maximum number of versions, limited by the account settings defaults
    name String
    Target name
    resourceGroupName String
    The Resource Group name in your Azure subscription
    resourceName String
    The name of the relevant Resource
    subscriptionId String
    Azure Subscription Id
    targetAzureId String
    The ID of this resource.
    tenantId String
    Azure tenant id
    useGwCloudIdentity Boolean
    Use the GW's Cloud IAM

    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.