This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.76.0 published on Friday, Dec 6, 2024 by Pulumi
azure-native.apimanagement.getWorkspaceNamedValue
Explore with Pulumi AI
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.76.0 published on Friday, Dec 6, 2024 by Pulumi
Gets the details of the named value specified by its identifier. Azure REST API version: 2022-09-01-preview.
Other available API versions: 2023-03-01-preview, 2023-05-01-preview, 2023-09-01-preview, 2024-05-01, 2024-06-01-preview.
Using getWorkspaceNamedValue
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 getWorkspaceNamedValue(args: GetWorkspaceNamedValueArgs, opts?: InvokeOptions): Promise<GetWorkspaceNamedValueResult>
function getWorkspaceNamedValueOutput(args: GetWorkspaceNamedValueOutputArgs, opts?: InvokeOptions): Output<GetWorkspaceNamedValueResult>
def get_workspace_named_value(named_value_id: Optional[str] = None,
resource_group_name: Optional[str] = None,
service_name: Optional[str] = None,
workspace_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetWorkspaceNamedValueResult
def get_workspace_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,
workspace_id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetWorkspaceNamedValueResult]
func LookupWorkspaceNamedValue(ctx *Context, args *LookupWorkspaceNamedValueArgs, opts ...InvokeOption) (*LookupWorkspaceNamedValueResult, error)
func LookupWorkspaceNamedValueOutput(ctx *Context, args *LookupWorkspaceNamedValueOutputArgs, opts ...InvokeOption) LookupWorkspaceNamedValueResultOutput
> Note: This function is named LookupWorkspaceNamedValue
in the Go SDK.
public static class GetWorkspaceNamedValue
{
public static Task<GetWorkspaceNamedValueResult> InvokeAsync(GetWorkspaceNamedValueArgs args, InvokeOptions? opts = null)
public static Output<GetWorkspaceNamedValueResult> Invoke(GetWorkspaceNamedValueInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetWorkspaceNamedValueResult> getWorkspaceNamedValue(GetWorkspaceNamedValueArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: azure-native:apimanagement:getWorkspaceNamedValue
arguments:
# arguments dictionary
The following arguments are supported:
- Named
Value stringId - Identifier of the NamedValue.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Service
Name string - The name of the API Management service.
- Workspace
Id string - Workspace identifier. Must be unique in the current API Management service instance.
- Named
Value stringId - Identifier of the NamedValue.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Service
Name string - The name of the API Management service.
- Workspace
Id string - Workspace identifier. Must be unique in the current API Management service instance.
- named
Value StringId - Identifier of the NamedValue.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- service
Name String - The name of the API Management service.
- workspace
Id String - Workspace identifier. Must be unique in the current API Management service instance.
- named
Value stringId - Identifier of the NamedValue.
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- service
Name string - The name of the API Management service.
- workspace
Id string - Workspace identifier. Must be unique in the current API Management service instance.
- named_
value_ strid - Identifier of the NamedValue.
- resource_
group_ strname - The name of the resource group. The name is case insensitive.
- service_
name str - The name of the API Management service.
- workspace_
id str - Workspace identifier. Must be unique in the current API Management service instance.
- named
Value StringId - Identifier of the NamedValue.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- service
Name String - The name of the API Management service.
- workspace
Id String - Workspace identifier. Must be unique in the current API Management service instance.
getWorkspaceNamedValue 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
- 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"
- 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
- 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"
- 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
- 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"
- 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<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
- 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"
- 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
- 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 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
- 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"
- 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<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
- 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
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.76.0 published on Friday, Dec 6, 2024 by Pulumi