Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. apimanagement
  5. getNamedValue
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.82.0 published on Friday, Jan 10, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.apimanagement.getNamedValue

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.82.0 published on Friday, Jan 10, 2025 by Pulumi
pulumi/pulumi-azure-native

Gets the details of the named value specified by its identifier. Azure REST API version: 2022-08-01.

Other available API versions: 2022-09-01-preview, 2023-03-01-preview, 2023-05-01-preview, 2023-09-01-preview, 2024-05-01, 2024-06-01-preview.

Using getNamedValue

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getNamedValue(args: GetNamedValueArgs, opts?: InvokeOptions): Promise<GetNamedValueResult>
function getNamedValueOutput(args: GetNamedValueOutputArgs, opts?: InvokeOptions): Output<GetNamedValueResult>
Copy
def get_named_value(named_value_id: Optional[str] = None,
                    resource_group_name: Optional[str] = None,
                    service_name: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetNamedValueResult
def get_named_value_output(named_value_id: Optional[pulumi.Input[str]] = None,
                    resource_group_name: Optional[pulumi.Input[str]] = None,
                    service_name: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetNamedValueResult]
Copy
func LookupNamedValue(ctx *Context, args *LookupNamedValueArgs, opts ...InvokeOption) (*LookupNamedValueResult, error)
func LookupNamedValueOutput(ctx *Context, args *LookupNamedValueOutputArgs, opts ...InvokeOption) LookupNamedValueResultOutput
Copy

> Note: This function is named LookupNamedValue in the Go SDK.

public static class GetNamedValue 
{
    public static Task<GetNamedValueResult> InvokeAsync(GetNamedValueArgs args, InvokeOptions? opts = null)
    public static Output<GetNamedValueResult> Invoke(GetNamedValueInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetNamedValueResult> getNamedValue(GetNamedValueArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Copy
fn::invoke:
  function: azure-native:apimanagement:getNamedValue
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

NamedValueId
This property is required.
Changes to this property will trigger replacement.
string
Identifier of the NamedValue.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ServiceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management service.
NamedValueId
This property is required.
Changes to this property will trigger replacement.
string
Identifier of the NamedValue.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ServiceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management service.
namedValueId
This property is required.
Changes to this property will trigger replacement.
String
Identifier of the NamedValue.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
serviceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the API Management service.
namedValueId
This property is required.
Changes to this property will trigger replacement.
string
Identifier of the NamedValue.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
serviceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management service.
named_value_id
This property is required.
Changes to this property will trigger replacement.
str
Identifier of the NamedValue.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
service_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the API Management service.
namedValueId
This property is required.
Changes to this property will trigger replacement.
String
Identifier of the NamedValue.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
serviceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the API Management service.

getNamedValue Result

The following output properties are available:

DisplayName string
Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string
The name of the resource
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
KeyVault Pulumi.AzureNative.ApiManagement.Outputs.KeyVaultContractPropertiesResponse
KeyVault location details 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.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string
The name of the resource
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
KeyVault KeyVaultContractPropertiesResponse
KeyVault location details 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.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String
The name of the resource
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
keyVault KeyVaultContractPropertiesResponse
KeyVault location details of the namedValue.
secret Boolean
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.
id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name string
The name of the resource
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
keyVault KeyVaultContractPropertiesResponse
KeyVault location details 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.
id str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name str
The name of the resource
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
key_vault KeyVaultContractPropertiesResponse
KeyVault location details 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.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String
The name of the resource
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
keyVault Property Map
KeyVault location details of the namedValue.
secret Boolean
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.

Supporting Types

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.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.82.0 published on Friday, Jan 10, 2025 by Pulumi
pulumi/pulumi-azure-native