Register-SecretVault

الوحدة النمطية:

Microsoft.PowerShell.SecretManagement

تسجيل وحدة مخزن ملحق SecretManagement للمستخدم الحالي.

بناء الجملة

Register-SecretVault
        [-ModuleName] <String>
        [[-Name] <String>]
        [-VaultParameters <Hashtable>]
        [-DefaultVault]
        [-AllowClobber]
        [-PassThru]
        [-Description <String>]
        [-WhatIf]
        [-Confirm]
        [<CommonParameters>]

الوصف

يضيف أمر cmdlet هذا مخزن ملحق SecretManagement إلى سجل مخزن المستخدم الحالي. مخزن الملحقات هو وحدة PowerShell النمطية التي تتوافق مع تنسيق مخزن الملحقات المطلوب. يتحقق cmdlet هذا من أن الوحدة النمطية المحددة تفي بمتطلبات التوافق قبل إضافتها إلى سجل مخزن الملحق. يتم تسجيل مخازن الملحقات للمستخدم الحالي ولا تؤثر على تسجيلات مخزن المستخدم الأخرى.

يتم تعريف المخزن الأول المسجل مع cmdlet هذا تلقائيا على أنه المخزن الافتراضي حتى إذا لم يتم تحديد المعلمة DefaultVault .

أمثلة

مثال 1

Register-SecretVault -Name LocalStore -ModuleName Microsoft.PowerShell.SecretStore -DefaultVault
Get-SecretVault

VaultName  ModuleName                        IsDefaultVault
---------  ----------                        --------------
CredMan    Microsoft.PowerShell.CredManStore False
LocalStore Microsoft.PowerShell.SecretStore  True

يسجل هذا المثال مخزن ملحق Microsoft.PowerShell.SecretStore للمستخدم الحالي. يستخدم المعلمة DefaultVault لجعل المخزن المسجل المخزن الافتراضي للمستخدم. Get-SecretVault يسرد جميع المخازن المسجلة للمستخدم، والتحقق من تسجيل المخزن وتعيينه كمخزن افتراضي.

مثال 2

$parameters = @{
    Name = 'Azure'
    ModuleName = 'Az.KeyVault'
    VaultParameters = @{
        AZKVaultName = 'AzureKeyVault'
        SubscriptionId = (Get-AzContext).Subscription.Id
    }
    DefaultVault = $true
}
Register-SecretVault @parameters
Get-SecretVault

Name  ModuleName  IsDefaultVault
----  ----------  --------------
Azure Az.KeyVault True

يسجل هذا المثال مخزن ملحق Az.KeyVault للمستخدم الحالي. يجب تثبيت الوحدة النمطية Az.KeyVault في السابق. بالنسبة إلى VaultParameters:

• AZKVaultNameيحدد اسم Key Vault على Azure
• SubscriptionIdيحدد معرف الاشتراك حيث يتم إنشاء Key Vault في

المعلمات

-AllowClobber

إذا تم تحديده، يسمح cmdlet بالكتابة فوق مخزن ملحق مسجل موجود بنفس الاسم.

Type:	SwitchParameter
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Confirm

يطالبك بالتأكيد قبل تشغيل cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultVault

إذا تم تحديده، فعين مخزن الملحق الجديد كمخزن افتراضي للمستخدم الحالي.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Description

يصف المخزن. يتم تضمين هذه القيمة في معلومات سجل المخزن.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ModuleName

يحدد اسم وحدة PowerShell النمطية التي تنفذ مخزن الملحقات. أدخل اسم الوحدة النمطية أو المسار إلى الوحدة النمطية. إذا حددت اسما، فسيبحث PowerShell عنه في مسارات الوحدة النمطية المعروفة. إذا حددت مسارا، يبحث PowerShell عن هذا المسار للوحدة النمطية.

Type:	String
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Name

يحدد اسم مخزن الملحقات. إذا لم يتم تحديد اسم، يتم استخدام اسم الوحدة النمطية كاسم المخزن.

Type:	String
Position:	0
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-PassThru

يشير إلى أن cmdlet يجب أن يرجع كائن SecretVaultInfo لمخزن الملحق المسجل بنجاح. بشكل افتراضي، لا يقوم cmdlet بإرجاع أي إخراج.

Type:	SwitchParameter
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-VaultParameters

يحدد كائن Hashtable يحتوي على أزواج قيمة مفتاح اختيارية تستخدم كمعلمات بواسطة مخزن الملحق. هذه المعلمات اختيارية. راجع وثائق وحدة ملحق المخزن لمعرفة القيم المطلوبة.

Type:	Hashtable
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

تعرض ما سيحدث عند تشغيل الأمر cmdlet. لم يتم تشغيل cmdlet.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

الإدخالات

None

المخرجات

None