azure-native.apimanagement.NamedValue
Explore with Pulumi AI
NamedValue details. Azure REST API version: 2022-08-01. Prior API version in Azure Native 1.x: 2020-12-01.
Other available API versions: 2022-09-01-preview, 2023-03-01-preview, 2023-05-01-preview, 2023-09-01-preview, 2024-05-01.
Example Usage
ApiManagementCreateNamedValue
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var namedValue = new AzureNative.ApiManagement.NamedValue("namedValue", new()
{
DisplayName = "prop3name",
NamedValueId = "testprop2",
ResourceGroupName = "rg1",
Secret = false,
ServiceName = "apimService1",
Tags = new[]
{
"foo",
"bar",
},
Value = "propValue",
});
});
package main
import (
apimanagement "github.com/pulumi/pulumi-azure-native-sdk/apimanagement/v2"
"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 com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.apimanagement.NamedValue;
import com.pulumi.azurenative.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 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 System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var namedValue = new AzureNative.ApiManagement.NamedValue("namedValue", new()
{
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 = new[]
{
"foo",
"bar",
},
});
});
package main
import (
apimanagement "github.com/pulumi/pulumi-azure-native-sdk/apimanagement/v2"
"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 com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.apimanagement.NamedValue;
import com.pulumi.azurenative.apimanagement.NamedValueArgs;
import com.pulumi.azurenative.apimanagement.inputs.KeyVaultContractCreatePropertiesArgs;
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 namedValue = new NamedValue("namedValue", NamedValueArgs.builder()
.displayName("prop6namekv")
.keyVault(KeyVaultContractCreatePropertiesArgs.builder()
.identityClientId("ceaa6b06-c00f-43ef-99ac-f53d1fe876a0")
.secretIdentifier("https://contoso.vault.azure.net/secrets/aadSecret")
.build())
.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={
"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 NamedValue Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new NamedValue(name: string, args: NamedValueArgs, opts?: CustomResourceOptions);
@overload
def NamedValue(resource_name: str,
args: NamedValueArgs,
opts: Optional[ResourceOptions] = None)
@overload
def NamedValue(resource_name: str,
opts: Optional[ResourceOptions] = None,
display_name: Optional[str] = None,
resource_group_name: Optional[str] = None,
service_name: Optional[str] = None,
key_vault: Optional[KeyVaultContractCreatePropertiesArgs] = None,
named_value_id: Optional[str] = None,
secret: Optional[bool] = None,
tags: Optional[Sequence[str]] = None,
value: Optional[str] = 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.
Parameters
- 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.
Constructor example
The following reference example uses placeholder values for all input properties.
var namedValueResource = new AzureNative.ApiManagement.NamedValue("namedValueResource", new()
{
DisplayName = "string",
ResourceGroupName = "string",
ServiceName = "string",
KeyVault = new AzureNative.ApiManagement.Inputs.KeyVaultContractCreatePropertiesArgs
{
IdentityClientId = "string",
SecretIdentifier = "string",
},
NamedValueId = "string",
Secret = false,
Tags = new[]
{
"string",
},
Value = "string",
});
example, err := apimanagement.NewNamedValue(ctx, "namedValueResource", &apimanagement.NamedValueArgs{
DisplayName: pulumi.String("string"),
ResourceGroupName: pulumi.String("string"),
ServiceName: pulumi.String("string"),
KeyVault: &apimanagement.KeyVaultContractCreatePropertiesArgs{
IdentityClientId: pulumi.String("string"),
SecretIdentifier: pulumi.String("string"),
},
NamedValueId: pulumi.String("string"),
Secret: pulumi.Bool(false),
Tags: pulumi.StringArray{
pulumi.String("string"),
},
Value: pulumi.String("string"),
})
var namedValueResource = new NamedValue("namedValueResource", NamedValueArgs.builder()
.displayName("string")
.resourceGroupName("string")
.serviceName("string")
.keyVault(KeyVaultContractCreatePropertiesArgs.builder()
.identityClientId("string")
.secretIdentifier("string")
.build())
.namedValueId("string")
.secret(false)
.tags("string")
.value("string")
.build());
named_value_resource = azure_native.apimanagement.NamedValue("namedValueResource",
display_name="string",
resource_group_name="string",
service_name="string",
key_vault={
"identityClientId": "string",
"secretIdentifier": "string",
},
named_value_id="string",
secret=False,
tags=["string"],
value="string")
const namedValueResource = new azure_native.apimanagement.NamedValue("namedValueResource", {
displayName: "string",
resourceGroupName: "string",
serviceName: "string",
keyVault: {
identityClientId: "string",
secretIdentifier: "string",
},
namedValueId: "string",
secret: false,
tags: ["string"],
value: "string",
});
type: azure-native:apimanagement:NamedValue
properties:
displayName: string
keyVault:
identityClientId: string
secretIdentifier: string
namedValueId: string
resourceGroupName: string
secret: false
serviceName: string
tags:
- string
value: string
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:
- Display
Name string - Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Service
Name string - The name of the API Management service.
- Key
Vault Pulumi.Azure Native. Api Management. Inputs. Key Vault Contract Create Properties - KeyVault location details of the namedValue.
- Named
Value stringId - Identifier of the NamedValue.
- Secret bool
- Determines whether the value is a secret and should be encrypted or not. Default value is false.
- 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.
- Display
Name string - Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Service
Name string - The name of the API Management service.
- Key
Vault KeyVault Contract Create Properties Args - KeyVault location details of the namedValue.
- Named
Value stringId - Identifier of the NamedValue.
- Secret bool
- Determines whether the value is a secret and should be encrypted or not. Default value is false.
- []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 String - Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- service
Name String - The name of the API Management service.
- key
Vault KeyVault Contract Create Properties - KeyVault location details of the namedValue.
- named
Value StringId - Identifier of the NamedValue.
- secret Boolean
- Determines whether the value is a secret and should be encrypted or not. Default value is false.
- 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.
- display
Name string - Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters.
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- service
Name string - The name of the API Management service.
- key
Vault KeyVault Contract Create Properties - KeyVault location details of the namedValue.
- named
Value stringId - Identifier of the NamedValue.
- secret boolean
- Determines whether the value is a secret and should be encrypted or not. Default value is false.
- 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_ strname - The name of the resource group. The name is case insensitive.
- service_
name str - The name of the API Management service.
- key_
vault KeyVault Contract Create Properties Args - KeyVault location details of the namedValue.
- named_
value_ strid - Identifier of the NamedValue.
- secret bool
- Determines whether the value is a secret and should be encrypted or not. Default value is false.
- 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.
- display
Name String - Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- service
Name String - The name of the API Management service.
- key
Vault Property Map - KeyVault location details of the namedValue.
- named
Value StringId - Identifier of the NamedValue.
- secret Boolean
- Determines whether the value is a secret and should be encrypted or not. Default value is false.
- 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.
Outputs
All input properties are implicitly available as output properties. Additionally, the NamedValue resource produces the following output properties:
Supporting Types
KeyVaultContractCreateProperties, KeyVaultContractCreatePropertiesArgs
- Identity
Client stringId - Null for SystemAssignedIdentity or Client Id for UserAssignedIdentity , which will be used to access key vault secret.
- Secret
Identifier 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 stringId - Null for SystemAssignedIdentity or Client Id for UserAssignedIdentity , which will be used to access key vault secret.
- Secret
Identifier 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 StringId - Null for SystemAssignedIdentity or Client Id for UserAssignedIdentity , which will be used to access key vault secret.
- secret
Identifier 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 stringId - Null for SystemAssignedIdentity or Client Id for UserAssignedIdentity , which will be used to access key vault secret.
- secret
Identifier 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_ strid - 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
- identity
Client StringId - Null for SystemAssignedIdentity or Client Id for UserAssignedIdentity , which will be used to access key vault secret.
- secret
Identifier 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, KeyVaultContractPropertiesResponseArgs
- Identity
Client stringId - Null for SystemAssignedIdentity or Client Id for UserAssignedIdentity , which will be used to access key vault secret.
- Last
Status Pulumi.Azure Native. Api Management. Inputs. Key Vault Last Access Status Contract Properties Response - Last time sync and refresh status of secret from key vault.
- Secret
Identifier 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 stringId - Null for SystemAssignedIdentity or Client Id for UserAssignedIdentity , which will be used to access key vault secret.
- Last
Status KeyVault Last Access Status Contract Properties Response - Last time sync and refresh status of secret from key vault.
- Secret
Identifier 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 StringId - Null for SystemAssignedIdentity or Client Id for UserAssignedIdentity , which will be used to access key vault secret.
- last
Status KeyVault Last Access Status Contract Properties Response - Last time sync and refresh status of secret from key vault.
- secret
Identifier 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 stringId - Null for SystemAssignedIdentity or Client Id for UserAssignedIdentity , which will be used to access key vault secret.
- last
Status KeyVault Last Access Status Contract Properties Response - Last time sync and refresh status of secret from key vault.
- secret
Identifier 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_ strid - Null for SystemAssignedIdentity or Client Id for UserAssignedIdentity , which will be used to access key vault secret.
- last_
status KeyVault Last Access Status Contract Properties Response - 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
- identity
Client StringId - Null for SystemAssignedIdentity or Client Id for UserAssignedIdentity , which will be used to access key vault secret.
- last
Status Property Map - Last time sync and refresh status of secret from key vault.
- secret
Identifier 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, KeyVaultLastAccessStatusContractPropertiesResponseArgs
- Code string
- Last status code for sync and refresh of secret from key vault.
- Message string
- Details of the error else empty.
- Time
Stamp stringUtc - 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.
- Time
Stamp stringUtc - 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.
- time
Stamp StringUtc - 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.
- time
Stamp stringUtc - 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_ strutc - 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.
- time
Stamp StringUtc - 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/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/namedValues/{namedValueId}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0