Set-AzureServiceDiagnosticsExtension

[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]

Set-AzureServiceDiagnosticsExtension

Enables diagnostics extension on one or more specified roles or all roles on a deployed service or at deployment.

Parameter Set: SetExtension
Set-AzureServiceDiagnosticsExtension [[-ServiceName] <String> ] [[-Slot] <String> ] [[-Role] <String[]> ] [[-X509Certificate] <X509Certificate2> ] [[-ThumbprintAlgorithm] <String> ] [-StorageAccountName] <String> [[-DiagnosticsConfiguration] <XmlDocument> ] [ <CommonParameters>]

Parameter Set: SetExtensionUsingThumbprint
Set-AzureServiceDiagnosticsExtension [[-ServiceName] <String> ] [[-Slot] <String> ] [[-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 enables diagnostics extension on one or more specified roles or all roles on a deployed service or at deployment.

-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.

-DiagnosticsConfiguration<XmlDocument>

Xml configuration for Windows Azure diagnostics. For more information on authoring and configuring Windows Azure Diagnostics refer to the following page: https://go.microsoft.com/fwlink/?LinkId=293393.

-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.

-ServiceName<String>

Specifies the Windows Azure service name of the deployment.

-Slot<String>

Specifies the environment of the deployment to modify. Supported values are "Production" or "Staging".

-StorageAccountName<String>

The name of the storage account diagnostics will use to store diagnostics data such as performance counter data and file logs.

-ThumbprintAlgorithm<String>

Thumbprint hashing algorithm which is used with the thumbprint to identify the certificate. The default is SHA1.

-X509Certificate<X509Certificate2>

Specifies an x509 certificate that will be automatically uploaded to the cloud service and used to encrypt the extension private configuration.

<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

This example sets default diagnostic configuration for all roles.

C:\PS>Set-AzureServiceDiagnosticExtension -ServiceName $svc -StorageAccountName $name -DiagnosticConfiguration $wadConfigXML

Example 2

This example sets default diagnostic configuration for a role named "WebRole1".

C:\PS>Set-AzureServiceDiagnosticExtension -ServiceName $svc -StorageAccountName $name -DiagnosticConfiguration $wadConfigXML -Role "WebRole1"

Related topics

New-AzureServiceDiagnosticsExtensionConfig