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

We recommend using Azure Native.

Azure Classic v5.57.0 published on Tuesday, Nov 28, 2023 by Pulumi
pulumi/pulumi-azure

azure.apimanagement.NamedValue

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.57.0 published on Tuesday, Nov 28, 2023 by Pulumi
pulumi/pulumi-azure

    Manages an API Management Named Value.

    Example Usage

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

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

    var exampleService = new Azure.ApiManagement.Service("exampleService", new()
    {
        Location = exampleResourceGroup.Location,
        ResourceGroupName = exampleResourceGroup.Name,
        PublisherName = "pub1",
        PublisherEmail = "pub1@email.com",
        SkuName = "Developer_1",
    });

    var exampleNamedValue = new Azure.ApiManagement.NamedValue("exampleNamedValue", new()
    {
        ResourceGroupName = exampleResourceGroup.Name,
        ApiManagementName = exampleService.Name,
        DisplayName = "ExampleProperty",
        Value = "Example Value",
    });

});

    package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/apimanagement"
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleService, err := apimanagement.NewService(ctx, "exampleService", &apimanagement.ServiceArgs{
			Location:          exampleResourceGroup.Location,
			ResourceGroupName: exampleResourceGroup.Name,
			PublisherName:     pulumi.String("pub1"),
			PublisherEmail:    pulumi.String("pub1@email.com"),
			SkuName:           pulumi.String("Developer_1"),
		})
		if err != nil {
			return err
		}
		_, err = apimanagement.NewNamedValue(ctx, "exampleNamedValue", &apimanagement.NamedValueArgs{
			ResourceGroupName: exampleResourceGroup.Name,
			ApiManagementName: exampleService.Name,
			DisplayName:       pulumi.String("ExampleProperty"),
			Value:             pulumi.String("Example Value"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    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.NamedValue;
import com.pulumi.azure.apimanagement.NamedValueArgs;
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 exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()        
            .location("West Europe")
            .build());

        var exampleService = new Service("exampleService", ServiceArgs.builder()        
            .location(exampleResourceGroup.location())
            .resourceGroupName(exampleResourceGroup.name())
            .publisherName("pub1")
            .publisherEmail("pub1@email.com")
            .skuName("Developer_1")
            .build());

        var exampleNamedValue = new NamedValue("exampleNamedValue", NamedValueArgs.builder()        
            .resourceGroupName(exampleResourceGroup.name())
            .apiManagementName(exampleService.name())
            .displayName("ExampleProperty")
            .value("Example Value")
            .build());

    }
}

    import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_service = azure.apimanagement.Service("exampleService",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    publisher_name="pub1",
    publisher_email="pub1@email.com",
    sku_name="Developer_1")
example_named_value = azure.apimanagement.NamedValue("exampleNamedValue",
    resource_group_name=example_resource_group.name,
    api_management_name=example_service.name,
    display_name="ExampleProperty",
    value="Example Value")

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

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleService = new azure.apimanagement.Service("exampleService", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    publisherName: "pub1",
    publisherEmail: "pub1@email.com",
    skuName: "Developer_1",
});
const exampleNamedValue = new azure.apimanagement.NamedValue("exampleNamedValue", {
    resourceGroupName: exampleResourceGroup.name,
    apiManagementName: exampleService.name,
    displayName: "ExampleProperty",
    value: "Example Value",
});

    resources:
  exampleResourceGroup:
    type: azure:core:ResourceGroup
    properties:
      location: West Europe
  exampleService:
    type: azure:apimanagement:Service
    properties:
      location: ${exampleResourceGroup.location}
      resourceGroupName: ${exampleResourceGroup.name}
      publisherName: pub1
      publisherEmail: pub1@email.com
      skuName: Developer_1
  exampleNamedValue:
    type: azure:apimanagement:NamedValue
    properties:
      resourceGroupName: ${exampleResourceGroup.name}
      apiManagementName: ${exampleService.name}
      displayName: ExampleProperty
      value: Example Value

    Create NamedValue Resource

    new NamedValue(name: string, args: NamedValueArgs, opts?: CustomResourceOptions);
    @overload
def NamedValue(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               api_management_name: Optional[str] = None,
               display_name: Optional[str] = None,
               name: Optional[str] = None,
               resource_group_name: Optional[str] = None,
               secret: Optional[bool] = None,
               tags: Optional[Sequence[str]] = None,
               value: Optional[str] = None,
               value_from_key_vault: Optional[NamedValueValueFromKeyVaultArgs] = None)
@overload
def NamedValue(resource_name: str,
               args: NamedValueArgs,
               opts: Optional[ResourceOptions] = None)
    func NewNamedValue(ctx *Context, name string, args NamedValueArgs, opts ...ResourceOption) (*NamedValue, error)
    public NamedValue(string name, NamedValueArgs args, CustomResourceOptions? opts = null)
    public NamedValue(String name, NamedValueArgs args)
public NamedValue(String name, NamedValueArgs args, CustomResourceOptions options)

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

    NamedValue Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The NamedValue resource accepts the following input properties:

    ApiManagementName string

    The name of the API Management Service in which the API Management Named Value should exist. Changing this forces a new resource to be created.

    DisplayName string

    The display name of this API Management Named Value.

    ResourceGroupName string

    The name of the Resource Group in which the API Management Named Value should exist. Changing this forces a new resource to be created.

    Name string

    The name of the API Management Named Value. Changing this forces a new resource to be created.

    Secret bool

    Specifies whether the API Management Named Value is secret. Valid values are true or false. The default value is false.

    NOTE: setting the field secret to true doesn't make this field sensitive in the provider, 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 Named Value.

    Value string

    The value of this API Management Named Value.

    ValueFromKeyVault NamedValueValueFromKeyVault

    A value_from_key_vault block as defined below.

    ApiManagementName string

    The name of the API Management Service in which the API Management Named Value should exist. Changing this forces a new resource to be created.

    DisplayName string

    The display name of this API Management Named Value.

    ResourceGroupName string

    The name of the Resource Group in which the API Management Named Value should exist. Changing this forces a new resource to be created.

    Name string

    The name of the API Management Named Value. Changing this forces a new resource to be created.

    Secret bool

    Specifies whether the API Management Named Value is secret. Valid values are true or false. The default value is false.

    NOTE: setting the field secret to true doesn't make this field sensitive in the provider, 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 Named Value.

    Value string

    The value of this API Management Named Value.

    ValueFromKeyVault NamedValueValueFromKeyVaultArgs

    A value_from_key_vault block as defined below.

    apiManagementName String

    The name of the API Management Service in which the API Management Named Value should exist. Changing this forces a new resource to be created.

    displayName String

    The display name of this API Management Named Value.

    resourceGroupName String

    The name of the Resource Group in which the API Management Named Value should exist. Changing this forces a new resource to be created.

    name String

    The name of the API Management Named Value. Changing this forces a new resource to be created.

    secret Boolean

    Specifies whether the API Management Named Value is secret. Valid values are true or false. The default value is false.

    NOTE: setting the field secret to true doesn't make this field sensitive in the provider, 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 Named Value.

    value String

    The value of this API Management Named Value.

    valueFromKeyVault NamedValueValueFromKeyVault

    A value_from_key_vault block as defined below.

    apiManagementName string

    The name of the API Management Service in which the API Management Named Value should exist. Changing this forces a new resource to be created.

    displayName string

    The display name of this API Management Named Value.

    resourceGroupName string

    The name of the Resource Group in which the API Management Named Value should exist. Changing this forces a new resource to be created.

    name string

    The name of the API Management Named Value. Changing this forces a new resource to be created.

    secret boolean

    Specifies whether the API Management Named Value is secret. Valid values are true or false. The default value is false.

    NOTE: setting the field secret to true doesn't make this field sensitive in the provider, 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 Named Value.

    value string

    The value of this API Management Named Value.

    valueFromKeyVault NamedValueValueFromKeyVault

    A value_from_key_vault block as defined below.

    api_management_name str

    The name of the API Management Service in which the API Management Named Value should exist. Changing this forces a new resource to be created.

    display_name str

    The display name of this API Management Named Value.

    resource_group_name str

    The name of the Resource Group in which the API Management Named Value should exist. Changing this forces a new resource to be created.

    name str

    The name of the API Management Named Value. Changing this forces a new resource to be created.

    secret bool

    Specifies whether the API Management Named Value is secret. Valid values are true or false. The default value is false.

    NOTE: setting the field secret to true doesn't make this field sensitive in the provider, 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 Named Value.

    value str

    The value of this API Management Named Value.

    value_from_key_vault NamedValueValueFromKeyVaultArgs

    A value_from_key_vault block as defined below.

    apiManagementName String

    The name of the API Management Service in which the API Management Named Value should exist. Changing this forces a new resource to be created.

    displayName String

    The display name of this API Management Named Value.

    resourceGroupName String

    The name of the Resource Group in which the API Management Named Value should exist. Changing this forces a new resource to be created.

    name String

    The name of the API Management Named Value. Changing this forces a new resource to be created.

    secret Boolean

    Specifies whether the API Management Named Value is secret. Valid values are true or false. The default value is false.

    NOTE: setting the field secret to true doesn't make this field sensitive in the provider, 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 Named Value.

    value String

    The value of this API Management Named Value.

    valueFromKeyVault Property Map

    A value_from_key_vault block as defined below.

    Outputs

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

    Get an existing NamedValue 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?: NamedValueState, opts?: CustomResourceOptions): NamedValue
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api_management_name: Optional[str] = None,
        display_name: Optional[str] = None,
        name: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        secret: Optional[bool] = None,
        tags: Optional[Sequence[str]] = None,
        value: Optional[str] = None,
        value_from_key_vault: Optional[NamedValueValueFromKeyVaultArgs] = None) -> NamedValue
    func GetNamedValue(ctx *Context, name string, id IDInput, state *NamedValueState, opts ...ResourceOption) (*NamedValue, error)
    public static NamedValue Get(string name, Input<string> id, NamedValueState? state, CustomResourceOptions? opts = null)
    public static NamedValue get(String name, Output<String> id, NamedValueState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    ApiManagementName string

    The name of the API Management Service in which the API Management Named Value should exist. Changing this forces a new resource to be created.

    DisplayName string

    The display name of this API Management Named Value.

    Name string

    The name of the API Management Named Value. Changing this forces a new resource to be created.

    ResourceGroupName string

    The name of the Resource Group in which the API Management Named Value should exist. Changing this forces a new resource to be created.

    Secret bool

    Specifies whether the API Management Named Value is secret. Valid values are true or false. The default value is false.

    NOTE: setting the field secret to true doesn't make this field sensitive in the provider, 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 Named Value.

    Value string

    The value of this API Management Named Value.

    ValueFromKeyVault NamedValueValueFromKeyVault

    A value_from_key_vault block as defined below.

    ApiManagementName string

    The name of the API Management Service in which the API Management Named Value should exist. Changing this forces a new resource to be created.

    DisplayName string

    The display name of this API Management Named Value.

    Name string

    The name of the API Management Named Value. Changing this forces a new resource to be created.

    ResourceGroupName string

    The name of the Resource Group in which the API Management Named Value should exist. Changing this forces a new resource to be created.

    Secret bool

    Specifies whether the API Management Named Value is secret. Valid values are true or false. The default value is false.

    NOTE: setting the field secret to true doesn't make this field sensitive in the provider, 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 Named Value.

    Value string

    The value of this API Management Named Value.

    ValueFromKeyVault NamedValueValueFromKeyVaultArgs

    A value_from_key_vault block as defined below.

    apiManagementName String

    The name of the API Management Service in which the API Management Named Value should exist. Changing this forces a new resource to be created.

    displayName String

    The display name of this API Management Named Value.

    name String

    The name of the API Management Named Value. Changing this forces a new resource to be created.

    resourceGroupName String

    The name of the Resource Group in which the API Management Named Value should exist. Changing this forces a new resource to be created.

    secret Boolean

    Specifies whether the API Management Named Value is secret. Valid values are true or false. The default value is false.

    NOTE: setting the field secret to true doesn't make this field sensitive in the provider, 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 Named Value.

    value String

    The value of this API Management Named Value.

    valueFromKeyVault NamedValueValueFromKeyVault

    A value_from_key_vault block as defined below.

    apiManagementName string

    The name of the API Management Service in which the API Management Named Value should exist. Changing this forces a new resource to be created.

    displayName string

    The display name of this API Management Named Value.

    name string

    The name of the API Management Named Value. Changing this forces a new resource to be created.

    resourceGroupName string

    The name of the Resource Group in which the API Management Named Value should exist. Changing this forces a new resource to be created.

    secret boolean

    Specifies whether the API Management Named Value is secret. Valid values are true or false. The default value is false.

    NOTE: setting the field secret to true doesn't make this field sensitive in the provider, 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 Named Value.

    value string

    The value of this API Management Named Value.

    valueFromKeyVault NamedValueValueFromKeyVault

    A value_from_key_vault block as defined below.

    api_management_name str

    The name of the API Management Service in which the API Management Named Value should exist. Changing this forces a new resource to be created.

    display_name str

    The display name of this API Management Named Value.

    name str

    The name of the API Management Named Value. Changing this forces a new resource to be created.

    resource_group_name str

    The name of the Resource Group in which the API Management Named Value should exist. Changing this forces a new resource to be created.

    secret bool

    Specifies whether the API Management Named Value is secret. Valid values are true or false. The default value is false.

    NOTE: setting the field secret to true doesn't make this field sensitive in the provider, 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 Named Value.

    value str

    The value of this API Management Named Value.

    value_from_key_vault NamedValueValueFromKeyVaultArgs

    A value_from_key_vault block as defined below.

    apiManagementName String

    The name of the API Management Service in which the API Management Named Value should exist. Changing this forces a new resource to be created.

    displayName String

    The display name of this API Management Named Value.

    name String

    The name of the API Management Named Value. Changing this forces a new resource to be created.

    resourceGroupName String

    The name of the Resource Group in which the API Management Named Value should exist. Changing this forces a new resource to be created.

    secret Boolean

    Specifies whether the API Management Named Value is secret. Valid values are true or false. The default value is false.

    NOTE: setting the field secret to true doesn't make this field sensitive in the provider, 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 Named Value.

    value String

    The value of this API Management Named Value.

    valueFromKeyVault Property Map

    A value_from_key_vault block as defined below.

    Supporting Types

    NamedValueValueFromKeyVault, NamedValueValueFromKeyVaultArgs

    SecretId string

    The resource ID of the Key Vault Secret.

    IdentityClientId string

    The client ID of 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 in absence.

    SecretId string

    The resource ID of the Key Vault Secret.

    IdentityClientId string

    The client ID of 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 in absence.

    secretId String

    The resource ID of the Key Vault Secret.

    identityClientId String

    The client ID of 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 in absence.

    secretId string

    The resource ID of the Key Vault Secret.

    identityClientId string

    The client ID of 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 in absence.

    secret_id str

    The resource ID of the Key Vault Secret.

    identity_client_id str

    The client ID of 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 in absence.

    secretId String

    The resource ID of the Key Vault Secret.

    identityClientId String

    The client ID of 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 in absence.

    Import

    API Management Properties can be imported using the resource id, e.g.

     $ pulumi import azure:apimanagement/namedValue:NamedValue example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example-resources/providers/Microsoft.ApiManagement/service/example-apim/namedValues/example-apimp

    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.

    Azure Classic v5.57.0 published on Tuesday, Nov 28, 2023 by Pulumi
    pulumi/pulumi-azure