Azure Native
getNamedValue
NamedValue details. API Version: 2020-12-01.
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>
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]
func LookupNamedValue(ctx *Context, args *LookupNamedValueArgs, opts ...InvokeOption) (*LookupNamedValueResult, error)
func LookupNamedValueOutput(ctx *Context, args *LookupNamedValueOutputArgs, opts ...InvokeOption) LookupNamedValueResultOutput
> 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)
}
public static CompletableFuture<GetNamedValueResult> getNamedValue(GetNamedValueArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
Function: azure-native:apimanagement:getNamedValue
Arguments:
# Arguments dictionary
The following arguments are supported:
- Named
Value stringId Identifier of the NamedValue.
- Resource
Group stringName The name of the resource group.
- Service
Name string The name of the API Management service.
- Named
Value stringId Identifier of the NamedValue.
- Resource
Group stringName The name of the resource group.
- Service
Name string The name of the API Management service.
- named
Value StringId Identifier of the NamedValue.
- resource
Group StringName The name of the resource group.
- service
Name String The name of the API Management service.
- named
Value stringId Identifier of the NamedValue.
- resource
Group stringName The name of the resource group.
- service
Name string The name of the API Management service.
- named_
value_ strid Identifier of the NamedValue.
- resource_
group_ strname The name of the resource group.
- service_
name str The name of the API Management service.
- named
Value StringId Identifier of the NamedValue.
- resource
Group StringName The name of the resource group.
- service
Name String The name of the API Management service.
getNamedValue Result
The following output properties are available:
- Display
Name string Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters.
- Id string
Resource ID.
- Name string
Resource name.
- Type string
Resource type for API Management resource.
- Key
Vault Pulumi.Azure Native. Api Management. Outputs. Key Vault Contract Properties Response 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.
- 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.
- Id string
Resource ID.
- Name string
Resource name.
- Type string
Resource type for API Management resource.
- Key
Vault KeyVault Contract Properties Response 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.
- []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.
- id String
Resource ID.
- name String
Resource name.
- type String
Resource type for API Management resource.
- key
Vault KeyVault Contract Properties Response 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.
- 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.
- display
Name string Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters.
- id string
Resource ID.
- name string
Resource name.
- type string
Resource type for API Management resource.
- key
Vault KeyVault Contract Properties Response 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.
- 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
Resource ID.
- name str
Resource name.
- type str
Resource type for API Management resource.
- key_
vault KeyVault Contract Properties Response 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.
- 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.
- id String
Resource ID.
- name String
Resource name.
- type String
Resource type for API Management resource.
- key
Vault 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.
- 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.
Supporting Types
KeyVaultContractPropertiesResponse
- 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
- 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.
Package Details
- Repository
- https://github.com/pulumi/pulumi-azure-native
- License
- Apache-2.0