Skip to main content

security key-manager external azure create-config

Contributors
Suggest changes
PDFs

Create an inactive Azure Key Vault configuration

Availability: This command is available to cluster and Vserver administrators at the admin privilege level.

Description

This command creates an Azure Key Vault (AKV) configuration which can be enabled on a Vserver.

Parameters

-vserver <Vserver Name> - Vserver

The name of the Vserver.

-config-name <text> - Configuration name

The name of the configuration.

-client-id <text> - Application (Client) ID of Deployed Azure Application

The ID of the client.

-tenant-id <text> - Directory (Tenant) ID of Deployed Azure Application

The ID of the tenant.

-name {scheme://(hostname|IPv4 Address|'['IPv6 Address']')…​} - Deployed Azure Key Vault DNS Name

The DNS name of the deployed AKV .

-key-id {scheme://(hostname|IPv4 Address|'['IPv6 Address']')…​} - Key Identifier of AKV Key Encryption Key

The ID of the key.

[-oauth-host <text>] - Open Authorization Host Name

The hostname of the OAuth server.

[-authentication-method <AKV Authentication Method>] - Authentication Method for Azure Application

Use this parameter to specify the authentication method.

Examples

The example below creates a configuration on a node with the following details: Configuration name: sampleConfig, Client ID: client1, Tenant ID: tenant1, Deployed AKV name: https://samplevault.vault.azure.net, Key ID: https://samplevault.vault.azure.net/keys/key1/keyversion, OAuth Host: https://sampleoauth.net, for Vserver vsTest.

cluster-1::> security key-manager external azure create-config -config-name sampleConfig -client-id client1 -tenant-id tenant1 -name https://samplevault.vault.azure.net -key-id https://samplevault.vault.azure.net/keys/key1/keyversion -oauth-host https://sampleoauth.net -vserver vsTest