configurations
Creates, updates, deletes, gets or lists a configurations resource.
Overview
| Name | configurations |
| Type | Resource |
| Id | azure.event_hubs.configurations |
Fields
The following fields are returned by SELECT queries:
- get
Event Hubs Cluster settings configuration returned.
| Name | Datatype | Description |
|---|---|---|
settings | object | All possible Cluster settings - a collection of key/value paired settings which apply to quotas and configurations imposed on the cluster. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | subscriptionId, resourceGroupName, clusterName | Get all Event Hubs Cluster settings - a collection of key/value pairs which represent the quotas and settings imposed on the cluster. | |
patch | update | subscriptionId, resourceGroupName, clusterName, data__settings | Replace all specified Event Hubs Cluster settings with those contained in the request body. Leaves the settings not specified in the request body unmodified. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
clusterName | string | The name of the Event Hubs Cluster. |
resourceGroupName | string | Name of the resource group within the azure subscription. |
subscriptionId | string | Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
SELECT examples
- get
Get all Event Hubs Cluster settings - a collection of key/value pairs which represent the quotas and settings imposed on the cluster.
SELECT
settings
FROM azure.event_hubs.configurations
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND clusterName = '{{ clusterName }}' -- required
;
UPDATE examples
- patch
Replace all specified Event Hubs Cluster settings with those contained in the request body. Leaves the settings not specified in the request body unmodified.
UPDATE azure.event_hubs.configurations
SET
data__settings = '{{ settings }}'
WHERE
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND clusterName = '{{ clusterName }}' --required
AND data__settings = '{{ settings }}' --required
RETURNING
settings;