az oracle-database golden-gate-connection

Note

This reference is part of the oracle-database extension for the Azure CLI (version 2.75.0 or higher). The extension will automatically install the first time you run an az oracle-database golden-gate-connection command. Learn more about extensions.

Manage Golden Gate Connection.

Commands

Name	Description	Type	Status
az oracle-database golden-gate-connection assign-deployment	Assign a GoldenGate deployment to a connection.	Extension	GA
az oracle-database golden-gate-connection assigned-deployment	Manage Assigned Deployment.	Extension	GA
az oracle-database golden-gate-connection assigned-deployment list	List assigned deployments by GoldenGate connection.	Extension	GA
az oracle-database golden-gate-connection assigned-deployment show	Get assigned deployment by GoldenGate connection.	Extension	GA
az oracle-database golden-gate-connection create	Create a GoldenGateConnection.	Extension	GA
az oracle-database golden-gate-connection delete	Delete a GoldenGateConnection.	Extension	GA
az oracle-database golden-gate-connection list	List GoldenGateConnection resources by subscription ID.	Extension	GA
az oracle-database golden-gate-connection show	Get a GoldenGateConnection.	Extension	GA
az oracle-database golden-gate-connection unassign-deployment	Unassign a GoldenGate deployment from a connection.	Extension	GA
az oracle-database golden-gate-connection update	Update a GoldenGateConnection.	Extension	GA
az oracle-database golden-gate-connection wait	Place the CLI in a waiting state until a condition is met.	Extension	GA

az oracle-database golden-gate-connection assign-deployment

Assign a GoldenGate deployment to a connection.

az oracle-database golden-gate-connection assign-deployment --deployment-id
                                                            [--acquire-policy-token]
                                                            [--change-reference]
                                                            [--golden-gate-connection-name]
                                                            [--ids]
                                                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                            [--resource-group]
                                                            [--subscription]

Examples

Assign a deployment to a GoldenGate connection.

az oracle-database golden-gate-connection assign-deployment -g MyResourceGroup --golden-gate-connection-name myConnection --deployment-id /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/Oracle.Database/goldenGateDeployments/myDeployment

Required Parameters

--deployment-id

The Azure resource ID of the deployment to assign or unassign.

Property	Value
Parameter group:	Body 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.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--golden-gate-connection-name

The name of the GoldenGateConnection.

Property	Value
Parameter group:	Resource Id Arguments

--ids

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

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az oracle-database golden-gate-connection create

Create a GoldenGateConnection.

az oracle-database golden-gate-connection create --golden-gate-connection-name --name
                                                 --resource-group
                                                 [--acquire-policy-token]
                                                 [--change-reference]
                                                 [--display-name]
                                                 [--does-use-secret-ids {0, 1, f, false, n, no, t, true, y, yes}]
                                                 [--kafka]
                                                 [--key-id]
                                                 [--location]
                                                 [--microsoft-fabric]
                                                 [--network-anchor-id]
                                                 [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                 [--oracle]
                                                 [--resource-anchor-id]
                                                 [--routing-method {DEDICATED_ENDPOINT, SHARED_DEPLOYMENT_ENDPOINT, SHARED_SERVICE_ENDPOINT}]
                                                 [--tags]
                                                 [--vault-id]
                                                 [--zones]

Examples

Create an Oracle GoldenGate connection.

az oracle-database golden-gate-connection create -g MyResourceGroup -n myConnection --location eastus --display-name myConnection --resource-anchor-id /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/Oracle.Database/resourceAnchors/myResourceAnchor --network-anchor-id /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/Oracle.Database/networkAnchors/myNetworkAnchor --zones 1 --oracle "{technology-type:ORACLE_DATABASE,username:admin}"

Required Parameters

--golden-gate-connection-name --name -n

The name of the GoldenGateConnection.

--resource-group -g

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.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--display-name

The connection display name.

Property	Value
Parameter group:	Properties Arguments

--does-use-secret-ids

Indicates whether secret OCIDs are used for credential fields.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--kafka

Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--key-id

The customer's master key OCID.

Property	Value
Parameter group:	Properties Arguments

--location -l

The geo-location where the resource lives When not specified, the location of the resource group will be used.

Property	Value
Parameter group:	Resource Arguments

--microsoft-fabric

Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--network-anchor-id

The corresponding network anchor Azure ID.

Property	Value
Parameter group:	Properties Arguments

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--oracle

Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--resource-anchor-id

The corresponding resource anchor Azure ID.

Property	Value
Parameter group:	Properties Arguments

--routing-method

Controls the network traffic direction to the target.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	DEDICATED_ENDPOINT, SHARED_DEPLOYMENT_ENDPOINT, SHARED_SERVICE_ENDPOINT

--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Resource Arguments

--vault-id

The customer's vault OCID.

Property	Value
Parameter group:	Properties Arguments

--zones

The availability zones. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Resource Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az oracle-database golden-gate-connection delete

Delete a GoldenGateConnection.

az oracle-database golden-gate-connection delete [--acquire-policy-token]
                                                 [--change-reference]
                                                 [--golden-gate-connection-name --name]
                                                 [--ids]
                                                 [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                 [--resource-group]
                                                 [--subscription]
                                                 [--yes]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--golden-gate-connection-name --name -n

The name of the GoldenGateConnection.

Property	Value
Parameter group:	Resource Id Arguments

--ids

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

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

--yes -y

Do not prompt for confirmation.

Property	Value
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az oracle-database golden-gate-connection list

List GoldenGateConnection resources by subscription ID.

az oracle-database golden-gate-connection list [--max-items]
                                               [--next-token]
                                               [--resource-group]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--max-items

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

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Property	Value
Parameter group:	Pagination Arguments

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az oracle-database golden-gate-connection show

Get a GoldenGateConnection.

az oracle-database golden-gate-connection show [--golden-gate-connection-name --name]
                                               [--ids]
                                               [--resource-group]
                                               [--subscription]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--golden-gate-connection-name --name -n

The name of the GoldenGateConnection.

Property	Value
Parameter group:	Resource Id Arguments

--ids

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

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az oracle-database golden-gate-connection unassign-deployment

Unassign a GoldenGate deployment from a connection.

az oracle-database golden-gate-connection unassign-deployment --deployment-id
                                                              [--acquire-policy-token]
                                                              [--change-reference]
                                                              [--golden-gate-connection-name]
                                                              [--ids]
                                                              [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                              [--resource-group]
                                                              [--subscription]

Examples

Unassign a deployment from a GoldenGate connection.

az oracle-database golden-gate-connection unassign-deployment -g MyResourceGroup --golden-gate-connection-name myConnection --deployment-id /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/Oracle.Database/goldenGateDeployments/myDeployment

Required Parameters

--deployment-id

The Azure resource ID of the deployment to assign or unassign.

Property	Value
Parameter group:	Body 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.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--golden-gate-connection-name

The name of the GoldenGateConnection.

Property	Value
Parameter group:	Resource Id Arguments

--ids

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

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az oracle-database golden-gate-connection update

Update a GoldenGateConnection.

az oracle-database golden-gate-connection update [--acquire-policy-token]
                                                 [--add]
                                                 [--change-reference]
                                                 [--display-name]
                                                 [--does-use-secret-ids {0, 1, f, false, n, no, t, true, y, yes}]
                                                 [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                                 [--golden-gate-connection-name --name]
                                                 [--ids]
                                                 [--kafka]
                                                 [--key-id]
                                                 [--microsoft-fabric]
                                                 [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                 [--oracle]
                                                 [--remove]
                                                 [--resource-group]
                                                 [--routing-method {DEDICATED_ENDPOINT, SHARED_DEPLOYMENT_ENDPOINT, SHARED_SERVICE_ENDPOINT}]
                                                 [--set]
                                                 [--subscription]
                                                 [--tags]
                                                 [--vault-id]
                                                 [--zones]

Examples

Update a GoldenGate connection's display name.

az oracle-database golden-gate-connection update -g MyResourceGroup -n myConnection --display-name updatedConnection

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

Property	Value
Parameter group:	Generic Update Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--display-name

The connection display name.

Property	Value
Parameter group:	Properties Arguments

--does-use-secret-ids

Indicates whether secret OCIDs are used for credential fields.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Property	Value
Parameter group:	Generic Update Arguments
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--golden-gate-connection-name --name -n

The name of the GoldenGateConnection.

Property	Value
Parameter group:	Resource Id Arguments

--ids

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

--kafka

Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--key-id

The customer's master key OCID.

Property	Value
Parameter group:	Properties Arguments

--microsoft-fabric

Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--oracle

Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Property	Value
Parameter group:	Generic Update Arguments

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property	Value
Parameter group:	Resource Id Arguments

--routing-method

Controls the network traffic direction to the target.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	DEDICATED_ENDPOINT, SHARED_DEPLOYMENT_ENDPOINT, SHARED_SERVICE_ENDPOINT

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

Property	Value
Parameter group:	Generic Update Arguments

--subscription

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

--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Resource Arguments

--vault-id

The customer's vault OCID.

Property	Value
Parameter group:	Properties Arguments

--zones

The availability zones. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Resource Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az oracle-database golden-gate-connection wait

Place the CLI in a waiting state until a condition is met.

az oracle-database golden-gate-connection wait [--acquire-policy-token]
                                               [--change-reference]
                                               [--created]
                                               [--custom]
                                               [--deleted]
                                               [--exists]
                                               [--golden-gate-connection-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.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--custom

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

--deleted

Wait until deleted.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--exists

Wait until the resource exists.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--golden-gate-connection-name --name -n

The name of the GoldenGateConnection.

Property	Value
Parameter group:	Resource Id Arguments

--ids

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

--interval

Polling interval in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	30

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

--timeout

Maximum wait in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False