1. Packages
  2. Azure Classic
  3. API Docs
  4. apimanagement
  5. WorkspaceNamedValue

We recommend using Azure Native.

Viewing docs for Azure v6.33.0
published on Monday, Feb 23, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-azure

azure.apimanagement.WorkspaceNamedValue

azure logo

We recommend using Azure Native.

Viewing docs for Azure v6.33.0
published on Monday, Feb 23, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-azure

    Manages an API Management Workspace Named Value.

    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 exampleService = new azure.apimanagement.Service("example", {
    name: "example-apim",
    location: example.location,
    resourceGroupName: example.name,
    publisherName: "My Company",
    publisherEmail: "company@terraform.io",
    skuName: "Premium_1",
});
const exampleWorkspace = new azure.apimanagement.Workspace("example", {
    name: "example-workspace",
    apiManagementId: exampleService.id,
    displayName: "ExampleWorkspace",
});
const exampleWorkspaceNamedValue = new azure.apimanagement.WorkspaceNamedValue("example", {
    name: "example-named-value",
    apiManagementWorkspaceId: exampleWorkspace.id,
    displayName: "ExampleProperty",
    value: "Example Value",
    tags: [
        "tag1",
        "tag2",
        "tag3",
    ],
});

    import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West Europe")
example_service = azure.apimanagement.Service("example",
    name="example-apim",
    location=example.location,
    resource_group_name=example.name,
    publisher_name="My Company",
    publisher_email="company@terraform.io",
    sku_name="Premium_1")
example_workspace = azure.apimanagement.Workspace("example",
    name="example-workspace",
    api_management_id=example_service.id,
    display_name="ExampleWorkspace")
example_workspace_named_value = azure.apimanagement.WorkspaceNamedValue("example",
    name="example-named-value",
    api_management_workspace_id=example_workspace.id,
    display_name="ExampleProperty",
    value="Example Value",
    tags=[
        "tag1",
        "tag2",
        "tag3",
    ])

    package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/apimanagement"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"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
		}
		exampleService, err := apimanagement.NewService(ctx, "example", &apimanagement.ServiceArgs{
			Name:              pulumi.String("example-apim"),
			Location:          example.Location,
			ResourceGroupName: example.Name,
			PublisherName:     pulumi.String("My Company"),
			PublisherEmail:    pulumi.String("company@terraform.io"),
			SkuName:           pulumi.String("Premium_1"),
		})
		if err != nil {
			return err
		}
		exampleWorkspace, err := apimanagement.NewWorkspace(ctx, "example", &apimanagement.WorkspaceArgs{
			Name:            pulumi.String("example-workspace"),
			ApiManagementId: exampleService.ID(),
			DisplayName:     pulumi.String("ExampleWorkspace"),
		})
		if err != nil {
			return err
		}
		_, err = apimanagement.NewWorkspaceNamedValue(ctx, "example", &apimanagement.WorkspaceNamedValueArgs{
			Name:                     pulumi.String("example-named-value"),
			ApiManagementWorkspaceId: exampleWorkspace.ID(),
			DisplayName:              pulumi.String("ExampleProperty"),
			Value:                    pulumi.String("Example Value"),
			Tags: pulumi.StringArray{
				pulumi.String("tag1"),
				pulumi.String("tag2"),
				pulumi.String("tag3"),
			},
		})
		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 exampleService = new Azure.ApiManagement.Service("example", new()
    {
        Name = "example-apim",
        Location = example.Location,
        ResourceGroupName = example.Name,
        PublisherName = "My Company",
        PublisherEmail = "company@terraform.io",
        SkuName = "Premium_1",
    });

    var exampleWorkspace = new Azure.ApiManagement.Workspace("example", new()
    {
        Name = "example-workspace",
        ApiManagementId = exampleService.Id,
        DisplayName = "ExampleWorkspace",
    });

    var exampleWorkspaceNamedValue = new Azure.ApiManagement.WorkspaceNamedValue("example", new()
    {
        Name = "example-named-value",
        ApiManagementWorkspaceId = exampleWorkspace.Id,
        DisplayName = "ExampleProperty",
        Value = "Example Value",
        Tags = new[]
        {
            "tag1",
            "tag2",
            "tag3",
        },
    });

});

    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.apimanagement.Service;
import com.pulumi.azure.apimanagement.ServiceArgs;
import com.pulumi.azure.apimanagement.Workspace;
import com.pulumi.azure.apimanagement.WorkspaceArgs;
import com.pulumi.azure.apimanagement.WorkspaceNamedValue;
import com.pulumi.azure.apimanagement.WorkspaceNamedValueArgs;
import java.util.List;
import java.util.ArrayList;
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 exampleService = new Service("exampleService", ServiceArgs.builder()
            .name("example-apim")
            .location(example.location())
            .resourceGroupName(example.name())
            .publisherName("My Company")
            .publisherEmail("company@terraform.io")
            .skuName("Premium_1")
            .build());

        var exampleWorkspace = new Workspace("exampleWorkspace", WorkspaceArgs.builder()
            .name("example-workspace")
            .apiManagementId(exampleService.id())
            .displayName("ExampleWorkspace")
            .build());

        var exampleWorkspaceNamedValue = new WorkspaceNamedValue("exampleWorkspaceNamedValue", WorkspaceNamedValueArgs.builder()
            .name("example-named-value")
            .apiManagementWorkspaceId(exampleWorkspace.id())
            .displayName("ExampleProperty")
            .value("Example Value")
            .tags(            
                "tag1",
                "tag2",
                "tag3")
            .build());

    }
}

    resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  exampleService:
    type: azure:apimanagement:Service
    name: example
    properties:
      name: example-apim
      location: ${example.location}
      resourceGroupName: ${example.name}
      publisherName: My Company
      publisherEmail: company@terraform.io
      skuName: Premium_1
  exampleWorkspace:
    type: azure:apimanagement:Workspace
    name: example
    properties:
      name: example-workspace
      apiManagementId: ${exampleService.id}
      displayName: ExampleWorkspace
  exampleWorkspaceNamedValue:
    type: azure:apimanagement:WorkspaceNamedValue
    name: example
    properties:
      name: example-named-value
      apiManagementWorkspaceId: ${exampleWorkspace.id}
      displayName: ExampleProperty
      value: Example Value
      tags:
        - tag1
        - tag2
        - tag3

    API Providers

    This resource uses the following Azure API Providers:

    • Microsoft.ApiManagement - 2024-05-01

    Create WorkspaceNamedValue Resource

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

    Constructor syntax

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

@overload
def WorkspaceNamedValue(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        api_management_workspace_id: Optional[str] = None,
                        display_name: Optional[str] = None,
                        name: Optional[str] = None,
                        secret: Optional[bool] = None,
                        tags: Optional[Sequence[str]] = None,
                        value: Optional[str] = None,
                        value_from_key_vault: Optional[WorkspaceNamedValueValueFromKeyVaultArgs] = None)
    func NewWorkspaceNamedValue(ctx *Context, name string, args WorkspaceNamedValueArgs, opts ...ResourceOption) (*WorkspaceNamedValue, error)
    public WorkspaceNamedValue(string name, WorkspaceNamedValueArgs args, CustomResourceOptions? opts = null)
    public WorkspaceNamedValue(String name, WorkspaceNamedValueArgs args)
public WorkspaceNamedValue(String name, WorkspaceNamedValueArgs args, CustomResourceOptions options)

    type: azure:apimanagement:WorkspaceNamedValue
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 WorkspaceNamedValueArgs
    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 WorkspaceNamedValueArgs
    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 WorkspaceNamedValueArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WorkspaceNamedValueArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WorkspaceNamedValueArgs
    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 workspaceNamedValueResource = new Azure.ApiManagement.WorkspaceNamedValue("workspaceNamedValueResource", new()
{
    ApiManagementWorkspaceId = "string",
    DisplayName = "string",
    Name = "string",
    Secret = false,
    Tags = new[]
    {
        "string",
    },
    Value = "string",
    ValueFromKeyVault = new Azure.ApiManagement.Inputs.WorkspaceNamedValueValueFromKeyVaultArgs
    {
        SecretId = "string",
        IdentityClientId = "string",
    },
});

    example, err := apimanagement.NewWorkspaceNamedValue(ctx, "workspaceNamedValueResource", &apimanagement.WorkspaceNamedValueArgs{
	ApiManagementWorkspaceId: pulumi.String("string"),
	DisplayName:              pulumi.String("string"),
	Name:                     pulumi.String("string"),
	Secret:                   pulumi.Bool(false),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
	Value: pulumi.String("string"),
	ValueFromKeyVault: &apimanagement.WorkspaceNamedValueValueFromKeyVaultArgs{
		SecretId:         pulumi.String("string"),
		IdentityClientId: pulumi.String("string"),
	},
})

    var workspaceNamedValueResource = new WorkspaceNamedValue("workspaceNamedValueResource", WorkspaceNamedValueArgs.builder()
    .apiManagementWorkspaceId("string")
    .displayName("string")
    .name("string")
    .secret(false)
    .tags("string")
    .value("string")
    .valueFromKeyVault(WorkspaceNamedValueValueFromKeyVaultArgs.builder()
        .secretId("string")
        .identityClientId("string")
        .build())
    .build());

    workspace_named_value_resource = azure.apimanagement.WorkspaceNamedValue("workspaceNamedValueResource",
    api_management_workspace_id="string",
    display_name="string",
    name="string",
    secret=False,
    tags=["string"],
    value="string",
    value_from_key_vault={
        "secret_id": "string",
        "identity_client_id": "string",
    })

    const workspaceNamedValueResource = new azure.apimanagement.WorkspaceNamedValue("workspaceNamedValueResource", {
    apiManagementWorkspaceId: "string",
    displayName: "string",
    name: "string",
    secret: false,
    tags: ["string"],
    value: "string",
    valueFromKeyVault: {
        secretId: "string",
        identityClientId: "string",
    },
});

    type: azure:apimanagement:WorkspaceNamedValue
properties:
    apiManagementWorkspaceId: string
    displayName: string
    name: string
    secret: false
    tags:
        - string
    value: string
    valueFromKeyVault:
        identityClientId: string
        secretId: string

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

    ApiManagementWorkspaceId string
    The ID of the API Management Workspace. Changing this forces a new resource to be created.
    DisplayName string
    The display name of this API Management Workspace Named Value.
    Name string
    The name of the API Management Workspace Named Value. Changing this forces a new resource to be created.
    Secret bool

    Specifies whether the API Management Workspace Named Value is secret. Defaults to false.

    Note: Setting the field secret to true does not make this field sensitive in Terraform, instead it marks the value as secret and encrypts the value in Azure.

    Tags List<string>
    A list of tags to be applied to the API Management Workspace Named Value.
    Value string

    The value of this API Management Workspace Named Value.

    Note: Exactly one of value or value_from_key_vault must be specified.

    ValueFromKeyVault WorkspaceNamedValueValueFromKeyVault

    A value_from_key_vault block as defined below.

    Note: Exactly one of value or value_from_key_vault must be specified. If value_from_key_vault is specified, secret must also be set to true.

    ApiManagementWorkspaceId string
    The ID of the API Management Workspace. Changing this forces a new resource to be created.
    DisplayName string
    The display name of this API Management Workspace Named Value.
    Name string
    The name of the API Management Workspace Named Value. Changing this forces a new resource to be created.
    Secret bool

    Specifies whether the API Management Workspace Named Value is secret. Defaults to false.

    Note: Setting the field secret to true does not make this field sensitive in Terraform, instead it marks the value as secret and encrypts the value in Azure.

    Tags []string
    A list of tags to be applied to the API Management Workspace Named Value.
    Value string

    The value of this API Management Workspace Named Value.

    Note: Exactly one of value or value_from_key_vault must be specified.

    ValueFromKeyVault WorkspaceNamedValueValueFromKeyVaultArgs

    A value_from_key_vault block as defined below.

    Note: Exactly one of value or value_from_key_vault must be specified. If value_from_key_vault is specified, secret must also be set to true.

    apiManagementWorkspaceId String
    The ID of the API Management Workspace. Changing this forces a new resource to be created.
    displayName String
    The display name of this API Management Workspace Named Value.
    name String
    The name of the API Management Workspace Named Value. Changing this forces a new resource to be created.
    secret Boolean

    Specifies whether the API Management Workspace Named Value is secret. Defaults to false.

    Note: Setting the field secret to true does not make this field sensitive in Terraform, instead it marks the value as secret and encrypts the value in Azure.

    tags List<String>
    A list of tags to be applied to the API Management Workspace Named Value.
    value String

    The value of this API Management Workspace Named Value.

    Note: Exactly one of value or value_from_key_vault must be specified.

    valueFromKeyVault WorkspaceNamedValueValueFromKeyVault

    A value_from_key_vault block as defined below.

    Note: Exactly one of value or value_from_key_vault must be specified. If value_from_key_vault is specified, secret must also be set to true.

    apiManagementWorkspaceId string
    The ID of the API Management Workspace. Changing this forces a new resource to be created.
    displayName string
    The display name of this API Management Workspace Named Value.
    name string
    The name of the API Management Workspace Named Value. Changing this forces a new resource to be created.
    secret boolean

    Specifies whether the API Management Workspace Named Value is secret. Defaults to false.

    Note: Setting the field secret to true does not make this field sensitive in Terraform, instead it marks the value as secret and encrypts the value in Azure.

    tags string[]
    A list of tags to be applied to the API Management Workspace Named Value.
    value string

    The value of this API Management Workspace Named Value.

    Note: Exactly one of value or value_from_key_vault must be specified.

    valueFromKeyVault WorkspaceNamedValueValueFromKeyVault

    A value_from_key_vault block as defined below.

    Note: Exactly one of value or value_from_key_vault must be specified. If value_from_key_vault is specified, secret must also be set to true.

    api_management_workspace_id str
    The ID of the API Management Workspace. Changing this forces a new resource to be created.
    display_name str
    The display name of this API Management Workspace Named Value.
    name str
    The name of the API Management Workspace Named Value. Changing this forces a new resource to be created.
    secret bool

    Specifies whether the API Management Workspace Named Value is secret. Defaults to false.

    Note: Setting the field secret to true does not make this field sensitive in Terraform, instead it marks the value as secret and encrypts the value in Azure.

    tags Sequence[str]
    A list of tags to be applied to the API Management Workspace Named Value.
    value str

    The value of this API Management Workspace Named Value.

    Note: Exactly one of value or value_from_key_vault must be specified.

    value_from_key_vault WorkspaceNamedValueValueFromKeyVaultArgs

    A value_from_key_vault block as defined below.

    Note: Exactly one of value or value_from_key_vault must be specified. If value_from_key_vault is specified, secret must also be set to true.

    apiManagementWorkspaceId String
    The ID of the API Management Workspace. Changing this forces a new resource to be created.
    displayName String
    The display name of this API Management Workspace Named Value.
    name String
    The name of the API Management Workspace Named Value. Changing this forces a new resource to be created.
    secret Boolean

    Specifies whether the API Management Workspace Named Value is secret. Defaults to false.

    Note: Setting the field secret to true does not make this field sensitive in Terraform, instead it marks the value as secret and encrypts the value in Azure.

    tags List<String>
    A list of tags to be applied to the API Management Workspace Named Value.
    value String

    The value of this API Management Workspace Named Value.

    Note: Exactly one of value or value_from_key_vault must be specified.

    valueFromKeyVault Property Map

    A value_from_key_vault block as defined below.

    Note: Exactly one of value or value_from_key_vault must be specified. If value_from_key_vault is specified, secret must also be set to true.

    Outputs

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

    Get an existing WorkspaceNamedValue 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?: WorkspaceNamedValueState, opts?: CustomResourceOptions): WorkspaceNamedValue
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api_management_workspace_id: Optional[str] = None,
        display_name: Optional[str] = None,
        name: Optional[str] = None,
        secret: Optional[bool] = None,
        tags: Optional[Sequence[str]] = None,
        value: Optional[str] = None,
        value_from_key_vault: Optional[WorkspaceNamedValueValueFromKeyVaultArgs] = None) -> WorkspaceNamedValue
    func GetWorkspaceNamedValue(ctx *Context, name string, id IDInput, state *WorkspaceNamedValueState, opts ...ResourceOption) (*WorkspaceNamedValue, error)
    public static WorkspaceNamedValue Get(string name, Input<string> id, WorkspaceNamedValueState? state, CustomResourceOptions? opts = null)
    public static WorkspaceNamedValue get(String name, Output<String> id, WorkspaceNamedValueState state, CustomResourceOptions options)
    resources:  _:    type: azure:apimanagement:WorkspaceNamedValue    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:
    ApiManagementWorkspaceId string
    The ID of the API Management Workspace. Changing this forces a new resource to be created.
    DisplayName string
    The display name of this API Management Workspace Named Value.
    Name string
    The name of the API Management Workspace Named Value. Changing this forces a new resource to be created.
    Secret bool

    Specifies whether the API Management Workspace Named Value is secret. Defaults to false.

    Note: Setting the field secret to true does not make this field sensitive in Terraform, instead it marks the value as secret and encrypts the value in Azure.

    Tags List<string>
    A list of tags to be applied to the API Management Workspace Named Value.
    Value string

    The value of this API Management Workspace Named Value.

    Note: Exactly one of value or value_from_key_vault must be specified.

    ValueFromKeyVault WorkspaceNamedValueValueFromKeyVault

    A value_from_key_vault block as defined below.

    Note: Exactly one of value or value_from_key_vault must be specified. If value_from_key_vault is specified, secret must also be set to true.

    ApiManagementWorkspaceId string
    The ID of the API Management Workspace. Changing this forces a new resource to be created.
    DisplayName string
    The display name of this API Management Workspace Named Value.
    Name string
    The name of the API Management Workspace Named Value. Changing this forces a new resource to be created.
    Secret bool

    Specifies whether the API Management Workspace Named Value is secret. Defaults to false.

    Note: Setting the field secret to true does not make this field sensitive in Terraform, instead it marks the value as secret and encrypts the value in Azure.

    Tags []string
    A list of tags to be applied to the API Management Workspace Named Value.
    Value string

    The value of this API Management Workspace Named Value.

    Note: Exactly one of value or value_from_key_vault must be specified.

    ValueFromKeyVault WorkspaceNamedValueValueFromKeyVaultArgs

    A value_from_key_vault block as defined below.

    Note: Exactly one of value or value_from_key_vault must be specified. If value_from_key_vault is specified, secret must also be set to true.

    apiManagementWorkspaceId String
    The ID of the API Management Workspace. Changing this forces a new resource to be created.
    displayName String
    The display name of this API Management Workspace Named Value.
    name String
    The name of the API Management Workspace Named Value. Changing this forces a new resource to be created.
    secret Boolean

    Specifies whether the API Management Workspace Named Value is secret. Defaults to false.

    Note: Setting the field secret to true does not make this field sensitive in Terraform, instead it marks the value as secret and encrypts the value in Azure.

    tags List<String>
    A list of tags to be applied to the API Management Workspace Named Value.
    value String

    The value of this API Management Workspace Named Value.

    Note: Exactly one of value or value_from_key_vault must be specified.

    valueFromKeyVault WorkspaceNamedValueValueFromKeyVault

    A value_from_key_vault block as defined below.

    Note: Exactly one of value or value_from_key_vault must be specified. If value_from_key_vault is specified, secret must also be set to true.

    apiManagementWorkspaceId string
    The ID of the API Management Workspace. Changing this forces a new resource to be created.
    displayName string
    The display name of this API Management Workspace Named Value.
    name string
    The name of the API Management Workspace Named Value. Changing this forces a new resource to be created.
    secret boolean

    Specifies whether the API Management Workspace Named Value is secret. Defaults to false.

    Note: Setting the field secret to true does not make this field sensitive in Terraform, instead it marks the value as secret and encrypts the value in Azure.

    tags string[]
    A list of tags to be applied to the API Management Workspace Named Value.
    value string

    The value of this API Management Workspace Named Value.

    Note: Exactly one of value or value_from_key_vault must be specified.

    valueFromKeyVault WorkspaceNamedValueValueFromKeyVault

    A value_from_key_vault block as defined below.

    Note: Exactly one of value or value_from_key_vault must be specified. If value_from_key_vault is specified, secret must also be set to true.

    api_management_workspace_id str
    The ID of the API Management Workspace. Changing this forces a new resource to be created.
    display_name str
    The display name of this API Management Workspace Named Value.
    name str
    The name of the API Management Workspace Named Value. Changing this forces a new resource to be created.
    secret bool

    Specifies whether the API Management Workspace Named Value is secret. Defaults to false.

    Note: Setting the field secret to true does not make this field sensitive in Terraform, instead it marks the value as secret and encrypts the value in Azure.

    tags Sequence[str]
    A list of tags to be applied to the API Management Workspace Named Value.
    value str

    The value of this API Management Workspace Named Value.

    Note: Exactly one of value or value_from_key_vault must be specified.

    value_from_key_vault WorkspaceNamedValueValueFromKeyVaultArgs

    A value_from_key_vault block as defined below.

    Note: Exactly one of value or value_from_key_vault must be specified. If value_from_key_vault is specified, secret must also be set to true.

    apiManagementWorkspaceId String
    The ID of the API Management Workspace. Changing this forces a new resource to be created.
    displayName String
    The display name of this API Management Workspace Named Value.
    name String
    The name of the API Management Workspace Named Value. Changing this forces a new resource to be created.
    secret Boolean

    Specifies whether the API Management Workspace Named Value is secret. Defaults to false.

    Note: Setting the field secret to true does not make this field sensitive in Terraform, instead it marks the value as secret and encrypts the value in Azure.

    tags List<String>
    A list of tags to be applied to the API Management Workspace Named Value.
    value String

    The value of this API Management Workspace Named Value.

    Note: Exactly one of value or value_from_key_vault must be specified.

    valueFromKeyVault Property Map

    A value_from_key_vault block as defined below.

    Note: Exactly one of value or value_from_key_vault must be specified. If value_from_key_vault is specified, secret must also be set to true.

    Supporting Types

    WorkspaceNamedValueValueFromKeyVault, WorkspaceNamedValueValueFromKeyVaultArgs

    SecretId string
    The resource ID of the Key Vault Secret.
    IdentityClientId string
    The client ID of the User Assigned Identity, for the API Management Service, which will be used to access the key vault secret. The System Assigned Identity will be used if not specified.
    SecretId string
    The resource ID of the Key Vault Secret.
    IdentityClientId string
    The client ID of the User Assigned Identity, for the API Management Service, which will be used to access the key vault secret. The System Assigned Identity will be used if not specified.
    secretId String
    The resource ID of the Key Vault Secret.
    identityClientId String
    The client ID of the User Assigned Identity, for the API Management Service, which will be used to access the key vault secret. The System Assigned Identity will be used if not specified.
    secretId string
    The resource ID of the Key Vault Secret.
    identityClientId string
    The client ID of the User Assigned Identity, for the API Management Service, which will be used to access the key vault secret. The System Assigned Identity will be used if not specified.
    secret_id str
    The resource ID of the Key Vault Secret.
    identity_client_id str
    The client ID of the User Assigned Identity, for the API Management Service, which will be used to access the key vault secret. The System Assigned Identity will be used if not specified.
    secretId String
    The resource ID of the Key Vault Secret.
    identityClientId String
    The client ID of the User Assigned Identity, for the API Management Service, which will be used to access the key vault secret. The System Assigned Identity will be used if not specified.

    Import

    API Management Workspace Named Values can be imported using the resource id, e.g.

    $ pulumi import azure:apimanagement/workspaceNamedValue:WorkspaceNamedValue example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.ApiManagement/service/service1/workspaces/workspace1/namedValues/namedValue1

    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.33.0
    published on Monday, Feb 23, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-azure
      Try Pulumi Cloud free. Your team will thank you.