New-AzureServiceDiagnosticsExtensionConfig
[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]
New-AzureServiceDiagnosticsExtensionConfig
Creates configuration of a diagnostics extension for one or more roles.
Parameter Set: NewExtension
New-AzureServiceDiagnosticsExtensionConfig [[-Role] <String[]> ] [[-X509Certificate] <X509Certificate2> ] [[-ThumbprintAlgorithm] <String> ] [-StorageAccountName] <String> [[-DiagnosticsConfiguration] <XmlDocument> ] [ <CommonParameters>]
Parameter Set: NewExtensionUsingThumbprint
New-AzureServiceDiagnosticsExtensionConfig [[-Role] <String[]> ] [-CertificateThumbprint] <String> [[-ThumbprintAlgorithm] <String> ] [-StorageAccountName] <String> [[-DiagnosticsConfiguration] <XmlDocument> ] [ <CommonParameters>]
This topic describes the cmdlet in the .6.19 version of the Windows Azure PowerShell module. To find out the version of the module you're using, from the Windows Azure PowerShell console, type (get-module azure).version.
This cmdlet creates configuration of a diagnostics extension for one or more roles.
-CertificateThumbprint<String>
Specifies the thumbprint of a certificate (from the Certificate store) to use for encrypting the private configuration. If not specified, a certificate is created automatically.
Aliases |
none |
Required? |
true |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-DiagnosticsConfiguration<XmlDocument>
Specifies an XML document that contains configuration information for Windows Azure Diagnostics. For more information on authoring and configuring Windows Azure Diagnostics, see Initialize or Change Windows Azure Diagnostics Configuration.
Aliases |
none |
Required? |
false |
Position? |
5 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Role<String[]>
An optional array of roles to specify the diagnostics configuration for. If not specified, the diagnostics configuration is applied as the default configuration for all roles.
Aliases |
none |
Required? |
false |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-StorageAccountName<String>
The name of the storage account to be used by the Diagnostics module to store diagnostics data, such as performance counter data and file logs.
Aliases |
none |
Required? |
true |
Position? |
4 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-ThumbprintAlgorithm<String>
Thumbprint hashing algorithm which is used with the thumbprint to identify the certificate. The default is SHA1.
Aliases |
none |
Required? |
false |
Position? |
3 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-X509Certificate<X509Certificate2>
Specifies an x509 certificate that will be automatically uploaded to the cloud service and used to encrypt the extension private configuration.
Aliases |
none |
Required? |
false |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
Example 1
Creates an object that has the service extension object default for all roles that will be installed with the deployment and the role configuration.
C:\PS>$wadConfig = New-AzureServiceDiagnosticExtensionConfig -StorageAccountName $name -DiagnosticConfiguration $wadConfigXML
Example 2
Creates an object that has the service extension object for a specific role that will be installed with the deployment and the role configuration.
C:\PS>$wadConfig = New-AzureServiceDiagnosticExtensionConfig -StorageAccountName $name -DiagnosticConfiguration $wadConfigXML -Role "WebRole1"