Skip to content

Latest commit

 

History

History
133 lines (101 loc) · 3.5 KB

New-AzureRmVmssVaultCertificateConfig.md

File metadata and controls

133 lines (101 loc) · 3.5 KB
external help file Module Name ms.assetid online version schema
Microsoft.Azure.Commands.Compute.dll-Help.xml
AzureRM.Compute
5CC89899-00B6-424A-8896-FD32DE9DDA28
2.0.0

New-AzureRmVmssVaultCertificateConfig

SYNOPSIS

Creates a Key Vault certificate configuration.

SYNTAX

New-AzureRmVmssVaultCertificateConfig [[-CertificateUrl] <String>] [[-CertificateStore] <String>]
 [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

The New-AzureRmVmssVaultCertificateConfig cmdlet specifies the secret that needs to be placed on the Virtual Machine Scale Set (VMSS) virtual machines. The output of this cmdlet is intended to be used with the Add-AzureRmVmssSecret cmdlet.

EXAMPLES

Example 1: Create a Key Vault certificate configuration

PS C:\> New-AzureRmVmssVaultCertificateConfig -CertificateUrl "http://keyVaultName.vault.contoso.net/secrets/secretName/secretVersion" -CertificateStore "MyCerts"

This command creates a Key Vault certificate configuration that uses the certificate store named MyCerts located at the specified certificate URL.

PARAMETERS

-CertificateStore

Specifies the certificate store on the virtual machines in the scale set where the certificate is added. This is only valid for Windows Virtual Machine Scale Sets.

Type: System.String
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-CertificateUrl

Specifies the URI of a certificate stored in the Key Vault. It is the base64 encoding of the following JSON Object which is encoded in UTF-8: { "data":"<Base64-encoded-certificate>", "dataType":"pfx", "password":"<pfx-file-password>" }

Type: System.String
Parameter Sets: (All)
Aliases:

Required: False
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure.

Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer
Parameter Sets: (All)
Aliases: AzureRmContext, AzureCredential

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: cf

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: wi

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

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

System.String

OUTPUTS

Microsoft.Azure.Management.Compute.Models.VaultCertificate

NOTES

RELATED LINKS

Add-AzureRmVmssSecret