DestinationProperties Class

  • Reference

Definition

Namespace:
Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202301Preview
Assembly:
Az.EventHub.private.dll

Properties describing the storage account, blob container and archive name format for capture destination

[Microsoft.Azure.PowerShell.Cmdlets.EventHub.DoNotFormat]
[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202301Preview.DestinationPropertiesTypeConverter))]
public class DestinationProperties : Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202301Preview.IDestinationProperties
[<Microsoft.Azure.PowerShell.Cmdlets.EventHub.DoNotFormat>]
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202301Preview.DestinationPropertiesTypeConverter))>]
type DestinationProperties = class
    interface IDestinationProperties
    interface IJsonSerializable
Public Class DestinationProperties
Implements IDestinationProperties
Inheritance
Object
DestinationProperties
Attributes
DoNotFormatAttribute TypeConverterAttribute
Implements
IDestinationProperties IJsonSerializable

Constructors

DestinationProperties()

Creates an new DestinationProperties instance.

Properties

ArchiveNameFormat

Blob naming convention for archive, e.g. {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}. Here all the parameters (Namespace,EventHub .. etc) are mandatory irrespective of order
BlobContainer

Blob container Name
DataLakeAccountName

The Azure Data Lake Store name for the captured events
DataLakeFolderPath

The destination folder path for the captured events
DataLakeSubscriptionId

Subscription Id of Azure Data Lake Store
StorageAccountResourceId

Resource id of the storage account to be used to create the blobs

Methods

DeserializeFromDictionary(IDictionary)

Deserializes a IDictionary into an instance of DestinationProperties.
DeserializeFromPSObject(PSObject)

Deserializes a PSObject into an instance of DestinationProperties.
FromJson(JsonNode)

Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202301Preview.IDestinationProperties.
FromJsonString(String)

Creates a new instance of DestinationProperties, deserializing the content from a json string.
ToJson(JsonObject, SerializationMode)

Serializes this instance of DestinationProperties into a JsonNode.
ToJsonString()

Serializes this instance to a json string.
ToString()

Applies to