configuration
Creates, updates, deletes, gets or lists a configuration resource.
Overview​
| Name | configuration |
| Type | Resource |
| Id | azure.event_hub.configuration |
Fields​
The following fields are returned by SELECT queries:
- get
| 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 | resource_group_name, cluster_name, subscription_id | Get all Event Hubs Cluster settings - a collection of key/value pairs which represent the quotas and settings imposed on the cluster. | |
patch | exec | resource_group_name, cluster_name, subscription_id | 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 |
|---|---|---|
cluster_name | string | The name of the Event Hubs Cluster. Required. |
resource_group_name | string | Name of the resource group within the azure subscription. Required. |
subscription_id | string |
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_hub.configuration
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;
Lifecycle Methods​
- 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.
EXEC azure.event_hub.configuration.patch
@resource_group_name='{{ resource_group_name }}' --required,
@cluster_name='{{ cluster_name }}' --required,
@subscription_id='{{ subscription_id }}' --required
@@json=
'{
"settings": "{{ settings }}"
}'
;