KeyVaultClientExtensions.CreateKeyAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| CreateKeyAsync(IKeyVaultClient, String, String, NewKeyParameters, CancellationToken) | |
| CreateKeyAsync(IKeyVaultClient, String, String, String, Nullable<Int32>, IList<String>, KeyAttributes, IDictionary<String,String>, String, CancellationToken) |
Creates a new key, stores it, then returns key parameters and attributes to the client. |
CreateKeyAsync(IKeyVaultClient, String, String, NewKeyParameters, CancellationToken)
- Source:
- KeyVaultClientExtensions.cs
public static System.Threading.Tasks.Task<Microsoft.Azure.KeyVault.Models.KeyBundle> CreateKeyAsync (this Microsoft.Azure.KeyVault.IKeyVaultClient operations, string vaultBaseUrl, string keyName, Microsoft.Azure.KeyVault.Models.NewKeyParameters parameters, System.Threading.CancellationToken cancellationToken = default);static member CreateKeyAsync : Microsoft.Azure.KeyVault.IKeyVaultClient * string * string * Microsoft.Azure.KeyVault.Models.NewKeyParameters * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.KeyVault.Models.KeyBundle><Extension()>
Public Function CreateKeyAsync (operations As IKeyVaultClient, vaultBaseUrl As String, keyName As String, parameters As NewKeyParameters, Optional cancellationToken As CancellationToken = Nothing) As Task(Of KeyBundle)Parameters
- operations
- IKeyVaultClient
- vaultBaseUrl
- String
- keyName
- String
- parameters
- NewKeyParameters
- cancellationToken
- CancellationToken
Returns
Applies to
CreateKeyAsync(IKeyVaultClient, String, String, String, Nullable<Int32>, IList<String>, KeyAttributes, IDictionary<String,String>, String, CancellationToken)
- Source:
- KeyVaultClientExtensions.cs
Creates a new key, stores it, then returns key parameters and attributes to the client.
public static System.Threading.Tasks.Task<Microsoft.Azure.KeyVault.Models.KeyBundle> CreateKeyAsync (this Microsoft.Azure.KeyVault.IKeyVaultClient operations, string vaultBaseUrl, string keyName, string kty, int? keySize = default, System.Collections.Generic.IList<string> keyOps = default, Microsoft.Azure.KeyVault.Models.KeyAttributes keyAttributes = default, System.Collections.Generic.IDictionary<string,string> tags = default, string curve = default, System.Threading.CancellationToken cancellationToken = default);static member CreateKeyAsync : Microsoft.Azure.KeyVault.IKeyVaultClient * string * string * string * Nullable<int> * System.Collections.Generic.IList<string> * Microsoft.Azure.KeyVault.Models.KeyAttributes * System.Collections.Generic.IDictionary<string, string> * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.KeyVault.Models.KeyBundle><Extension()>
Public Function CreateKeyAsync (operations As IKeyVaultClient, vaultBaseUrl As String, keyName As String, kty As String, Optional keySize As Nullable(Of Integer) = Nothing, Optional keyOps As IList(Of String) = Nothing, Optional keyAttributes As KeyAttributes = Nothing, Optional tags As IDictionary(Of String, String) = Nothing, Optional curve As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of KeyBundle)Parameters
- operations
- IKeyVaultClient
The operations group for this extension method.
- vaultBaseUrl
- String
The vault name, for example https://myvault.vault.azure.net.
- keyName
- String
The name for the new key. The system will generate the version name for the new key.
- kty
- String
The type of key to create. For valid values, see JsonWebKeyType. Possible values include: 'EC', 'EC-HSM', 'RSA', 'RSA-HSM', 'oct'
- keyAttributes
- KeyAttributes
- tags
- IDictionary<String,String>
Application specific metadata in the form of key-value pairs.
- curve
- String
Elliptic curve name. For valid values, see JsonWebKeyCurveName. Possible values include: 'P-256', 'P-384', 'P-521', 'SECP256K1'
- cancellationToken
- CancellationToken
The cancellation token.
Returns
Remarks
The create key operation can be used to create any key type in Azure Key Vault. If the named key already exists, Azure Key Vault creates a new version of the key. It requires the keys/create permission.
