New-AzureServiceDiagnosticsExtensionConfig

Generates a configuration for a diagnostics extension for specified role(s) or all roles.

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.

Syntax

New-AzureServiceDiagnosticsExtensionConfig
   [[-Role] <String[]>]
   [[-X509Certificate] <X509Certificate2>]
   [[-ThumbprintAlgorithm] <String>]
   [[-StorageAccountName] <String>]
   [[-StorageAccountKey] <String>]
   [[-StorageAccountEndpoint] <String>]
   [[-StorageContext] <AzureStorageContext>]
   [-DiagnosticsConfigurationPath] <String>
   [[-ExtensionId] <String>]
   [-Profile <AzureSMProfile>]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [<CommonParameters>]
New-AzureServiceDiagnosticsExtensionConfig
   [[-Role] <String[]>]
   [-CertificateThumbprint] <String>
   [[-ThumbprintAlgorithm] <String>]
   [[-StorageAccountKey] <String>]
   [[-StorageAccountEndpoint] <String>]
   [[-StorageContext] <AzureStorageContext>]
   [-DiagnosticsConfigurationPath] <String>
   [[-ExtensionId] <String>]
   [-Profile <AzureSMProfile>]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [<CommonParameters>]
New-AzureServiceDiagnosticsExtensionConfig
   [[-StorageAccountName] <String>]
   [-Profile <AzureSMProfile>]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [<CommonParameters>]

Description

The New-AzureServiceDiagnosticsExtensionConfig cmdlet generates a configuration for a diagnostics extension for specified roles or all roles.

Examples

Example 1: Create the Azure Diagnostics extension for all roles in the cloud service

PS C:\> $WadConfig = New-AzureServiceDiagnosticExtensionConfig -StorageContext $StorageContext -DiagnosticsConfigurationPath $WadConfigXML

This command creates the Azure Diagnostics extension for all of the roles in the cloud service.

Example 2: Create the Azure Diagnostics extension for a role

PS C:\> $WadConfig = New-AzureServiceDiagnosticExtensionConfig -StorageContext $StorageContext -DiagnosticsConfigurationPath $WadConfigXML -Role "WebRole1"

This command creates the Azure Diagnostics extension for the role WebRole01 in the cloud service.

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:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-DiagnosticsConfigurationPath

Specifies the diagnostics configuration path.

Type:String
Position:7
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ExtensionId

Specifies the extension ID.

Type:String
Position:8
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 to specify the diagnostics configuration for. If not specified the diagnostics configuration is applied as the default configuration for all roles.

Type:String[]
Position:0
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-StorageAccountEndpoint

Specifies the storage account endpoint.

Type:String
Position:5
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-StorageAccountKey

Specifies the storage account key.

Type:String
Position:4
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-StorageAccountName

Specifies the storage account name.

Type:String
Position:3
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-StorageContext

Specifies an Azure storage context.

Type:AzureStorageContext
Position:6
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ThumbprintAlgorithm

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

Type:String
Position:2
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-X509Certificate

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

Type:X509Certificate2
Position:1
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False