Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Azure Classic
  4. API Docs
  5. cognitive
  6. AccountConnectionAccountKey

We recommend using Azure Native.

Viewing docs for Azure v6.40.0
published on Wednesday, Sep 2, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-azure

azure.cognitive.AccountConnectionAccountKey

azure logo

We recommend using Azure Native.

Viewing docs for Azure v6.40.0
published on Wednesday, Sep 2, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-azure

    Manages a Cognitive Services (Microsoft Foundry) Account Connection with Account Key authentication.

    Note: In the new Foundry portal experience, “Account Connections” are shown as “Tools” under the “Build” menu.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = new azure.core.ResourceGroup("example", {
    name: "example-resources",
    location: "West Europe",
});
const exampleAccount = new azure.cognitive.Account("example", {
    name: "example-aiservices",
    location: example.location,
    resourceGroupName: example.name,
    kind: "AIServices",
    skuName: "S0",
    projectManagementEnabled: true,
    customSubdomainName: "exampleaiservices",
    identity: {
        type: "SystemAssigned",
    },
});
const exampleAccount2 = new azure.storage.Account("example", {
    name: "examplestorageacct",
    resourceGroupName: example.name,
    location: example.location,
    accountTier: "Standard",
    accountReplicationType: "LRS",
});
const exampleAccountConnectionAccountKey = new azure.cognitive.AccountConnectionAccountKey("example", {
    name: "example-connection",
    cognitiveAccountId: exampleAccount.id,
    category: "AzureStorageAccount",
    target: exampleAccount2.primaryBlobEndpoint,
    accountKey: exampleAccount2.primaryAccessKey,
    metadata: {
        ApiType: "Azure",
        ResourceId: exampleAccount2.id,
        Location: exampleAccount2.location,
    },
});

    import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West Europe")
example_account = azure.cognitive.Account("example",
    name="example-aiservices",
    location=example.location,
    resource_group_name=example.name,
    kind="AIServices",
    sku_name="S0",
    project_management_enabled=True,
    custom_subdomain_name="exampleaiservices",
    identity={
        "type": "SystemAssigned",
    })
example_account2 = azure.storage.Account("example",
    name="examplestorageacct",
    resource_group_name=example.name,
    location=example.location,
    account_tier="Standard",
    account_replication_type="LRS")
example_account_connection_account_key = azure.cognitive.AccountConnectionAccountKey("example",
    name="example-connection",
    cognitive_account_id=example_account.id,
    category="AzureStorageAccount",
    target=example_account2.primary_blob_endpoint,
    account_key=example_account2.primary_access_key,
    metadata={
        "ApiType": "Azure",
        "ResourceId": example_account2.id,
        "Location": example_account2.location,
    })

    package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/cognitive"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/storage"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("example-resources"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleAccount, err := cognitive.NewAccount(ctx, "example", &cognitive.AccountArgs{
			Name:                     pulumi.String("example-aiservices"),
			Location:                 example.Location,
			ResourceGroupName:        example.Name,
			Kind:                     pulumi.String("AIServices"),
			SkuName:                  pulumi.String("S0"),
			ProjectManagementEnabled: pulumi.Bool(true),
			CustomSubdomainName:      pulumi.String("exampleaiservices"),
			Identity: &cognitive.AccountIdentityArgs{
				Type: pulumi.String("SystemAssigned"),
			},
		})
		if err != nil {
			return err
		}
		exampleAccount2, err := storage.NewAccount(ctx, "example", &storage.AccountArgs{
			Name:                   pulumi.String("examplestorageacct"),
			ResourceGroupName:      example.Name,
			Location:               example.Location,
			AccountTier:            pulumi.String("Standard"),
			AccountReplicationType: pulumi.String("LRS"),
		})
		if err != nil {
			return err
		}
		_, err = cognitive.NewAccountConnectionAccountKey(ctx, "example", &cognitive.AccountConnectionAccountKeyArgs{
			Name:               pulumi.String("example-connection"),
			CognitiveAccountId: exampleAccount.ID().ToIDOutput().ToStringOutput(),
			Category:           pulumi.String("AzureStorageAccount"),
			Target:             exampleAccount2.PrimaryBlobEndpoint,
			AccountKey:         exampleAccount2.PrimaryAccessKey,
			Metadata: pulumi.StringMap{
				"ApiType":    pulumi.String("Azure"),
				"ResourceId": exampleAccount2.ID().ToIDOutput().ToStringOutput(),
				"Location":   exampleAccount2.Location,
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "example-resources",
        Location = "West Europe",
    });

    var exampleAccount = new Azure.Cognitive.Account("example", new()
    {
        Name = "example-aiservices",
        Location = example.Location,
        ResourceGroupName = example.Name,
        Kind = "AIServices",
        SkuName = "S0",
        ProjectManagementEnabled = true,
        CustomSubdomainName = "exampleaiservices",
        Identity = new Azure.Cognitive.Inputs.AccountIdentityArgs
        {
            Type = "SystemAssigned",
        },
    });

    var exampleAccount2 = new Azure.Storage.Account("example", new()
    {
        Name = "examplestorageacct",
        ResourceGroupName = example.Name,
        Location = example.Location,
        AccountTier = "Standard",
        AccountReplicationType = "LRS",
    });

    var exampleAccountConnectionAccountKey = new Azure.Cognitive.AccountConnectionAccountKey("example", new()
    {
        Name = "example-connection",
        CognitiveAccountId = exampleAccount.Id,
        Category = "AzureStorageAccount",
        Target = exampleAccount2.PrimaryBlobEndpoint,
        AccountKey = exampleAccount2.PrimaryAccessKey,
        Metadata = 
        {
            { "ApiType", "Azure" },
            { "ResourceId", exampleAccount2.Id },
            { "Location", exampleAccount2.Location },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.cognitive.inputs.AccountIdentityArgs;
import com.pulumi.azure.cognitive.AccountConnectionAccountKey;
import com.pulumi.azure.cognitive.AccountConnectionAccountKeyArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("example-resources")
            .location("West Europe")
            .build());

        var exampleAccount = new com.pulumi.azure.cognitive.Account("exampleAccount", com.pulumi.azure.cognitive.AccountArgs.builder()
            .name("example-aiservices")
            .location(example.location())
            .resourceGroupName(example.name())
            .kind("AIServices")
            .skuName("S0")
            .projectManagementEnabled(true)
            .customSubdomainName("exampleaiservices")
            .identity(AccountIdentityArgs.builder()
                .type("SystemAssigned")
                .build())
            .build());

        var exampleAccount2 = new com.pulumi.azure.storage.Account("exampleAccount2", com.pulumi.azure.storage.AccountArgs.builder()
            .name("examplestorageacct")
            .resourceGroupName(example.name())
            .location(example.location())
            .accountTier("Standard")
            .accountReplicationType("LRS")
            .build());

        var exampleAccountConnectionAccountKey = new AccountConnectionAccountKey("exampleAccountConnectionAccountKey", AccountConnectionAccountKeyArgs.builder()
            .name("example-connection")
            .cognitiveAccountId(exampleAccount.id())
            .category("AzureStorageAccount")
            .target(exampleAccount2.primaryBlobEndpoint())
            .accountKey(exampleAccount2.primaryAccessKey())
            .metadata(Map.ofEntries(
                Map.entry("ApiType", "Azure"),
                Map.entry("ResourceId", exampleAccount2.id()),
                Map.entry("Location", exampleAccount2.location())
            ))
            .build());

    }
}

    resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  exampleAccount:
    type: azure:cognitive:Account
    name: example
    properties:
      name: example-aiservices
      location: ${example.location}
      resourceGroupName: ${example.name}
      kind: AIServices
      skuName: S0
      projectManagementEnabled: true
      customSubdomainName: exampleaiservices
      identity:
        type: SystemAssigned
  exampleAccount2:
    type: azure:storage:Account
    name: example
    properties:
      name: examplestorageacct
      resourceGroupName: ${example.name}
      location: ${example.location}
      accountTier: Standard
      accountReplicationType: LRS
  exampleAccountConnectionAccountKey:
    type: azure:cognitive:AccountConnectionAccountKey
    name: example
    properties:
      name: example-connection
      cognitiveAccountId: ${exampleAccount.id}
      category: AzureStorageAccount
      target: ${exampleAccount2.primaryBlobEndpoint}
      accountKey: ${exampleAccount2.primaryAccessKey}
      metadata:
        ApiType: Azure
        ResourceId: ${exampleAccount2.id}
        Location: ${exampleAccount2.location}

    pulumi {
  required_providers {
    azure = {
      source = "pulumi/azure"
    }
  }
}

resource "azure_core_resourcegroup" "example" {
  name     = "example-resources"
  location = "West Europe"
}
resource "azure_cognitive_account" "example" {
  name                       = "example-aiservices"
  location                   = azure_core_resourcegroup.example.location
  resource_group_name        = azure_core_resourcegroup.example.name
  kind                       = "AIServices"
  sku_name                   = "S0"
  project_management_enabled = true
  custom_subdomain_name      = "exampleaiservices"
  identity = {
    type = "SystemAssigned"
  }
}
resource "azure_storage_account" "example" {
  name                     = "examplestorageacct"
  resource_group_name      = azure_core_resourcegroup.example.name
  location                 = azure_core_resourcegroup.example.location
  account_tier             = "Standard"
  account_replication_type = "LRS"
}
resource "azure_cognitive_accountconnectionaccountkey" "example" {
  name                 = "example-connection"
  cognitive_account_id = azure_cognitive_account.example.id
  category             = "AzureStorageAccount"
  target               = azure_storage_account.example.primary_blob_endpoint
  account_key          = azure_storage_account.example.primary_access_key
  metadata = {
    "ApiType"    = "Azure"
    "ResourceId" = azure_storage_account.example.id
    "Location"   = azure_storage_account.example.location
  }
}

    API Providers

    This resource uses the following Azure API Providers:

    • Microsoft.CognitiveServices - 2026-03-01

    Create AccountConnectionAccountKey Resource

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

    Constructor syntax

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

@overload
def AccountConnectionAccountKey(resource_name: str,
                                opts: Optional[ResourceOptions] = None,
                                account_key: Optional[str] = None,
                                category: Optional[str] = None,
                                cognitive_account_id: Optional[str] = None,
                                metadata: Optional[Mapping[str, str]] = None,
                                target: Optional[str] = None,
                                name: Optional[str] = None)
    func NewAccountConnectionAccountKey(ctx *Context, name string, args AccountConnectionAccountKeyArgs, opts ...ResourceOption) (*AccountConnectionAccountKey, error)
    public AccountConnectionAccountKey(string name, AccountConnectionAccountKeyArgs args, CustomResourceOptions? opts = null)
    public AccountConnectionAccountKey(String name, AccountConnectionAccountKeyArgs args)
public AccountConnectionAccountKey(String name, AccountConnectionAccountKeyArgs args, CustomResourceOptions options)

    type: azure:cognitive:AccountConnectionAccountKey
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "azure_cognitive_account_connection_account_key" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args AccountConnectionAccountKeyArgs
    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 AccountConnectionAccountKeyArgs
    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 AccountConnectionAccountKeyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AccountConnectionAccountKeyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AccountConnectionAccountKeyArgs
    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 accountConnectionAccountKeyResource = new Azure.Cognitive.AccountConnectionAccountKey("accountConnectionAccountKeyResource", new()
{
    AccountKey = "string",
    Category = "string",
    CognitiveAccountId = "string",
    Metadata = 
    {
        { "string", "string" },
    },
    Target = "string",
    Name = "string",
});

    example, err := cognitive.NewAccountConnectionAccountKey(ctx, "accountConnectionAccountKeyResource", &cognitive.AccountConnectionAccountKeyArgs{
	AccountKey:         pulumi.String("string"),
	Category:           pulumi.String("string"),
	CognitiveAccountId: pulumi.String("string"),
	Metadata: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Target: pulumi.String("string"),
	Name:   pulumi.String("string"),
})

    resource "azure_cognitive_account_connection_account_key" "accountConnectionAccountKeyResource" {
  lifecycle {
    create_before_destroy = true
  }
  account_key          = "string"
  category             = "string"
  cognitive_account_id = "string"
  metadata = {
    "string" = "string"
  }
  target = "string"
  name   = "string"
}

    var accountConnectionAccountKeyResource = new AccountConnectionAccountKey("accountConnectionAccountKeyResource", AccountConnectionAccountKeyArgs.builder()
    .accountKey("string")
    .category("string")
    .cognitiveAccountId("string")
    .metadata(Map.of("string", "string"))
    .target("string")
    .name("string")
    .build());

    account_connection_account_key_resource = azure.cognitive.AccountConnectionAccountKey("accountConnectionAccountKeyResource",
    account_key="string",
    category="string",
    cognitive_account_id="string",
    metadata={
        "string": "string",
    },
    target="string",
    name="string")

    const accountConnectionAccountKeyResource = new azure.cognitive.AccountConnectionAccountKey("accountConnectionAccountKeyResource", {
    accountKey: "string",
    category: "string",
    cognitiveAccountId: "string",
    metadata: {
        string: "string",
    },
    target: "string",
    name: "string",
});

    type: azure:cognitive:AccountConnectionAccountKey
properties:
    accountKey: string
    category: string
    cognitiveAccountId: string
    metadata:
        string: string
    name: string
    target: string

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

    AccountKey string
    The account key used for authentication.
    Category string
    The category of the connection. The only possible value is AzureStorageAccount. Changing this forces a new resource to be created.
    CognitiveAccountId string
    The ID of the Cognitive Services Account. Changing this forces a new resource to be created.
    Metadata Dictionary<string, string>

    A mapping of metadata key-value pairs for the connection.

    Note: The metadata map must include ResourceId when category is AzureStorageAccount. To check any additional metadata returned by Azure, create an equivalent connection in the Foundry portal and inspect it with az rest --method get --url "{connection_resource_id}?api-version=2026-03-01".

    Target string

    The target endpoint or resource for the connection.

    Note: target must be an absolute HTTPS URL when category is AzureStorageAccount.

    Name string
    The name of the Cognitive Services Account Connection. Changing this forces a new resource to be created.
    AccountKey string
    The account key used for authentication.
    Category string
    The category of the connection. The only possible value is AzureStorageAccount. Changing this forces a new resource to be created.
    CognitiveAccountId string
    The ID of the Cognitive Services Account. Changing this forces a new resource to be created.
    Metadata map[string]string

    A mapping of metadata key-value pairs for the connection.

    Note: The metadata map must include ResourceId when category is AzureStorageAccount. To check any additional metadata returned by Azure, create an equivalent connection in the Foundry portal and inspect it with az rest --method get --url "{connection_resource_id}?api-version=2026-03-01".

    Target string

    The target endpoint or resource for the connection.

    Note: target must be an absolute HTTPS URL when category is AzureStorageAccount.

    Name string
    The name of the Cognitive Services Account Connection. Changing this forces a new resource to be created.
    account_key string
    The account key used for authentication.
    category string
    The category of the connection. The only possible value is AzureStorageAccount. Changing this forces a new resource to be created.
    cognitive_account_id string
    The ID of the Cognitive Services Account. Changing this forces a new resource to be created.
    metadata map(string)

    A mapping of metadata key-value pairs for the connection.

    Note: The metadata map must include ResourceId when category is AzureStorageAccount. To check any additional metadata returned by Azure, create an equivalent connection in the Foundry portal and inspect it with az rest --method get --url "{connection_resource_id}?api-version=2026-03-01".

    target string

    The target endpoint or resource for the connection.

    Note: target must be an absolute HTTPS URL when category is AzureStorageAccount.

    name string
    The name of the Cognitive Services Account Connection. Changing this forces a new resource to be created.
    accountKey String
    The account key used for authentication.
    category String
    The category of the connection. The only possible value is AzureStorageAccount. Changing this forces a new resource to be created.
    cognitiveAccountId String
    The ID of the Cognitive Services Account. Changing this forces a new resource to be created.
    metadata Map<String,String>

    A mapping of metadata key-value pairs for the connection.

    Note: The metadata map must include ResourceId when category is AzureStorageAccount. To check any additional metadata returned by Azure, create an equivalent connection in the Foundry portal and inspect it with az rest --method get --url "{connection_resource_id}?api-version=2026-03-01".

    target String

    The target endpoint or resource for the connection.

    Note: target must be an absolute HTTPS URL when category is AzureStorageAccount.

    name String
    The name of the Cognitive Services Account Connection. Changing this forces a new resource to be created.
    accountKey string
    The account key used for authentication.
    category string
    The category of the connection. The only possible value is AzureStorageAccount. Changing this forces a new resource to be created.
    cognitiveAccountId string
    The ID of the Cognitive Services Account. Changing this forces a new resource to be created.
    metadata {[key: string]: string}

    A mapping of metadata key-value pairs for the connection.

    Note: The metadata map must include ResourceId when category is AzureStorageAccount. To check any additional metadata returned by Azure, create an equivalent connection in the Foundry portal and inspect it with az rest --method get --url "{connection_resource_id}?api-version=2026-03-01".

    target string

    The target endpoint or resource for the connection.

    Note: target must be an absolute HTTPS URL when category is AzureStorageAccount.

    name string
    The name of the Cognitive Services Account Connection. Changing this forces a new resource to be created.
    account_key str
    The account key used for authentication.
    category str
    The category of the connection. The only possible value is AzureStorageAccount. Changing this forces a new resource to be created.
    cognitive_account_id str
    The ID of the Cognitive Services Account. Changing this forces a new resource to be created.
    metadata Mapping[str, str]

    A mapping of metadata key-value pairs for the connection.

    Note: The metadata map must include ResourceId when category is AzureStorageAccount. To check any additional metadata returned by Azure, create an equivalent connection in the Foundry portal and inspect it with az rest --method get --url "{connection_resource_id}?api-version=2026-03-01".

    target str

    The target endpoint or resource for the connection.

    Note: target must be an absolute HTTPS URL when category is AzureStorageAccount.

    name str
    The name of the Cognitive Services Account Connection. Changing this forces a new resource to be created.
    accountKey String
    The account key used for authentication.
    category String
    The category of the connection. The only possible value is AzureStorageAccount. Changing this forces a new resource to be created.
    cognitiveAccountId String
    The ID of the Cognitive Services Account. Changing this forces a new resource to be created.
    metadata Map<String>

    A mapping of metadata key-value pairs for the connection.

    Note: The metadata map must include ResourceId when category is AzureStorageAccount. To check any additional metadata returned by Azure, create an equivalent connection in the Foundry portal and inspect it with az rest --method get --url "{connection_resource_id}?api-version=2026-03-01".

    target String

    The target endpoint or resource for the connection.

    Note: target must be an absolute HTTPS URL when category is AzureStorageAccount.

    name String
    The name of the Cognitive Services Account Connection. Changing this forces a new resource to be created.

    Outputs

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

    Get an existing AccountConnectionAccountKey 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?: AccountConnectionAccountKeyState, opts?: CustomResourceOptions): AccountConnectionAccountKey
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_key: Optional[str] = None,
        category: Optional[str] = None,
        cognitive_account_id: Optional[str] = None,
        metadata: Optional[Mapping[str, str]] = None,
        name: Optional[str] = None,
        target: Optional[str] = None) -> AccountConnectionAccountKey
    func GetAccountConnectionAccountKey(ctx *Context, name string, id IDInput, state *AccountConnectionAccountKeyState, opts ...ResourceOption) (*AccountConnectionAccountKey, error)
    public static AccountConnectionAccountKey Get(string name, Input<string> id, AccountConnectionAccountKeyState? state, CustomResourceOptions? opts = null)
    public static AccountConnectionAccountKey get(String name, Output<String> id, AccountConnectionAccountKeyState state, CustomResourceOptions options)
    resources:  _:    type: azure:cognitive:AccountConnectionAccountKey    get:      id: ${id}
    import {
  to = azure_cognitive_account_connection_account_key.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:
    AccountKey string
    The account key used for authentication.
    Category string
    The category of the connection. The only possible value is AzureStorageAccount. Changing this forces a new resource to be created.
    CognitiveAccountId string
    The ID of the Cognitive Services Account. Changing this forces a new resource to be created.
    Metadata Dictionary<string, string>

    A mapping of metadata key-value pairs for the connection.

    Note: The metadata map must include ResourceId when category is AzureStorageAccount. To check any additional metadata returned by Azure, create an equivalent connection in the Foundry portal and inspect it with az rest --method get --url "{connection_resource_id}?api-version=2026-03-01".

    Name string
    The name of the Cognitive Services Account Connection. Changing this forces a new resource to be created.
    Target string

    The target endpoint or resource for the connection.

    Note: target must be an absolute HTTPS URL when category is AzureStorageAccount.

    AccountKey string
    The account key used for authentication.
    Category string
    The category of the connection. The only possible value is AzureStorageAccount. Changing this forces a new resource to be created.
    CognitiveAccountId string
    The ID of the Cognitive Services Account. Changing this forces a new resource to be created.
    Metadata map[string]string

    A mapping of metadata key-value pairs for the connection.

    Note: The metadata map must include ResourceId when category is AzureStorageAccount. To check any additional metadata returned by Azure, create an equivalent connection in the Foundry portal and inspect it with az rest --method get --url "{connection_resource_id}?api-version=2026-03-01".

    Name string
    The name of the Cognitive Services Account Connection. Changing this forces a new resource to be created.
    Target string

    The target endpoint or resource for the connection.

    Note: target must be an absolute HTTPS URL when category is AzureStorageAccount.

    account_key string
    The account key used for authentication.
    category string
    The category of the connection. The only possible value is AzureStorageAccount. Changing this forces a new resource to be created.
    cognitive_account_id string
    The ID of the Cognitive Services Account. Changing this forces a new resource to be created.
    metadata map(string)

    A mapping of metadata key-value pairs for the connection.

    Note: The metadata map must include ResourceId when category is AzureStorageAccount. To check any additional metadata returned by Azure, create an equivalent connection in the Foundry portal and inspect it with az rest --method get --url "{connection_resource_id}?api-version=2026-03-01".

    name string
    The name of the Cognitive Services Account Connection. Changing this forces a new resource to be created.
    target string

    The target endpoint or resource for the connection.

    Note: target must be an absolute HTTPS URL when category is AzureStorageAccount.

    accountKey String
    The account key used for authentication.
    category String
    The category of the connection. The only possible value is AzureStorageAccount. Changing this forces a new resource to be created.
    cognitiveAccountId String
    The ID of the Cognitive Services Account. Changing this forces a new resource to be created.
    metadata Map<String,String>

    A mapping of metadata key-value pairs for the connection.

    Note: The metadata map must include ResourceId when category is AzureStorageAccount. To check any additional metadata returned by Azure, create an equivalent connection in the Foundry portal and inspect it with az rest --method get --url "{connection_resource_id}?api-version=2026-03-01".

    name String
    The name of the Cognitive Services Account Connection. Changing this forces a new resource to be created.
    target String

    The target endpoint or resource for the connection.

    Note: target must be an absolute HTTPS URL when category is AzureStorageAccount.

    accountKey string
    The account key used for authentication.
    category string
    The category of the connection. The only possible value is AzureStorageAccount. Changing this forces a new resource to be created.
    cognitiveAccountId string
    The ID of the Cognitive Services Account. Changing this forces a new resource to be created.
    metadata {[key: string]: string}

    A mapping of metadata key-value pairs for the connection.

    Note: The metadata map must include ResourceId when category is AzureStorageAccount. To check any additional metadata returned by Azure, create an equivalent connection in the Foundry portal and inspect it with az rest --method get --url "{connection_resource_id}?api-version=2026-03-01".

    name string
    The name of the Cognitive Services Account Connection. Changing this forces a new resource to be created.
    target string

    The target endpoint or resource for the connection.

    Note: target must be an absolute HTTPS URL when category is AzureStorageAccount.

    account_key str
    The account key used for authentication.
    category str
    The category of the connection. The only possible value is AzureStorageAccount. Changing this forces a new resource to be created.
    cognitive_account_id str
    The ID of the Cognitive Services Account. Changing this forces a new resource to be created.
    metadata Mapping[str, str]

    A mapping of metadata key-value pairs for the connection.

    Note: The metadata map must include ResourceId when category is AzureStorageAccount. To check any additional metadata returned by Azure, create an equivalent connection in the Foundry portal and inspect it with az rest --method get --url "{connection_resource_id}?api-version=2026-03-01".

    name str
    The name of the Cognitive Services Account Connection. Changing this forces a new resource to be created.
    target str

    The target endpoint or resource for the connection.

    Note: target must be an absolute HTTPS URL when category is AzureStorageAccount.

    accountKey String
    The account key used for authentication.
    category String
    The category of the connection. The only possible value is AzureStorageAccount. Changing this forces a new resource to be created.
    cognitiveAccountId String
    The ID of the Cognitive Services Account. Changing this forces a new resource to be created.
    metadata Map<String>

    A mapping of metadata key-value pairs for the connection.

    Note: The metadata map must include ResourceId when category is AzureStorageAccount. To check any additional metadata returned by Azure, create an equivalent connection in the Foundry portal and inspect it with az rest --method get --url "{connection_resource_id}?api-version=2026-03-01".

    name String
    The name of the Cognitive Services Account Connection. Changing this forces a new resource to be created.
    target String

    The target endpoint or resource for the connection.

    Note: target must be an absolute HTTPS URL when category is AzureStorageAccount.

    Import

    A Cognitive Services (Microsoft Foundry) Account Connection with Account Key authentication can be imported using the resource id, e.g.

    $ pulumi import azure:cognitive/accountConnectionAccountKey:AccountConnectionAccountKey example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup1/providers/Microsoft.CognitiveServices/accounts/account1/connections/connection1

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Viewing docs for Azure v6.40.0
    published on Wednesday, Sep 2, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-azure

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial