Use Pulumi's new import command to generate code from existing cloud resources. Learn More
  1. Docs
  2. Reference
  3. API
  4. Azure NextGen
  5. synapse
  6. GetKey

GetKey

Using GetKey

function getKey(args: GetKeyArgs, opts?: InvokeOptions): Promise<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
func LookupKey(ctx *Context, args *LookupKeyArgs, opts ...InvokeOption) (*LookupKeyResult, error)

Note: This function is named LookupKey in the Go SDK.

public static class GetKey {
    public static Task<GetKeyResult> InvokeAsync(GetKeyArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

KeyName string
The name of the workspace key
ResourceGroupName string
The name of the resource group. The name is case insensitive.
WorkspaceName string
The name of the workspace
KeyName string
The name of the workspace key
ResourceGroupName string
The name of the resource group. The name is case insensitive.
WorkspaceName string
The name of the workspace
keyName string
The name of the workspace key
resourceGroupName string
The name of the resource group. The name is case insensitive.
workspaceName string
The name of the workspace
key_name str
The name of the workspace key
resource_group_name str
The name of the resource group. The name is case insensitive.
workspace_name str
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”
IsActiveCMK bool
Used to activate the workspace after a customer managed key is provided.
KeyVaultUrl string
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”
IsActiveCMK bool
Used to activate the workspace after a customer managed key is provided.
KeyVaultUrl string
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”
isActiveCMK boolean
Used to activate the workspace after a customer managed key is provided.
keyVaultUrl string
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_cmk bool
Used to activate the workspace after a customer managed key is provided.
key_vault_url str
The Key Vault Url of the workspace key.

Package Details

Repository
https://github.com/pulumi/pulumi-azure-nextgen
License
Apache-2.0