Azure Native

Pulumi Official
Package maintained by Pulumi
v1.64.0 published on Wednesday, May 4, 2022 by Pulumi

NamedValue

NamedValue details. API Version: 2020-12-01.

Example Usage

ApiManagementCreateNamedValue

using Pulumi;
using AzureNative = Pulumi.AzureNative;

class MyStack : Stack
{
    public MyStack()
    {
        var namedValue = new AzureNative.ApiManagement.NamedValue("namedValue", new AzureNative.ApiManagement.NamedValueArgs
        {
            DisplayName = "prop3name",
            NamedValueId = "testprop2",
            ResourceGroupName = "rg1",
            Secret = false,
            ServiceName = "apimService1",
            Tags = 
            {
                "foo",
                "bar",
            },
            Value = "propValue",
        });
    }

}
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := apimanagement.NewNamedValue(ctx, "namedValue", &apimanagement.NamedValueArgs{
			DisplayName:       pulumi.String("prop3name"),
			NamedValueId:      pulumi.String("testprop2"),
			ResourceGroupName: pulumi.String("rg1"),
			Secret:            pulumi.Bool(false),
			ServiceName:       pulumi.String("apimService1"),
			Tags: pulumi.StringArray{
				pulumi.String("foo"),
				pulumi.String("bar"),
			},
			Value: pulumi.String("propValue"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

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

    public static void stack(Context ctx) {
        var namedValue = new NamedValue("namedValue", NamedValueArgs.builder()        
            .displayName("prop3name")
            .namedValueId("testprop2")
            .resourceGroupName("rg1")
            .secret(false)
            .serviceName("apimService1")
            .tags(            
                "foo",
                "bar")
            .value("propValue")
            .build());

        }
}
import pulumi
import pulumi_azure_native as azure_native

named_value = azure_native.apimanagement.NamedValue("namedValue",
    display_name="prop3name",
    named_value_id="testprop2",
    resource_group_name="rg1",
    secret=False,
    service_name="apimService1",
    tags=[
        "foo",
        "bar",
    ],
    value="propValue")
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const namedValue = new azure_native.apimanagement.NamedValue("namedValue", {
    displayName: "prop3name",
    namedValueId: "testprop2",
    resourceGroupName: "rg1",
    secret: false,
    serviceName: "apimService1",
    tags: [
        "foo",
        "bar",
    ],
    value: "propValue",
});
resources:
  namedValue:
    type: azure-native:apimanagement:NamedValue
    properties:
      displayName: prop3name
      namedValueId: testprop2
      resourceGroupName: rg1
      secret: false
      serviceName: apimService1
      tags:
        - foo
        - bar
      value: propValue

ApiManagementCreateNamedValueWithKeyVault

using Pulumi;
using AzureNative = Pulumi.AzureNative;

class MyStack : Stack
{
    public MyStack()
    {
        var namedValue = new AzureNative.ApiManagement.NamedValue("namedValue", new AzureNative.ApiManagement.NamedValueArgs
        {
            DisplayName = "prop6namekv",
            KeyVault = new AzureNative.ApiManagement.Inputs.KeyVaultContractCreatePropertiesArgs
            {
                IdentityClientId = "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0",
                SecretIdentifier = "https://contoso.vault.azure.net/secrets/aadSecret",
            },
            NamedValueId = "testprop6",
            ResourceGroupName = "rg1",
            Secret = true,
            ServiceName = "apimService1",
            Tags = 
            {
                "foo",
                "bar",
            },
        });
    }

}
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := apimanagement.NewNamedValue(ctx, "namedValue", &apimanagement.NamedValueArgs{
			DisplayName: pulumi.String("prop6namekv"),
			KeyVault: &apimanagement.KeyVaultContractCreatePropertiesArgs{
				IdentityClientId: pulumi.String("ceaa6b06-c00f-43ef-99ac-f53d1fe876a0"),
				SecretIdentifier: pulumi.String("https://contoso.vault.azure.net/secrets/aadSecret"),
			},
			NamedValueId:      pulumi.String("testprop6"),
			ResourceGroupName: pulumi.String("rg1"),
			Secret:            pulumi.Bool(true),
			ServiceName:       pulumi.String("apimService1"),
			Tags: pulumi.StringArray{
				pulumi.String("foo"),
				pulumi.String("bar"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

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

    public static void stack(Context ctx) {
        var namedValue = new NamedValue("namedValue", NamedValueArgs.builder()        
            .displayName("prop6namekv")
            .keyVault(Map.ofEntries(
                Map.entry("identityClientId", "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0"),
                Map.entry("secretIdentifier", "https://contoso.vault.azure.net/secrets/aadSecret")
            ))
            .namedValueId("testprop6")
            .resourceGroupName("rg1")
            .secret(true)
            .serviceName("apimService1")
            .tags(            
                "foo",
                "bar")
            .build());

        }
}
import pulumi
import pulumi_azure_native as azure_native

named_value = azure_native.apimanagement.NamedValue("namedValue",
    display_name="prop6namekv",
    key_vault=azure_native.apimanagement.KeyVaultContractCreatePropertiesArgs(
        identity_client_id="ceaa6b06-c00f-43ef-99ac-f53d1fe876a0",
        secret_identifier="https://contoso.vault.azure.net/secrets/aadSecret",
    ),
    named_value_id="testprop6",
    resource_group_name="rg1",
    secret=True,
    service_name="apimService1",
    tags=[
        "foo",
        "bar",
    ])
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const namedValue = new azure_native.apimanagement.NamedValue("namedValue", {
    displayName: "prop6namekv",
    keyVault: {
        identityClientId: "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0",
        secretIdentifier: "https://contoso.vault.azure.net/secrets/aadSecret",
    },
    namedValueId: "testprop6",
    resourceGroupName: "rg1",
    secret: true,
    serviceName: "apimService1",
    tags: [
        "foo",
        "bar",
    ],
});
resources:
  namedValue:
    type: azure-native:apimanagement:NamedValue
    properties:
      displayName: prop6namekv
      keyVault:
        identityClientId: ceaa6b06-c00f-43ef-99ac-f53d1fe876a0
        secretIdentifier: https://contoso.vault.azure.net/secrets/aadSecret
      namedValueId: testprop6
      resourceGroupName: rg1
      secret: true
      serviceName: apimService1
      tags:
        - foo
        - bar

Create a NamedValue Resource

new NamedValue(name: string, args: NamedValueArgs, opts?: CustomResourceOptions);
@overload
def NamedValue(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               display_name: Optional[str] = None,
               key_vault: Optional[KeyVaultContractCreatePropertiesArgs] = None,
               named_value_id: Optional[str] = None,
               resource_group_name: Optional[str] = None,
               secret: Optional[bool] = None,
               service_name: Optional[str] = None,
               tags: Optional[Sequence[str]] = None,
               value: Optional[str] = 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-native: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:

DisplayName string

Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters.

ResourceGroupName string

The name of the resource group.

ServiceName string

The name of the API Management service.

KeyVault Pulumi.AzureNative.ApiManagement.Inputs.KeyVaultContractCreatePropertiesArgs

KeyVault location details of the namedValue.

NamedValueId string

Identifier of the NamedValue.

Secret bool

Determines whether the value is a secret and should be encrypted or not. Default value is false.

Tags List<string>

Optional tags that when provided can be used to filter the NamedValue list.

Value string

Value of the NamedValue. Can contain policy expressions. It may not be empty or consist only of whitespace. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.

DisplayName string

Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters.

ResourceGroupName string

The name of the resource group.

ServiceName string

The name of the API Management service.

KeyVault KeyVaultContractCreatePropertiesArgs

KeyVault location details of the namedValue.

NamedValueId string

Identifier of the NamedValue.

Secret bool

Determines whether the value is a secret and should be encrypted or not. Default value is false.

Tags []string

Optional tags that when provided can be used to filter the NamedValue list.

Value string

Value of the NamedValue. Can contain policy expressions. It may not be empty or consist only of whitespace. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.

displayName String

Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters.

resourceGroupName String

The name of the resource group.

serviceName String

The name of the API Management service.

keyVault KeyVaultContractCreatePropertiesArgs

KeyVault location details of the namedValue.

namedValueId String

Identifier of the NamedValue.

secret Boolean

Determines whether the value is a secret and should be encrypted or not. Default value is false.

tags List

Optional tags that when provided can be used to filter the NamedValue list.

value String

Value of the NamedValue. Can contain policy expressions. It may not be empty or consist only of whitespace. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.

displayName string

Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters.

resourceGroupName string

The name of the resource group.

serviceName string

The name of the API Management service.

keyVault KeyVaultContractCreatePropertiesArgs

KeyVault location details of the namedValue.

namedValueId string

Identifier of the NamedValue.

secret boolean

Determines whether the value is a secret and should be encrypted or not. Default value is false.

tags string[]

Optional tags that when provided can be used to filter the NamedValue list.

value string

Value of the NamedValue. Can contain policy expressions. It may not be empty or consist only of whitespace. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.

display_name str

Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters.

resource_group_name str

The name of the resource group.

service_name str

The name of the API Management service.

key_vault KeyVaultContractCreatePropertiesArgs

KeyVault location details of the namedValue.

named_value_id str

Identifier of the NamedValue.

secret bool

Determines whether the value is a secret and should be encrypted or not. Default value is false.

tags Sequence[str]

Optional tags that when provided can be used to filter the NamedValue list.

value str

Value of the NamedValue. Can contain policy expressions. It may not be empty or consist only of whitespace. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.

displayName String

Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters.

resourceGroupName String

The name of the resource group.

serviceName String

The name of the API Management service.

keyVault Property Map

KeyVault location details of the namedValue.

namedValueId String

Identifier of the NamedValue.

secret Boolean

Determines whether the value is a secret and should be encrypted or not. Default value is false.

tags List

Optional tags that when provided can be used to filter the NamedValue list.

value String

Value of the NamedValue. Can contain policy expressions. It may not be empty or consist only of whitespace. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.

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.

Name string

Resource name.

Type string

Resource type for API Management resource.

Id string

The provider-assigned unique ID for this managed resource.

Name string

Resource name.

Type string

Resource type for API Management resource.

id String

The provider-assigned unique ID for this managed resource.

name String

Resource name.

type String

Resource type for API Management resource.

id string

The provider-assigned unique ID for this managed resource.

name string

Resource name.

type string

Resource type for API Management resource.

id str

The provider-assigned unique ID for this managed resource.

name str

Resource name.

type str

Resource type for API Management resource.

id String

The provider-assigned unique ID for this managed resource.

name String

Resource name.

type String

Resource type for API Management resource.

Supporting Types

KeyVaultContractCreateProperties

IdentityClientId string

Null for SystemAssignedIdentity or Client Id for UserAssignedIdentity , which will be used to access key vault secret.

SecretIdentifier string

Key vault secret identifier for fetching secret. Providing a versioned secret will prevent auto-refresh. This requires Api Management service to be configured with aka.ms/apimmsi

IdentityClientId string

Null for SystemAssignedIdentity or Client Id for UserAssignedIdentity , which will be used to access key vault secret.

SecretIdentifier string

Key vault secret identifier for fetching secret. Providing a versioned secret will prevent auto-refresh. This requires Api Management service to be configured with aka.ms/apimmsi

identityClientId String

Null for SystemAssignedIdentity or Client Id for UserAssignedIdentity , which will be used to access key vault secret.

secretIdentifier String

Key vault secret identifier for fetching secret. Providing a versioned secret will prevent auto-refresh. This requires Api Management service to be configured with aka.ms/apimmsi

identityClientId string

Null for SystemAssignedIdentity or Client Id for UserAssignedIdentity , which will be used to access key vault secret.

secretIdentifier string

Key vault secret identifier for fetching secret. Providing a versioned secret will prevent auto-refresh. This requires Api Management service to be configured with aka.ms/apimmsi

identity_client_id str

Null for SystemAssignedIdentity or Client Id for UserAssignedIdentity , which will be used to access key vault secret.

secret_identifier str

Key vault secret identifier for fetching secret. Providing a versioned secret will prevent auto-refresh. This requires Api Management service to be configured with aka.ms/apimmsi

identityClientId String

Null for SystemAssignedIdentity or Client Id for UserAssignedIdentity , which will be used to access key vault secret.

secretIdentifier String

Key vault secret identifier for fetching secret. Providing a versioned secret will prevent auto-refresh. This requires Api Management service to be configured with aka.ms/apimmsi

KeyVaultContractPropertiesResponse

IdentityClientId string

Null for SystemAssignedIdentity or Client Id for UserAssignedIdentity , which will be used to access key vault secret.

LastStatus Pulumi.AzureNative.ApiManagement.Inputs.KeyVaultLastAccessStatusContractPropertiesResponse

Last time sync and refresh status of secret from key vault.

SecretIdentifier string

Key vault secret identifier for fetching secret. Providing a versioned secret will prevent auto-refresh. This requires Api Management service to be configured with aka.ms/apimmsi

IdentityClientId string

Null for SystemAssignedIdentity or Client Id for UserAssignedIdentity , which will be used to access key vault secret.

LastStatus KeyVaultLastAccessStatusContractPropertiesResponse

Last time sync and refresh status of secret from key vault.

SecretIdentifier string

Key vault secret identifier for fetching secret. Providing a versioned secret will prevent auto-refresh. This requires Api Management service to be configured with aka.ms/apimmsi

identityClientId String

Null for SystemAssignedIdentity or Client Id for UserAssignedIdentity , which will be used to access key vault secret.

lastStatus KeyVaultLastAccessStatusContractPropertiesResponse

Last time sync and refresh status of secret from key vault.

secretIdentifier String

Key vault secret identifier for fetching secret. Providing a versioned secret will prevent auto-refresh. This requires Api Management service to be configured with aka.ms/apimmsi

identityClientId string

Null for SystemAssignedIdentity or Client Id for UserAssignedIdentity , which will be used to access key vault secret.

lastStatus KeyVaultLastAccessStatusContractPropertiesResponse

Last time sync and refresh status of secret from key vault.

secretIdentifier string

Key vault secret identifier for fetching secret. Providing a versioned secret will prevent auto-refresh. This requires Api Management service to be configured with aka.ms/apimmsi

identity_client_id str

Null for SystemAssignedIdentity or Client Id for UserAssignedIdentity , which will be used to access key vault secret.

last_status KeyVaultLastAccessStatusContractPropertiesResponse

Last time sync and refresh status of secret from key vault.

secret_identifier str

Key vault secret identifier for fetching secret. Providing a versioned secret will prevent auto-refresh. This requires Api Management service to be configured with aka.ms/apimmsi

identityClientId String

Null for SystemAssignedIdentity or Client Id for UserAssignedIdentity , which will be used to access key vault secret.

lastStatus Property Map

Last time sync and refresh status of secret from key vault.

secretIdentifier String

Key vault secret identifier for fetching secret. Providing a versioned secret will prevent auto-refresh. This requires Api Management service to be configured with aka.ms/apimmsi

KeyVaultLastAccessStatusContractPropertiesResponse

Code string

Last status code for sync and refresh of secret from key vault.

Message string

Details of the error else empty.

TimeStampUtc string

Last time secret was accessed. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

Code string

Last status code for sync and refresh of secret from key vault.

Message string

Details of the error else empty.

TimeStampUtc string

Last time secret was accessed. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

code String

Last status code for sync and refresh of secret from key vault.

message String

Details of the error else empty.

timeStampUtc String

Last time secret was accessed. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

code string

Last status code for sync and refresh of secret from key vault.

message string

Details of the error else empty.

timeStampUtc string

Last time secret was accessed. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

code str

Last status code for sync and refresh of secret from key vault.

message str

Details of the error else empty.

time_stamp_utc str

Last time secret was accessed. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

code String

Last status code for sync and refresh of secret from key vault.

message String

Details of the error else empty.

timeStampUtc String

Last time secret was accessed. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:apimanagement:NamedValue testprop6 /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop6 

Package Details

Repository
https://github.com/pulumi/pulumi-azure-native
License
Apache-2.0