FlowProperties Class

Definition

Namespace:: ADT.Models

Assembly:: Az.DataTransfer.private.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Properties of flow

[System.ComponentModel.TypeConverter(typeof(ADT.Models.FlowPropertiesTypeConverter))]
public class FlowProperties : ADT.Models.IFlowProperties

[<System.ComponentModel.TypeConverter(typeof(ADT.Models.FlowPropertiesTypeConverter))>]
type FlowProperties = class
    interface IFlowProperties
    interface IJsonSerializable

Public Class FlowProperties
Implements IFlowProperties

Inheritance: Object
FlowProperties

Attributes: TypeConverterAttribute

Implements: IFlowProperties IJsonSerializable

Constructors

Name	Description
FlowProperties()	Creates an new FlowProperties instance.

Properties

Name	Description
ApiFlowOptionApiMode	Remote Calling Mode in the Azure Data Transfer API Flow, which describes how the API Flow will be invoked
ApiFlowOptionAudienceOverride	Optional field to override the audience of the remote endpoint
ApiFlowOptionCname	Unique CNAME to represent the Azure Data Transfer API Flow instance
ApiFlowOptionIdentityTranslation	Flag for if Azure Data Transfer API Flow should extract the user token
ApiFlowOptionRemoteCallingModeClientId	Remote stub app registration Client ID
ApiFlowOptionRemoteEndpoint	Remote host to which communication needs to be made
ApiFlowOptionSenderClientId	Sender's app user assigned Manage Identity client ID
ConnectionId	Id of the connection
ConnectionLocation	Location of the connection
ConnectionName	Name of the connection
ConnectionSubscriptionName	Name of the subscription with the connection
ConsumerGroup	Event Hub Consumer Group
CustomerManagedKeyVaultUri	The URI to the customer managed key for this flow
DataType	Type of data to transfer via the flow.
DestinationEndpoint	The destination endpoints of the stream
DestinationEndpointPort	The destination endpoint ports of the stream
EventHubId	Event Hub ID
FlowId	Dataflow GUID associated with this flow
FlowType	The flow type for this flow
ForceDisabledStatus	Force disablement status of the current flow
KeyVaultUri	URI to a Key Vault Secret containing a SAS token.
LinkedFlowId	Resource ID of the linked flow
LinkStatus	Link status of the current flow
MessagingOptionBillingTier	Billing tier for this messaging flow
Passphrase	The passphrase used for SRT streams
Policy	The policies for this flow
ProvisioningState	Provisioning state of the flow
SchemaConnectionId	Connection ID associated with this schema
SchemaContent	Content of the schema
SchemaDirection	The direction of the schema.
SchemaId	ID associated with this schema
SchemaName	Name of the schema
SchemaStatus	Status of the schema
SchemaType	The Schema Type
SchemaUri	Uri containing SAS token for the zipped schema
ServiceBusQueueId	Service Bus Queue ID
SourceAddressSourceAddresses	A source IP address or CIDR range
Status	Status of the current flow
StorageAccountId	Storage Account ID
StorageAccountName	Storage Account
StorageContainerName	Storage Container Name
StorageTableName	Storage Table Name
StreamId	The flow stream identifier
StreamLatency	The latency of the stream in milliseconds
StreamProtocol	The protocol of the stream

Methods

Name	Description
DeserializeFromDictionary(IDictionary)	Deserializes a IDictionary into an instance of FlowProperties.
DeserializeFromPSObject(PSObject)	Deserializes a PSObject into an instance of FlowProperties.
FromJson(JsonNode)	Deserializes a JsonNode into an instance of ADT.Models.IFlowProperties.
FromJsonString(String)	Creates a new instance of FlowProperties, deserializing the content from a json string.
ToJson(JsonObject, SerializationMode)	Serializes this instance of FlowProperties into a JsonNode.
ToJsonString()	Serializes this instance to a json string.
ToString()

Applies to