Flow Class

Definition

Namespace:

ADT.Models

Assembly:

Az.DataTransfer.private.dll

The flow resource definition.

[System.ComponentModel.TypeConverter(typeof(ADT.Models.FlowTypeConverter))]
public class Flow : ADT.Models.IFlow, ADT.Runtime.IValidates

[<System.ComponentModel.TypeConverter(typeof(ADT.Models.FlowTypeConverter))>]
type Flow = class
    interface IFlow
    interface IJsonSerializable
    interface ITrackedResource
    interface IResource
    interface IValidates

Public Class Flow
Implements IFlow, IValidates

Inheritance

Object

Flow

Attributes

TypeConverterAttribute

Implements

IFlow IResource ITrackedResource IJsonSerializable IValidates

Constructors

Name	Description
Flow()	Creates an new Flow 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
Id	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
IdentityPrincipalId	The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
IdentityTenantId	The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
IdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
IdentityUserAssignedIdentity	The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
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
Location	The geo-location where the resource lives
MessagingOptionBillingTier	Billing tier for this messaging flow
Name	The name of the resource
Passphrase	The passphrase used for SRT streams
PlanName	A user defined name of the 3rd Party Artifact that is being procured.
PlanProduct	The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding.
PlanPromotionCode	A publisher provided promotion code as provisioned in Data Market for the said product/artifact.
PlanPublisher	The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic
PlanVersion	The version of the desired product/artifact.
Policy	The policies for this flow
ProvisioningState	Provisioning state of the flow
ResourceGroupName	Gets the resource group name
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
SystemDataCreatedAt	The timestamp of resource creation (UTC).
SystemDataCreatedBy	The identity that created the resource.
SystemDataCreatedByType	The type of identity that created the resource.
SystemDataLastModifiedAt	The timestamp of resource last modification (UTC)
SystemDataLastModifiedBy	The identity that last modified the resource.
SystemDataLastModifiedByType	The type of identity that last modified the resource.
Tag	Resource tags.
Type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Methods

Name	Description
DeserializeFromDictionary(IDictionary)	Deserializes a IDictionary into an instance of Flow.
DeserializeFromPSObject(PSObject)	Deserializes a PSObject into an instance of Flow.
FromJson(JsonNode)	Deserializes a JsonNode into an instance of ADT.Models.IFlow.
FromJsonString(String)	Creates a new instance of Flow, deserializing the content from a json string.
ToJson(JsonObject, SerializationMode)	Serializes this instance of Flow into a JsonNode.
ToJsonString()	Serializes this instance to a json string.
ToString()
Validate(IEventListener)	Validates that this object meets the validation criteria.