Managed Instance Keys - Create Or Update

Usługa:: SQL Database

Wersja interfejsu API:: 2025-01-01

Tworzy lub aktualizuje klucz wystąpienia zarządzanego.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/keys/{keyName}?api-version=2025-01-01

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
keyName	path	True	string	Nazwa klucza wystąpienia zarządzanego do pobrania.
managedInstanceName	path	True	string	Nazwa wystąpienia zarządzanego.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
subscriptionId	path	True	string (uuid)	Identyfikator subskrypcji docelowej. Wartość musi być identyfikatorem UUID.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

Nazwa	Wymagane	Typ	Opis
properties.serverKeyType	True	ServerKeyType	Typ klucza, taki jak "ServiceManaged", "AzureKeyVault".
properties.uri		string	Identyfikator URI klucza. Jeśli wartość ServerKeyType to AzureKeyVault, wymagany jest identyfikator URI.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	ManagedInstanceKey	Operacja aktualizacji zasobu 'ManagedInstanceKey' zakończyła się sukcesem
201 Created	ManagedInstanceKey	Operacja tworzenia zasobu 'ManagedInstanceKey' zakończyła się sukcesem Nagłówki Location: string Retry-After: integer
202 Accepted		Zaakceptowano operację zasobu. Nagłówki Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Nieoczekiwana odpowiedź na błąd.

Zabezpieczenia

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

Creates or updates a managed instance key

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/managedInstances/sqlcrudtest-4645/keys/someVault_someKey_01234567890123456789012345678901?api-version=2025-01-01

{
  "properties": {
    "serverKeyType": "AzureKeyVault",
    "uri": "https://someVault.vault.azure.net/keys/someKey/01234567890123456789012345678901"
  }
}

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/SQL/stable/2025-01-01/examples/ManagedInstanceKeyCreateOrUpdate.json
// this example is just showing the usage of "ManagedInstanceKeys_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ManagedInstanceResource created on azure
// for more information of creating ManagedInstanceResource, please refer to the document of ManagedInstanceResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "sqlcrudtest-7398";
string managedInstanceName = "sqlcrudtest-4645";
ResourceIdentifier managedInstanceResourceId = ManagedInstanceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, managedInstanceName);
ManagedInstanceResource managedInstance = client.GetManagedInstanceResource(managedInstanceResourceId);

// get the collection of this ManagedInstanceKeyResource
ManagedInstanceKeyCollection collection = managedInstance.GetManagedInstanceKeys();

// invoke the operation
string keyName = "someVault_someKey_01234567890123456789012345678901";
ManagedInstanceKeyData data = new ManagedInstanceKeyData
{
    ServerKeyType = SqlServerKeyType.AzureKeyVault,
    Uri = new Uri("https://someVault.vault.azure.net/keys/someKey/01234567890123456789012345678901"),
};
ArmOperation<ManagedInstanceKeyResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, keyName, data);
ManagedInstanceKeyResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
ManagedInstanceKeyData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Przykładowa odpowiedź

Kod stanu:: 200

{
  "name": "sqlcrudtest-4645",
  "type": "Microsoft.Sql/managedInstances/keys",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/managedInstances/sqlcrudtest-4645/keys/someVault_someKey_01234567890123456789012345678901",
  "kind": "azurekeyvault",
  "properties": {
    "serverKeyType": "AzureKeyVault",
    "autoRotationEnabled": false,
    "creationDate": "2020-11-01T00:00:00Z",
    "thumbprint": "00112233445566778899AABBCCDDEEFFAABBCCDD"
  }
}

Kod stanu:: 201

{
  "name": "sqlcrudtest-4645",
  "type": "Microsoft.Sql/managedInstances/keys",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/managedInstances/sqlcrudtest-4645/keys/someVault_someKey_01234567890123456789012345678901",
  "kind": "azurekeyvault",
  "properties": {
    "serverKeyType": "AzureKeyVault",
    "autoRotationEnabled": false,
    "creationDate": "2020-11-01T00:00:00Z",
    "thumbprint": "00112233445566778899AABBCCDDEEFFAABBCCDD"
  }
}

Kod stanu:: 202

Definicje

Nazwa	Opis
createdByType	Typ tożsamości, która utworzyła zasób.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
ManagedInstanceKey	Klucz wystąpienia zarządzanego.
ServerKeyType	Typ ochrony szyfrowania, taki jak "ServiceManaged", "AzureKeyVault".
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

createdByType

Wyliczenie

Typ tożsamości, która utworzyła zasób.

Wartość	Opis
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objekt

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Objekt

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Błąd dodatkowe informacje.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Cel błędu.

ErrorResponse

Objekt

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

ManagedInstanceKey

Objekt

Klucz wystąpienia zarządzanego.

Nazwa	Typ	Opis
id	string (arm-id)	W pełni kwalifikowany identyfikator zasobu dla zasobu. Np. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind	string	Rodzaj ochrony szyfrowania. To metadane używane w doświadczeniu portalu Azure.
name	string	Nazwa zasobu
properties.autoRotationEnabled	boolean	Flaga automatycznego obracania kluczy. Prawda lub fałsz.
properties.creationDate	string (date-time)	Data utworzenia klucza.
properties.serverKeyType	ServerKeyType	Typ klucza, taki jak "ServiceManaged", "AzureKeyVault".
properties.thumbprint	string	Odcisk palca klucza.
properties.uri	string	Identyfikator URI klucza. Jeśli wartość ServerKeyType to AzureKeyVault, wymagany jest identyfikator URI.
systemData	systemData	Metadane Azure Resource Manager zawierające informacje createdBy i modifiedBy.
type	string	Typ zasobu. Np. "Microsoft. Compute/virtualMachines" lub "Microsoft. Storage/storageAccounts"

ServerKeyType

Wyliczenie

Typ ochrony szyfrowania, taki jak "ServiceManaged", "AzureKeyVault".

Wartość	Opis
ServiceManaged	ServiceManaged
AzureKeyVault	AzureKeyVault

systemData

Objekt

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string (date-time)	Sygnatura czasowa tworzenia zasobu (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string (date-time)	Znacznik czasu ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.