Docs
Packagesazure-native.synapse.getKey
Explore with Pulumi AI
Gets a workspace key Azure REST API version: 2021-06-01.
Other available API versions: 2021-06-01-preview.
Using getKey
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 getKey(args: GetKeyArgs, opts?: InvokeOptions): Promise<GetKeyResult>
function getKeyOutput(args: GetKeyOutputArgs, opts?: InvokeOptions): Output<GetKeyResult>def get_key(key_name: Optional[str] = None,
resource_group_name: Optional[str] = None,
workspace_name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetKeyResult
def get_key_output(key_name: Optional[pulumi.Input[str]] = None,
resource_group_name: Optional[pulumi.Input[str]] = None,
workspace_name: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetKeyResult]func LookupKey(ctx *Context, args *LookupKeyArgs, opts ...InvokeOption) (*LookupKeyResult, error)
func LookupKeyOutput(ctx *Context, args *LookupKeyOutputArgs, opts ...InvokeOption) LookupKeyResultOutput> Note: This function is named LookupKey in the Go SDK.
public static class GetKey
{
public static Task<GetKeyResult> InvokeAsync(GetKeyArgs args, InvokeOptions? opts = null)
public static Output<GetKeyResult> Invoke(GetKeyInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetKeyResult> getKey(GetKeyArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: azure-native:synapse:getKey
arguments:
# arguments dictionaryThe following arguments are supported:
- Key
Name string The name of the workspace key
- Resource
Group stringName The name of the resource group. The name is case insensitive.
- Workspace
Name string The name of the workspace.
- Key
Name string The name of the workspace key
- Resource
Group stringName The name of the resource group. The name is case insensitive.
- Workspace
Name string The name of the workspace.
- key
Name String The name of the workspace key
- resource
Group StringName The name of the resource group. The name is case insensitive.
- workspace
Name String The name of the workspace.
- key
Name string The name of the workspace key
- resource
Group stringName The name of the resource group. The name is case insensitive.
- workspace
Name string The name of the workspace.
- key_
name str The name of the workspace key
- resource_
group_ strname The name of the resource group. The name is case insensitive.
- workspace_
name str The name of the workspace.
- key
Name String The name of the workspace key
- resource
Group StringName The name of the resource group. The name is case insensitive.
- workspace
Name String The name of the workspace.
getKey Result
The following output properties are available:
- 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"
- Is
Active boolCMK Used to activate the workspace after a customer managed key is provided.
- Key
Vault stringUrl The Key Vault Url of the workspace key.
- 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"
- Is
Active boolCMK Used to activate the workspace after a customer managed key is provided.
- Key
Vault stringUrl The Key Vault Url of the workspace key.
- 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"
- is
Active BooleanCMK Used to activate the workspace after a customer managed key is provided.
- key
Vault StringUrl The Key Vault Url of the workspace key.
- 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"
- is
Active booleanCMK Used to activate the workspace after a customer managed key is provided.
- key
Vault stringUrl The Key Vault Url of the workspace key.
- 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"
- is_
active_ boolcmk Used to activate the workspace after a customer managed key is provided.
- key_
vault_ strurl The Key Vault Url of the workspace key.
- 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"
- is
Active BooleanCMK Used to activate the workspace after a customer managed key is provided.
- key
Vault StringUrl The Key Vault Url of the workspace key.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0