JobProperties.CreateForExportJob Method

Definition

Namespace:

Microsoft.Azure.Devices

Assembly:

Microsoft.Azure.Devices.dll

Package:

Microsoft.Azure.Devices v1.38.1

Creates an instance of JobProperties with parameters ready to start an export job.

public static Microsoft.Azure.Devices.JobProperties CreateForExportJob (string outputBlobContainerUri, bool excludeKeysInExport, string outputBlobName = default, Microsoft.Azure.Devices.StorageAuthenticationType? storageAuthenticationType = default, Microsoft.Azure.Devices.ManagedIdentity identity = default);

static member CreateForExportJob : string * bool * string * Nullable<Microsoft.Azure.Devices.StorageAuthenticationType> * Microsoft.Azure.Devices.ManagedIdentity -> Microsoft.Azure.Devices.JobProperties

Public Shared Function CreateForExportJob (outputBlobContainerUri As String, excludeKeysInExport As Boolean, Optional outputBlobName As String = Nothing, Optional storageAuthenticationType As Nullable(Of StorageAuthenticationType) = Nothing, Optional identity As ManagedIdentity = Nothing) As JobProperties

Parameters

outputBlobContainerUri

String

URI to a blob container. This is used to output the status of the job and the results. Including a SAS token is dependent on the StorageAuthenticationType parameter.

excludeKeysInExport

Boolean

Indicates if authorization keys are included in export output

outputBlobName

String

The name of the blob that will be created in the provided output blob container

storageAuthenticationType

Nullable<StorageAuthenticationType>

Specifies authentication type being used for connecting to storage account

identity

ManagedIdentity

User assigned managed identity used to access storage account for import and export jobs.

Returns

JobProperties

An instance of JobProperties