This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.47.1 published on Monday, Jun 24, 2024 by Pulumi
azure-native.azuredatatransfer.getFlow
Explore with Pulumi AI
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.47.1 published on Monday, Jun 24, 2024 by Pulumi
Gets flow resource. Azure REST API version: 2023-10-11-preview.
Other available API versions: 2024-01-25, 2024-05-07.
Using getFlow
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getFlow(args: GetFlowArgs, opts?: InvokeOptions): Promise<GetFlowResult>
function getFlowOutput(args: GetFlowOutputArgs, opts?: InvokeOptions): Output<GetFlowResult>
def get_flow(connection_name: Optional[str] = None,
flow_name: Optional[str] = None,
resource_group_name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetFlowResult
def get_flow_output(connection_name: Optional[pulumi.Input[str]] = None,
flow_name: Optional[pulumi.Input[str]] = None,
resource_group_name: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetFlowResult]
func LookupFlow(ctx *Context, args *LookupFlowArgs, opts ...InvokeOption) (*LookupFlowResult, error)
func LookupFlowOutput(ctx *Context, args *LookupFlowOutputArgs, opts ...InvokeOption) LookupFlowResultOutput
> Note: This function is named LookupFlow
in the Go SDK.
public static class GetFlow
{
public static Task<GetFlowResult> InvokeAsync(GetFlowArgs args, InvokeOptions? opts = null)
public static Output<GetFlowResult> Invoke(GetFlowInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetFlowResult> getFlow(GetFlowArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: azure-native:azuredatatransfer:getFlow
arguments:
# arguments dictionary
The following arguments are supported:
- Connection
Name string - The name for the connection that is to be requested.
- Flow
Name string - The name for the flow that is to be onboarded.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Connection
Name string - The name for the connection that is to be requested.
- Flow
Name string - The name for the flow that is to be onboarded.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- connection
Name String - The name for the connection that is to be requested.
- flow
Name String - The name for the flow that is to be onboarded.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- connection
Name string - The name for the connection that is to be requested.
- flow
Name string - The name for the flow that is to be onboarded.
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- connection_
name str - The name for the connection that is to be requested.
- flow_
name str - The name for the flow that is to be onboarded.
- resource_
group_ strname - The name of the resource group. The name is case insensitive.
- connection
Name String - The name for the connection that is to be requested.
- flow
Name String - The name for the flow that is to be onboarded.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
getFlow Result
The following output properties are available:
- Id string
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- Location string
- The geo-location where the resource lives
- Name string
- The name of the resource
- Properties
Pulumi.
Azure Native. Azure Data Transfer. Outputs. Flow Properties Response - Properties of flow
- System
Data Pulumi.Azure Native. Azure Data Transfer. Outputs. System Data Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Identity
Pulumi.
Azure Native. Azure Data Transfer. Outputs. Managed Service Identity Response - The managed identity of the flow resource, if configured.
- Plan
Pulumi.
Azure Native. Azure Data Transfer. Outputs. Plan Response - Plan for the resource.
- Dictionary<string, string>
- Resource tags.
- Id string
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- Location string
- The geo-location where the resource lives
- Name string
- The name of the resource
- Properties
Flow
Properties Response - Properties of flow
- System
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Identity
Managed
Service Identity Response - The managed identity of the flow resource, if configured.
- Plan
Plan
Response - Plan for the resource.
- map[string]string
- Resource tags.
- id String
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- location String
- The geo-location where the resource lives
- name String
- The name of the resource
- properties
Flow
Properties Response - Properties of flow
- system
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- identity
Managed
Service Identity Response - The managed identity of the flow resource, if configured.
- plan
Plan
Response - Plan for the resource.
- Map<String,String>
- Resource tags.
- id string
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- location string
- The geo-location where the resource lives
- name string
- The name of the resource
- properties
Flow
Properties Response - Properties of flow
- system
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- identity
Managed
Service Identity Response - The managed identity of the flow resource, if configured.
- plan
Plan
Response - Plan for the resource.
- {[key: string]: string}
- Resource tags.
- id str
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- location str
- The geo-location where the resource lives
- name str
- The name of the resource
- properties
Flow
Properties Response - Properties of flow
- system_
data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type str
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- identity
Managed
Service Identity Response - The managed identity of the flow resource, if configured.
- plan
Plan
Response - Plan for the resource.
- Mapping[str, str]
- Resource tags.
- id String
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- location String
- The geo-location where the resource lives
- name String
- The name of the resource
- properties Property Map
- Properties of flow
- system
Data Property Map - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- identity Property Map
- The managed identity of the flow resource, if configured.
- plan Property Map
- Plan for the resource.
- Map<String>
- Resource tags.
Supporting Types
FlowPropertiesResponse
- Flow
Id string - Dataflow GUID associated with this flow
- Link
Status string - Link status of the current flow
- Linked
Flow stringId - Resource ID of the linked flow
- Provisioning
State string - Provisioning state of the flow
- Connection
Pulumi.
Azure Native. Azure Data Transfer. Inputs. Selected Resource Response - The connection associated with this flow
- Data
Type string - Transfer Storage Blobs or Tables
- Flow
Type string - The flow type for this flow
- Key
Vault stringUri - AME, PME, or TORUS only! AKV Chain Containing SAS Token
- Policies List<string>
- The policies for this flow
- Schema
Pulumi.
Azure Native. Azure Data Transfer. Inputs. Schema Response - The selected schema for this flow
- Service
Bus stringQueue Id - Service Bus Queue ID
- Status string
- Status of the current flow
- Storage
Account stringId - Storage Account ID
- Storage
Account stringName - Storage Account
- Storage
Container stringName - Storage Container Name
- Flow
Id string - Dataflow GUID associated with this flow
- Link
Status string - Link status of the current flow
- Linked
Flow stringId - Resource ID of the linked flow
- Provisioning
State string - Provisioning state of the flow
- Connection
Selected
Resource Response - The connection associated with this flow
- Data
Type string - Transfer Storage Blobs or Tables
- Flow
Type string - The flow type for this flow
- Key
Vault stringUri - AME, PME, or TORUS only! AKV Chain Containing SAS Token
- Policies []string
- The policies for this flow
- Schema
Schema
Response - The selected schema for this flow
- Service
Bus stringQueue Id - Service Bus Queue ID
- Status string
- Status of the current flow
- Storage
Account stringId - Storage Account ID
- Storage
Account stringName - Storage Account
- Storage
Container stringName - Storage Container Name
- flow
Id String - Dataflow GUID associated with this flow
- link
Status String - Link status of the current flow
- linked
Flow StringId - Resource ID of the linked flow
- provisioning
State String - Provisioning state of the flow
- connection
Selected
Resource Response - The connection associated with this flow
- data
Type String - Transfer Storage Blobs or Tables
- flow
Type String - The flow type for this flow
- key
Vault StringUri - AME, PME, or TORUS only! AKV Chain Containing SAS Token
- policies List<String>
- The policies for this flow
- schema
Schema
Response - The selected schema for this flow
- service
Bus StringQueue Id - Service Bus Queue ID
- status String
- Status of the current flow
- storage
Account StringId - Storage Account ID
- storage
Account StringName - Storage Account
- storage
Container StringName - Storage Container Name
- flow
Id string - Dataflow GUID associated with this flow
- link
Status string - Link status of the current flow
- linked
Flow stringId - Resource ID of the linked flow
- provisioning
State string - Provisioning state of the flow
- connection
Selected
Resource Response - The connection associated with this flow
- data
Type string - Transfer Storage Blobs or Tables
- flow
Type string - The flow type for this flow
- key
Vault stringUri - AME, PME, or TORUS only! AKV Chain Containing SAS Token
- policies string[]
- The policies for this flow
- schema
Schema
Response - The selected schema for this flow
- service
Bus stringQueue Id - Service Bus Queue ID
- status string
- Status of the current flow
- storage
Account stringId - Storage Account ID
- storage
Account stringName - Storage Account
- storage
Container stringName - Storage Container Name
- flow_
id str - Dataflow GUID associated with this flow
- link_
status str - Link status of the current flow
- linked_
flow_ strid - Resource ID of the linked flow
- provisioning_
state str - Provisioning state of the flow
- connection
Selected
Resource Response - The connection associated with this flow
- data_
type str - Transfer Storage Blobs or Tables
- flow_
type str - The flow type for this flow
- key_
vault_ struri - AME, PME, or TORUS only! AKV Chain Containing SAS Token
- policies Sequence[str]
- The policies for this flow
- schema
Schema
Response - The selected schema for this flow
- service_
bus_ strqueue_ id - Service Bus Queue ID
- status str
- Status of the current flow
- storage_
account_ strid - Storage Account ID
- storage_
account_ strname - Storage Account
- storage_
container_ strname - Storage Container Name
- flow
Id String - Dataflow GUID associated with this flow
- link
Status String - Link status of the current flow
- linked
Flow StringId - Resource ID of the linked flow
- provisioning
State String - Provisioning state of the flow
- connection Property Map
- The connection associated with this flow
- data
Type String - Transfer Storage Blobs or Tables
- flow
Type String - The flow type for this flow
- key
Vault StringUri - AME, PME, or TORUS only! AKV Chain Containing SAS Token
- policies List<String>
- The policies for this flow
- schema Property Map
- The selected schema for this flow
- service
Bus StringQueue Id - Service Bus Queue ID
- status String
- Status of the current flow
- storage
Account StringId - Storage Account ID
- storage
Account StringName - Storage Account
- storage
Container StringName - Storage Container Name
ManagedServiceIdentityResponse
- Principal
Id string - The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
- Tenant
Id string - The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
- Type string
- Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
- User
Assigned Dictionary<string, Pulumi.Identities Azure Native. Azure Data Transfer. Inputs. User Assigned Identity Response> - 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.
- Principal
Id string - The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
- Tenant
Id string - The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
- Type string
- Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
- User
Assigned map[string]UserIdentities Assigned Identity Response - 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.
- principal
Id String - The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
- tenant
Id String - The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
- type String
- Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
- user
Assigned Map<String,UserIdentities Assigned Identity Response> - 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.
- principal
Id string - The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
- tenant
Id string - The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
- type string
- Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
- user
Assigned {[key: string]: UserIdentities Assigned Identity Response} - 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.
- principal_
id str - The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
- tenant_
id str - The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
- type str
- Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
- user_
assigned_ Mapping[str, Useridentities Assigned Identity Response] - 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.
- principal
Id String - The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
- tenant
Id String - The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
- type String
- Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
- user
Assigned Map<Property Map>Identities - 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.
PlanResponse
- Name string
- A user defined name of the 3rd Party Artifact that is being procured.
- Product string
- 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.
- Publisher string
- The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic
- Promotion
Code string - A publisher provided promotion code as provisioned in Data Market for the said product/artifact.
- Version string
- The version of the desired product/artifact.
- Name string
- A user defined name of the 3rd Party Artifact that is being procured.
- Product string
- 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.
- Publisher string
- The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic
- Promotion
Code string - A publisher provided promotion code as provisioned in Data Market for the said product/artifact.
- Version string
- The version of the desired product/artifact.
- name String
- A user defined name of the 3rd Party Artifact that is being procured.
- product String
- 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.
- publisher String
- The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic
- promotion
Code String - A publisher provided promotion code as provisioned in Data Market for the said product/artifact.
- version String
- The version of the desired product/artifact.
- name string
- A user defined name of the 3rd Party Artifact that is being procured.
- product string
- 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.
- publisher string
- The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic
- promotion
Code string - A publisher provided promotion code as provisioned in Data Market for the said product/artifact.
- version string
- The version of the desired product/artifact.
- name str
- A user defined name of the 3rd Party Artifact that is being procured.
- product str
- 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.
- publisher str
- The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic
- promotion_
code str - A publisher provided promotion code as provisioned in Data Market for the said product/artifact.
- version str
- The version of the desired product/artifact.
- name String
- A user defined name of the 3rd Party Artifact that is being procured.
- product String
- 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.
- publisher String
- The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic
- promotion
Code String - A publisher provided promotion code as provisioned in Data Market for the said product/artifact.
- version String
- The version of the desired product/artifact.
SchemaResponse
- Connection
Id string - Connection ID associated with this schema
- Content string
- Content of the schema
- Id string
- ID associated with this schema
- Name string
- Name of the schema
- Status string
- Status of the schema
- Connection
Id string - Connection ID associated with this schema
- Content string
- Content of the schema
- Id string
- ID associated with this schema
- Name string
- Name of the schema
- Status string
- Status of the schema
- connection
Id String - Connection ID associated with this schema
- content String
- Content of the schema
- id String
- ID associated with this schema
- name String
- Name of the schema
- status String
- Status of the schema
- connection
Id string - Connection ID associated with this schema
- content string
- Content of the schema
- id string
- ID associated with this schema
- name string
- Name of the schema
- status string
- Status of the schema
- connection_
id str - Connection ID associated with this schema
- content str
- Content of the schema
- id str
- ID associated with this schema
- name str
- Name of the schema
- status str
- Status of the schema
- connection
Id String - Connection ID associated with this schema
- content String
- Content of the schema
- id String
- ID associated with this schema
- name String
- Name of the schema
- status String
- Status of the schema
SelectedResourceResponse
- Id string
- Id of the connection
- Location string
- Location of the connection
- Name string
- Name of the connection
- Subscription
Name string - Name of the subscription with the connection
- Id string
- Id of the connection
- Location string
- Location of the connection
- Name string
- Name of the connection
- Subscription
Name string - Name of the subscription with the connection
- id String
- Id of the connection
- location String
- Location of the connection
- name String
- Name of the connection
- subscription
Name String - Name of the subscription with the connection
- id string
- Id of the connection
- location string
- Location of the connection
- name string
- Name of the connection
- subscription
Name string - Name of the subscription with the connection
- id str
- Id of the connection
- location str
- Location of the connection
- name str
- Name of the connection
- subscription_
name str - Name of the subscription with the connection
- id String
- Id of the connection
- location String
- Location of the connection
- name String
- Name of the connection
- subscription
Name String - Name of the subscription with the connection
SystemDataResponse
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - The type of identity that last modified the resource.
- created_
at str - The timestamp of resource creation (UTC).
- created_
by str - The identity that created the resource.
- created_
by_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The timestamp of resource last modification (UTC)
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
UserAssignedIdentityResponse
- Client
Id string - The client ID of the assigned identity.
- Principal
Id string - The principal ID of the assigned identity.
- Client
Id string - The client ID of the assigned identity.
- Principal
Id string - The principal ID of the assigned identity.
- client
Id String - The client ID of the assigned identity.
- principal
Id String - The principal ID of the assigned identity.
- client
Id string - The client ID of the assigned identity.
- principal
Id string - The principal ID of the assigned identity.
- client_
id str - The client ID of the assigned identity.
- principal_
id str - The principal ID of the assigned identity.
- client
Id String - The client ID of the assigned identity.
- principal
Id String - The principal ID of the assigned identity.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.47.1 published on Monday, Jun 24, 2024 by Pulumi