Set-AzureServiceDiagnosticsExtension
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
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>] 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>] 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 $WadConfigXMLThis 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.
| Type: | String |
| Position: | 3 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-DiagnosticsConfiguration
Specifies an array of configuration for Azure Diagnostics.
| Type: | ExtensionConfigurationInput[] |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | 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'
| Type: | String |
| Position: | 9 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ExtensionId
Specifies the extension ID
| Type: | String |
| Position: | 11 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-InformationAction
Specifies how this cmdlet responds to an information event.
The acceptable values for this parameter are:
- Continue
- Ignore
- Inquire
- SilentlyContinue
- Stop
- Suspend
| Type: | ActionPreference |
| Aliases: | infa |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InformationVariable
Specifies an information variable.
| Type: | String |
| Aliases: | iv |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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.
| Type: | AzureSMProfile |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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.
| Type: | String[] |
| Position: | 2 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ServiceName
Specifies the Azure service name of the deployment.
| Type: | String |
| Position: | 0 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Slot
Specifies the environment of the deployment to modify. The acceptable values for this parameter are: Production or Staging.
| Type: | String |
| Position: | 1 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-StorageAccountEndpoint
Specifies a storage account endpoint.
| Type: | String |
| Position: | 7 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-StorageAccountKey
Specifies a storage account key.
| Type: | String |
| Position: | 6 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-StorageAccountName
Specifies a storage account name.
| Type: | String |
| Position: | 5 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-StorageContext
Specifies an Azure storage context.
| Type: | AzureStorageContext |
| Position: | 8 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | 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.
| Type: | String |
| Position: | 4 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Version
Specifies the version of the extension.
| Type: | String |
| Position: | 10 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | 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.
| Type: | X509Certificate2 |
| Position: | 3 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |