SqlServerKeyCollection.CreateOrUpdate Method

Definition

Namespace:

Azure.ResourceManager.Sql

Assembly:

Azure.ResourceManager.Sql.dll

Package:

Azure.ResourceManager.Sql v1.2.1

Source:

SqlServerKeyCollection.cs

Creates or updates a server key.

• Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/keys/{keyName}
• Operation Id: ServerKeys_CreateOrUpdate
• Default Api Version: 2020-11-01-preview
• Resource: SqlServerKeyResource

public virtual Azure.ResourceManager.ArmOperation<Azure.ResourceManager.Sql.SqlServerKeyResource> CreateOrUpdate (Azure.WaitUntil waitUntil, string keyName, Azure.ResourceManager.Sql.SqlServerKeyData data, System.Threading.CancellationToken cancellationToken = default);

abstract member CreateOrUpdate : Azure.WaitUntil * string * Azure.ResourceManager.Sql.SqlServerKeyData * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation<Azure.ResourceManager.Sql.SqlServerKeyResource>
override this.CreateOrUpdate : Azure.WaitUntil * string * Azure.ResourceManager.Sql.SqlServerKeyData * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation<Azure.ResourceManager.Sql.SqlServerKeyResource>

Public Overridable Function CreateOrUpdate (waitUntil As WaitUntil, keyName As String, data As SqlServerKeyData, Optional cancellationToken As CancellationToken = Nothing) As ArmOperation(Of SqlServerKeyResource)

Parameters

waitUntil

WaitUntil

Completed if the method should wait to return until the long-running operation has completed on the service; Started if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples.

keyName

String

The name of the server key to be operated on (updated or created). The key name is required to be in the format of 'vault_key_version'. For example, if the keyId is https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion, then the server key name should be formatted as: YourVaultName_YourKeyName_YourKeyVersion.

data

SqlServerKeyData

The requested server key resource state.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

ArmOperation<SqlServerKeyResource>

Exceptions

ArgumentException

keyName is an empty string, and was expected to be non-empty.

ArgumentNullException

keyName or data is null.