az data-transfer connection flow
Note
This reference is part of the data-transfer extension for the Azure CLI (version 2.0.24 or higher). The extension will automatically install the first time you run an az data-transfer connection flow command. Learn more about extensions.
Command group 'az data-transfer connection' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Data transfer flow commands.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az data-transfer connection flow create |
Create data flow for the approved connection. |
Extension | Preview |
| az data-transfer connection flow delete |
Delete data flow for the approved connection. |
Extension | Preview |
| az data-transfer connection flow disable |
Disables the specified flow in the connection. |
Extension | Preview |
| az data-transfer connection flow enable |
Enables the specified flow in the connection. |
Extension | Preview |
| az data-transfer connection flow link |
Links the specified flow in the connection. |
Extension | Preview |
| az data-transfer connection flow list |
List all the flows in a connection. |
Extension | Preview |
| az data-transfer connection flow show |
Show a specific flow in the connection. |
Extension | Preview |
| az data-transfer connection flow update |
Update the flow resource. |
Extension | Preview |
| az data-transfer connection flow wait |
Place the CLI in a waiting state until a condition is met. |
Extension | Preview |
az data-transfer connection flow create
Command group 'az data-transfer connection flow' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Create data flow for the approved connection.
az data-transfer connection flow create --connection-name
--flow-name --name
--resource-group
[--api-flow-options]
[--consumer-group]
[--customer-key-vault-uri]
[--data-type {Blob, Table}]
[--destination-endpoints]
[--endpoint-ports]
[--event-hub-id]
[--flow-type {API, BasicFiles, Complex, Data, DevSecOps, DiskImages, Messaging, MicrosoftInternal, Mission, MissionOpaqueXML, Opaque, Standard, StreamingVideo, Unknown}]
[--location]
[--messaging-options]
[--mi-system-assigned --system-assigned]
[--mi-user-assigned --user-assigned]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--passphrase]
[--plan]
[--schema]
[--service-bus-queue-id]
[--source-addresses]
[--status {Disabled, Enabled}]
[--storage-account]
[--storage-container-name]
[--storage-table-name]
[--stream-id]
[--stream-latency]
[--stream-protocol {RTP, SRT, UDP}]
[--tags]
Examples
Creates the flow resource
az data-transfer connection flow create --resource-group testRG --connection-name testConnection --flow-name testFlow --location East US --connection --flow-type Complex --storage-account /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rpaas-rg/providers/Private.AzureDataTransfer/storageAccounts/testsa --storage-container-name testcontainer
Required Parameters
The name for the connection to perform the operation on.
The name for the flow to perform the operation on.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
The API Flow configuration options for Azure Data Transfer API Flow type. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
Event Hub Consumer Group.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
The URI to the customer managed key for this flow.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
Type of data to transfer via the flow.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
| Accepted values: | Blob, Table |
The destination endpoints of the stream Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
The destination endpoint ports of the stream Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
Event Hub ID.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
The flow type for this flow.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
| Accepted values: | API, BasicFiles, Complex, Data, DevSecOps, DiskImages, Messaging, MicrosoftInternal, Mission, MissionOpaqueXML, Opaque, Standard, StreamingVideo, Unknown |
The geo-location where the resource lives When not specified, the location of the resource group will be used.
| Property | Value |
|---|---|
| Parameter group: | Flow Arguments |
The messaging options for this flow Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
Set the system managed identity.
| Property | Value |
|---|---|
| Parameter group: | Identity Arguments |
Set the user managed identities. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
| Property | Value |
|---|---|
| Parameter group: | Identity Arguments |
Do not wait for the long-running operation to finish.
| Property | Value |
|---|---|
| Accepted values: | 0, 1, f, false, n, no, t, true, y, yes |
The passphrase used for SRT streams.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
Details of the resource plan. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
| Property | Value |
|---|---|
| Parameter group: | Flow Arguments |
The selected schema for this flow Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
Service Bus Queue ID.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
The source IP address and CIDR ranges of the stream Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
Status of the current flow.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
| Accepted values: | Disabled, Enabled |
Storage Account Id.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
Storage Container Name.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
Storage Table Name.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
The flow stream identifier.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
The latency of the stream in milliseconds.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
The protocol of the stream.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
| Accepted values: | RTP, SRT, UDP |
Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
| Property | Value |
|---|---|
| Parameter group: | Flow Arguments |
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az data-transfer connection flow delete
Command group 'az data-transfer connection flow' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Delete data flow for the approved connection.
Deletes the flow specified by ids or by name along with its associated connection name and resouce group.
az data-transfer connection flow delete [--connection-name]
[--flow-name --name]
[--ids]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
[--yes]
Examples
Deletes the flow resource
az data-transfer connection flow delete --resource-group testRG --connection-name testConnection --flow-name testFlow
az data-transfer connection flow delete --ids /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
The name for the connection to perform the operation on.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
The name for the flow to perform the operation on.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Do not wait for the long-running operation to finish.
| Property | Value |
|---|---|
| Accepted values: | 0, 1, f, false, n, no, t, true, y, yes |
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Do not prompt for confirmation.
| Property | Value |
|---|---|
| Default value: | False |
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az data-transfer connection flow disable
Command group 'az data-transfer connection flow' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Disables the specified flow in the connection.
az data-transfer connection flow disable [--connection-name]
[--flow-name --name]
[--ids]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
Examples
Disables the specified flow
az data-transfer connection flow disable --resource-group testRG --connection-name testConnection --flow-name testFlow
az data-transfer connection flow disable --ids /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
The name for the connection to perform the operation on.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
The name for the flow to perform the operation on.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Do not wait for the long-running operation to finish.
| Property | Value |
|---|---|
| Accepted values: | 0, 1, f, false, n, no, t, true, y, yes |
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az data-transfer connection flow enable
Command group 'az data-transfer connection flow' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Enables the specified flow in the connection.
az data-transfer connection flow enable [--connection-name]
[--flow-name --name]
[--ids]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
Examples
Enables the specified flow
az data-transfer connection flow enable --resource-group testRG --connection-name testConnection --flow-name testFlow
az data-transfer connection flow enable --ids /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
The name for the connection to perform the operation on.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
The name for the flow to perform the operation on.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Do not wait for the long-running operation to finish.
| Property | Value |
|---|---|
| Accepted values: | 0, 1, f, false, n, no, t, true, y, yes |
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az data-transfer connection flow link
Command group 'az data-transfer connection flow' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Links the specified flow in the connection.
az data-transfer connection flow link --id --pending-flow-id
[--connection-name]
[--flow-name --name]
[--ids]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--status-reason]
[--subscription]
Examples
Links the specified flow
az data-transfer connection flow link --resource-group testRG --connection-name receiveConnection --flow-name receiveFlow --id /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/sendConnection/flows/sendFlow
az data-transfer connection flow link --ids /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/receiveConnection/testConnection/flows/receiveFlow --pending-flow-id /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/sendConnection/flows/sendFlow
Required Parameters
ID of the resource.
| Property | Value |
|---|---|
| Parameter group: | Flow Arguments |
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
The name for the connection to perform the operation on.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
The name for the flow to perform the operation on.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Do not wait for the long-running operation to finish.
| Property | Value |
|---|---|
| Accepted values: | 0, 1, f, false, n, no, t, true, y, yes |
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Reason for resource operation.
| Property | Value |
|---|---|
| Parameter group: | Flow Arguments |
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az data-transfer connection flow list
Command group 'az data-transfer connection flow' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
List all the flows in a connection.
az data-transfer connection flow list --connection-name
--resource-group
[--max-items]
[--next-token]
Examples
Gets flows in a connection
az data-transfer connection flow list --resource-group testRG --connection-name testConnection
Required Parameters
The name for the connection to perform the operation on.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.
| Property | Value |
|---|---|
| Parameter group: | Pagination Arguments |
Token to specify where to start paginating. This is the token value from a previously truncated response.
| Property | Value |
|---|---|
| Parameter group: | Pagination Arguments |
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az data-transfer connection flow show
Command group 'az data-transfer connection flow' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Show a specific flow in the connection.
Show specific flow with given ids or name.
az data-transfer connection flow show [--connection-name]
[--flow-name --name]
[--ids]
[--resource-group]
[--subscription]
Examples
Gets flow resource
az data-transfer connection flow show --resource-group testRG --connection-name testConnection --flow-name testFlow
az data-transfer connection flow show --ids /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
The name for the connection to perform the operation on.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
The name for the flow to perform the operation on.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az data-transfer connection flow update
Command group 'az data-transfer connection flow' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Update the flow resource.
az data-transfer connection flow update [--connection-name]
[--flow-name --name]
[--ids]
[--mi-system-assigned --system-assigned]
[--mi-user-assigned --user-assigned]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
[--tags]
Examples
Update the flow
az data-transfer connection flow --resource-group testRG --connection testConnection --name testFlow --tags key1=value1 key2=value2
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
The name for the connection to perform the operation on.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
The name for the flow to perform the operation on.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Set the system managed identity.
| Property | Value |
|---|---|
| Parameter group: | Identity Arguments |
Set the user managed identities. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
| Property | Value |
|---|---|
| Parameter group: | Identity Arguments |
Do not wait for the long-running operation to finish.
| Property | Value |
|---|---|
| Accepted values: | 0, 1, f, false, n, no, t, true, y, yes |
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
| Property | Value |
|---|---|
| Parameter group: | Flow Arguments |
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az data-transfer connection flow wait
Command group 'az data-transfer connection flow' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Place the CLI in a waiting state until a condition is met.
az data-transfer connection flow wait [--connection-name]
[--created]
[--custom]
[--deleted]
[--exists]
[--flow-name --name]
[--ids]
[--interval]
[--resource-group]
[--subscription]
[--timeout]
[--updated]
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
The name for the connection to perform the operation on.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Wait until created with 'provisioningState' at 'Succeeded'.
| Property | Value |
|---|---|
| Parameter group: | Wait Condition Arguments |
| Default value: | False |
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
| Property | Value |
|---|---|
| Parameter group: | Wait Condition Arguments |
Wait until deleted.
| Property | Value |
|---|---|
| Parameter group: | Wait Condition Arguments |
| Default value: | False |
Wait until the resource exists.
| Property | Value |
|---|---|
| Parameter group: | Wait Condition Arguments |
| Default value: | False |
The name for the flow to perform the operation on.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Polling interval in seconds.
| Property | Value |
|---|---|
| Parameter group: | Wait Condition Arguments |
| Default value: | 30 |
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Maximum wait in seconds.
| Property | Value |
|---|---|
| Parameter group: | Wait Condition Arguments |
| Default value: | 3600 |
Wait until updated with provisioningState at 'Succeeded'.
| Property | Value |
|---|---|
| Parameter group: | Wait Condition Arguments |
| Default value: | False |
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |