Set-AzureServiceDiagnosticsExtension

Module:

Azure Module

Enables Azure Diagnostics extension on specified roles or all roles on a deployed service or at deployment.

Note

The cmdlets referenced in this documentation are for managing legacy Azure resources that use Azure Service Manager (ASM) APIs. This legacy PowerShell module isn't recommended when creating new resources since ASM is scheduled for retirement. For more information, see Azure Service Manager retirement.

The Az PowerShell module is the recommended PowerShell module for managing Azure Resource Manager (ARM) resources with PowerShell.

Important

Cloud Services (classic) is now deprecated for new customers and will be retired on August 31st, 2024 for all customers. New deployments should use the new Azure Resource Manager based deployment model Azure Cloud Services (extended support).

Syntax

SetExtension (Default)

Set-AzureServiceDiagnosticsExtension
    [[-ServiceName] <String>]
    [[-Slot] <String>]
    [[-Role] <String[]>]
    [[-X509Certificate] <X509Certificate2>]
    [[-ThumbprintAlgorithm] <String>]
    [[-StorageAccountName] <String>]
    [[-StorageAccountKey] <String>]
    [[-StorageAccountEndpoint] <String>]
    [[-StorageContext] <AzureStorageContext>]
    [-DiagnosticsConfigurationPath] <String>
    [[-Version] <String>]
    [[-ExtensionId] <String>]
    [-Profile <AzureSMProfile>]
    [-InformationAction <ActionPreference>]
    [-InformationVariable <String>]
    [<CommonParameters>]

SetExtensionUsingThumbprint

Set-AzureServiceDiagnosticsExtension
    [[-ServiceName] <String>]
    [[-Slot] <String>]
    [[-Role] <String[]>]
    [[-CertificateThumbprint] <String>]
    [[-ThumbprintAlgorithm] <String>]
    [[-StorageAccountName] <String>]
    [[-StorageAccountKey] <String>]
    [[-StorageAccountEndpoint] <String>]
    [[-StorageContext] <AzureStorageContext>]
    [-DiagnosticsConfigurationPath] <String>
    [[-Version] <String>]
    [[-ExtensionId] <String>]
    [-Profile <AzureSMProfile>]
    [-InformationAction <ActionPreference>]
    [-InformationVariable <String>]
    [<CommonParameters>]

SetExtensionUsingDiagnosticsConfiguration

Set-AzureServiceDiagnosticsExtension
    [[-ServiceName] <String>]
    [[-Slot] <String>]
    [-DiagnosticsConfiguration] <ExtensionConfigurationInput[]>
    [-Profile <AzureSMProfile>]
    [-InformationAction <ActionPreference>]
    [-InformationVariable <String>]
    [<CommonParameters>]

Description

The Set-AzureServiceDiagnosticsExtension cmdlet enables Azure Diagnostics extension on specified roles or all roles on a deployed service or at deployment.

Examples

Example 1: Enable Azure Diagnostics extension

PS C:\> Set-AzureServiceDiagnosticsExtension -ServiceName $Svc -StorageContext $StorageContext -DiagnosticsConfigurationPath $WadConfigXML

This command enables the Azure Diagnostics extension for all roles.

Example 2: Enable Azure Diagnostics extension for a specified role

PS C:\> Set-AzureServiceDiagnosticsExtension -ServiceName $Svc -StorageContext $StorageContext -DiagnosticsConfigurationPath $WadConfigXML -Role "WebRole01"

This command enables the Azure Diagnostics extension for a specified role.

Parameters

-CertificateThumbprint

Specifies a certificate thumbprint to use to encrypt the private configuration. This certificate has to already exist in the certificate store. If you do not specify a certificate, this cmdlet creates a certificate.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

SetExtensionUsingThumbprint

Position:	3
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-DiagnosticsConfiguration

Specifies an array of configuration for Azure Diagnostics.

Parameter properties

Type:	ExtensionConfigurationInput[]
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

SetExtensionUsingDiagnosticsConfiguration

Position:	2
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-DiagnosticsConfigurationPath

Specifies the configuration for Azure Diagnostics. You can download the schema by using the following command:

(Get-AzureServiceAvailableExtension -ExtensionName 'PaaSDiagnostics' -ProviderNamespace 'Microsoft.Azure.Diagnostics').PublicConfigurationSchema | Out-File -Encoding utf8 -FilePath 'WadConfig.xsd'

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

SetExtension

Position:	9
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

SetExtensionUsingThumbprint

Position:	9
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-ExtensionId

Specifies the extension ID

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

SetExtension

Position:	11
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

SetExtensionUsingThumbprint

Position:	11
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-InformationAction

Specifies how this cmdlet responds to an information event.

The acceptable values for this parameter are:

• Continue
• Ignore
• Inquire
• SilentlyContinue
• Stop
• Suspend

Parameter properties

Type:	ActionPreference
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	infa

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-InformationVariable

Specifies an information variable.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	iv

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Profile

Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.

Parameter properties

Type:	AzureSMProfile
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Role

Specifies an optional array of roles for which to specify the Azure Diagnostics configuration. If you do not specify this parameter, the diagnostics configuration is applied as the default configuration for all roles.

Parameter properties

Type:	String[]
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

SetExtension

Position:	2
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

SetExtensionUsingThumbprint

Position:	2
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-ServiceName

Specifies the Azure service name of the deployment.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	0
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-Slot

Specifies the environment of the deployment to modify. The acceptable values for this parameter are: Production or Staging.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	1
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-StorageAccountEndpoint

Specifies a storage account endpoint.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

SetExtension

Position:	7
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

SetExtensionUsingThumbprint

Position:	7
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-StorageAccountKey

Specifies a storage account key.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

SetExtension

Position:	6
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

SetExtensionUsingThumbprint

Position:	6
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-StorageAccountName

Specifies a storage account name.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

SetExtension

Position:	5
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

SetExtensionUsingThumbprint

Position:	5
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-StorageContext

Specifies an Azure storage context.

Parameter properties

Type:	AzureStorageContext
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

SetExtension

Position:	8
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

SetExtensionUsingThumbprint

Position:	8
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-ThumbprintAlgorithm

Specifies a thumbprint hashing algorithm that is used with the thumbprint to identify the certificate. This parameter is optional and the default is sha1.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

SetExtension

Position:	4
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

SetExtensionUsingThumbprint

Position:	4
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-Version

Specifies the version of the extension.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

SetExtension

Position:	10
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

SetExtensionUsingThumbprint

Position:	10
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-X509Certificate

Specifies an X.509 certificate that, when specified, is automatically uploaded to the cloud service and used for encrypting the extension private configuration.

Parameter properties

Type:	X509Certificate2
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

SetExtension

Position:	3
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Related Links

• Get-AzureServiceDiagnosticsExtension
• Remove-AzureServiceDiagnosticsExtension