Keys interface

الحزمة:

@azure/arm-keyvault

واجهة تمثل مفاتيح.

الأساليب

createIfNotExist(string, string, string, KeyCreateParameters, KeysCreateIfNotExistOptionalParams)	إنشاء الإصدار الأول من مفتاح جديد إذا لم يكن موجودا. إذا كان موجودا بالفعل، فسيتم إرجاع المفتاح الموجود دون تنفيذ أي عمليات كتابة. لا تنشئ واجهة برمجة التطبيقات هذه إصدارات لاحقة، ولا تقوم بتحديث المفاتيح الموجودة.
get(string, string, string, KeysGetOptionalParams)	يحصل على الإصدار الحالي من المفتاح المحدد من مخزن المفاتيح المحدد.
getVersion(string, string, string, string, KeysGetVersionOptionalParams)	يحصل على الإصدار المحدد من المفتاح المحدد في مخزن المفاتيح المحدد.
list(string, string, KeysListOptionalParams)	يسرد المفاتيح في مخزن المفاتيح المحدد.
listVersions(string, string, string, KeysListVersionsOptionalParams)	يسرد إصدارات المفتاح المحدد في مخزن المفاتيح المحدد.

تفاصيل الأسلوب

createIfNotExist(string, string, string, KeyCreateParameters, KeysCreateIfNotExistOptionalParams)

إنشاء الإصدار الأول من مفتاح جديد إذا لم يكن موجودا. إذا كان موجودا بالفعل، فسيتم إرجاع المفتاح الموجود دون تنفيذ أي عمليات كتابة. لا تنشئ واجهة برمجة التطبيقات هذه إصدارات لاحقة، ولا تقوم بتحديث المفاتيح الموجودة.

function createIfNotExist(resourceGroupName: string, vaultName: string, keyName: string, parameters: KeyCreateParameters, options?: KeysCreateIfNotExistOptionalParams): Promise<Key>

المعلمات

resourceGroupName

string

اسم مجموعة الموارد التي تحتوي على مخزن المفاتيح المحدد.

vaultName

string

اسم مخزن المفاتيح الذي يحتوي على المفتاح الذي سيتم إنشاؤه.

keyName

string

اسم المفتاح الذي سيتم إنشاؤه. قد يتم نسخ القيمة التي تقدمها عالميا لغرض تشغيل الخدمة. يجب ألا تتضمن القيمة المقدمة معلومات تعريف شخصية أو معلومات حساسة.

parameters

KeyCreateParameters

المعلمات المستخدمة لإنشاء المفتاح المحدد.

options

KeysCreateIfNotExistOptionalParams

معلمات الخيارات.

المرتجعات

Promise<Key>

get(string, string, string, KeysGetOptionalParams)

يحصل على الإصدار الحالي من المفتاح المحدد من مخزن المفاتيح المحدد.

function get(resourceGroupName: string, vaultName: string, keyName: string, options?: KeysGetOptionalParams): Promise<Key>

المعلمات

resourceGroupName

string

اسم مجموعة الموارد التي تحتوي على مخزن المفاتيح المحدد.

vaultName

string

اسم المخزن الذي يحتوي على المفتاح المراد استرداده.

keyName

string

اسم المفتاح المراد استرداده.

options

KeysGetOptionalParams

معلمات الخيارات.

المرتجعات

Promise<Key>

getVersion(string, string, string, string, KeysGetVersionOptionalParams)

يحصل على الإصدار المحدد من المفتاح المحدد في مخزن المفاتيح المحدد.

function getVersion(resourceGroupName: string, vaultName: string, keyName: string, keyVersion: string, options?: KeysGetVersionOptionalParams): Promise<Key>

المعلمات

resourceGroupName

string

اسم مجموعة الموارد التي تحتوي على مخزن المفاتيح المحدد.

vaultName

string

اسم المخزن الذي يحتوي على إصدار المفتاح المراد استرداده.

keyName

string

اسم إصدار المفتاح المراد استرداده.

keyVersion

string

إصدار المفتاح المراد استرداده.

options

KeysGetVersionOptionalParams

معلمات الخيارات.

المرتجعات

Promise<Key>

list(string, string, KeysListOptionalParams)

يسرد المفاتيح في مخزن المفاتيح المحدد.

function list(resourceGroupName: string, vaultName: string, options?: KeysListOptionalParams): PagedAsyncIterableIterator<Key, Key[], PageSettings>

المعلمات

resourceGroupName

string

اسم مجموعة الموارد التي تحتوي على مخزن المفاتيح المحدد.

vaultName

string

اسم المخزن الذي يحتوي على المفاتيح المراد استردادها.

options

KeysListOptionalParams

معلمات الخيارات.

المرتجعات

PagedAsyncIterableIterator<Key, Key[], PageSettings>

listVersions(string, string, string, KeysListVersionsOptionalParams)

يسرد إصدارات المفتاح المحدد في مخزن المفاتيح المحدد.

function listVersions(resourceGroupName: string, vaultName: string, keyName: string, options?: KeysListVersionsOptionalParams): PagedAsyncIterableIterator<Key, Key[], PageSettings>

المعلمات

resourceGroupName

string

اسم مجموعة الموارد التي تحتوي على مخزن المفاتيح المحدد.

vaultName

string

اسم المخزن الذي يحتوي على الإصدارات الرئيسية التي سيتم استردادها.

keyName

string

اسم الإصدارات الرئيسية المراد استردادها.

options

KeysListVersionsOptionalParams

معلمات الخيارات.

المرتجعات

PagedAsyncIterableIterator<Key, Key[], PageSettings>