Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions Commands/horizondb/cluster/pool/maintenance-event/_list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _horizondb cluster pool maintenance-event list_

List maintenance events for a HorizonDB pool. Use the OData $filter query parameter to filter by properties/status with the eq and or operators. For example, properties/status eq 'Planned' or properties/status eq 'InProgress' returns upcoming events.

## Versions

### [2026-10-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5ob3Jpem9uZGIvY2x1c3RlcnMve30vcG9vbHMve30vbWFpbnRlbmFuY2VldmVudHM=/2026-10-01-preview.xml) **Preview**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.horizondb/clusters/{}/pools/{}/maintenanceevents 2026-10-01-preview -->

#### examples

- List maintenance events for a HorizonDB pool.
```bash
horizon-db cluster pool maintenance-event list --resource-group example-resource-group --cluster-name example-cluster --pool-name example-pool-01
```
16 changes: 16 additions & 0 deletions Commands/horizondb/cluster/pool/maintenance-event/_show.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _horizondb cluster pool maintenance-event show_

Get information about a maintenance event for a HorizonDB pool.

## Versions

### [2026-10-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5ob3Jpem9uZGIvY2x1c3RlcnMve30vcG9vbHMve30vbWFpbnRlbmFuY2VldmVudHMve30=/2026-10-01-preview.xml) **Preview**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.horizondb/clusters/{}/pools/{}/maintenanceevents/{} 2026-10-01-preview -->

#### examples

- Get information about a maintenance event for a HorizonDB pool.
```bash
horizon-db cluster pool maintenance-event show --resource-group example-resource-group --cluster-name example-cluster --pool-name example-pool-01 --name ABCD-123
```
11 changes: 11 additions & 0 deletions Commands/horizondb/cluster/pool/maintenance-event/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# [Group] _horizondb cluster pool maintenance-event_

Manage Maintenance Event

## Commands

- [list](/Commands/horizondb/cluster/pool/maintenance-event/_list.md)
: List maintenance events for a HorizonDB pool. Use the OData $filter query parameter to filter by properties/status with the eq and or operators. For example, properties/status eq 'Planned' or properties/status eq 'InProgress' returns upcoming events.

- [show](/Commands/horizondb/cluster/pool/maintenance-event/_show.md)
: Get information about a maintenance event for a HorizonDB pool.
3 changes: 3 additions & 0 deletions Commands/horizondb/cluster/pool/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ Manage HorizonDB Pool
- [firewall-rule](/Commands/horizondb/cluster/pool/firewall-rule/readme.md)
: Manage Firewall Rule

- [maintenance-event](/Commands/horizondb/cluster/pool/maintenance-event/readme.md)
: Manage Maintenance Event

## Commands

- [create](/Commands/horizondb/cluster/pool/_create.md)
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"plane": "mgmt-plane", "resources": [{"id": "/subscriptions/{}/resourcegroups/{}/providers/microsoft.horizondb/clusters/{}/pools/{}/maintenanceevents", "version": "2026-10-01-preview", "swagger": "mgmt-plane/horizondb/ResourceProviders/Microsoft.HorizonDb/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9yZXNvdXJjZUdyb3Vwcy97cmVzb3VyY2VHcm91cE5hbWV9L3Byb3ZpZGVycy9NaWNyb3NvZnQuSG9yaXpvbkRiL2NsdXN0ZXJzL3tjbHVzdGVyTmFtZX0vcG9vbHMve3Bvb2xOYW1lfS9tYWludGVuYW5jZUV2ZW50cw==/V/MjAyNi0xMC0wMS1wcmV2aWV3"}], "commandGroups": [{"name": "horizondb cluster pool maintenance-event", "commands": [{"name": "list", "version": "2026-10-01-preview", "resources": [{"id": "/subscriptions/{}/resourcegroups/{}/providers/microsoft.horizondb/clusters/{}/pools/{}/maintenanceevents", "version": "2026-10-01-preview", "swagger": "mgmt-plane/horizondb/ResourceProviders/Microsoft.HorizonDb/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9yZXNvdXJjZUdyb3Vwcy97cmVzb3VyY2VHcm91cE5hbWV9L3Byb3ZpZGVycy9NaWNyb3NvZnQuSG9yaXpvbkRiL2NsdXN0ZXJzL3tjbHVzdGVyTmFtZX0vcG9vbHMve3Bvb2xOYW1lfS9tYWludGVuYW5jZUV2ZW50cw==/V/MjAyNi0xMC0wMS1wcmV2aWV3"}], "argGroups": [{"name": "", "args": [{"type": "string", "var": "$Path.clusterName", "options": ["cluster-name"], "required": true, "idPart": "name", "help": {"short": "The name of the HorizonDB cluster."}, "format": {"pattern": "^[a-z0-9](?:[-a-z0-9]*[a-z0-9])?$", "maxLength": 63, "minLength": 1}}, {"type": "string", "var": "$Path.poolName", "options": ["pool-name"], "required": true, "idPart": "child_name_1", "help": {"short": "The name of the HorizonDB pool."}, "format": {"pattern": "^[a-z0-9](?:[-a-z0-9]*[a-z0-9])?$", "maxLength": 63, "minLength": 1}}, {"type": "ResourceGroupName", "var": "$Path.resourceGroupName", "options": ["g", "resource-group"], "required": true, "idPart": "resource_group"}, {"type": "SubscriptionId", "var": "$Path.subscriptionId", "options": ["subscription"], "required": true, "idPart": "subscription"}, {"type": "string", "var": "$Query.filter", "options": ["filter"], "help": {"short": "The OData filter expression to apply to the list operation."}}]}], "operations": [{"operationId": "MaintenanceEvents_List", "http": {"path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HorizonDb/clusters/{clusterName}/pools/{poolName}/maintenanceEvents", "request": {"method": "get", "path": {"params": [{"type": "string", "name": "clusterName", "arg": "$Path.clusterName", "required": true, "format": {"pattern": "^[a-z0-9](?:[-a-z0-9]*[a-z0-9])?$", "maxLength": 63, "minLength": 1}}, {"type": "string", "name": "poolName", "arg": "$Path.poolName", "required": true, "format": {"pattern": "^[a-z0-9](?:[-a-z0-9]*[a-z0-9])?$", "maxLength": 63, "minLength": 1}}, {"type": "string", "name": "resourceGroupName", "arg": "$Path.resourceGroupName", "required": true, "format": {"maxLength": 90, "minLength": 1}}, {"type": "uuid", "name": "subscriptionId", "arg": "$Path.subscriptionId", "required": true}]}, "query": {"params": [{"type": "string", "name": "$filter", "arg": "$Query.filter"}], "consts": [{"readOnly": true, "const": true, "default": {"value": "2026-10-01-preview"}, "type": "string", "name": "api-version", "required": true, "format": {"minLength": 1}}]}}, "responses": [{"statusCode": [200], "body": {"json": {"var": "$Instance", "schema": {"type": "object", "props": [{"type": "string", "name": "nextLink"}, {"type": "array<object>", "name": "value", "required": true, "item": {"type": "object", "props": [{"readOnly": true, "type": "ResourceId", "name": "id", "format": {"template": "/subscriptions/{}/resourceGroups/{}/providers/Microsoft.HorizonDb/clusters/{}/pools/{}/maintenanceEvents/{}"}}, {"readOnly": true, "type": "string", "name": "name"}, {"type": "object", "name": "properties", "props": [{"readOnly": true, "type": "boolean", "name": "deferrable"}, {"readOnly": true, "type": "dateTime", "name": "deferralDeadlineUtc", "format": {"protocol": "iso"}}, {"readOnly": true, "type": "string", "name": "description"}, {"readOnly": true, "type": "dateTime", "name": "endTimeUtc", "format": {"protocol": "iso"}}, {"readOnly": true, "type": "duration", "name": "estimatedDowntime"}, {"readOnly": true, "type": "dateTime", "name": "lastUpdatedTimeUtc", "format": {"protocol": "iso"}}, {"readOnly": true, "type": "string", "name": "maintenanceEventId"}, {"readOnly": true, "type": "string", "name": "maintenanceType", "enum": {"items": [{"value": "PlannedMaintenance"}]}}, {"readOnly": true, "type": "dateTime", "name": "originalStartTimeUtc", "format": {"protocol": "iso"}}, {"readOnly": true, "type": "dateTime", "name": "rescheduledFromUtc", "format": {"protocol": "iso"}}, {"readOnly": true, "type": "dateTime", "name": "startTimeUtc", "format": {"protocol": "iso"}}, {"readOnly": true, "type": "string", "name": "status", "enum": {"items": [{"value": "Canceled"}, {"value": "Complete"}, {"value": "InProgress"}, {"value": "Planned"}, {"value": "Rescheduled"}]}}]}, {"readOnly": true, "type": "object", "name": "systemData", "props": [{"type": "dateTime", "name": "createdAt", "format": {"protocol": "iso"}}, {"type": "string", "name": "createdBy"}, {"type": "string", "name": "createdByType", "enum": {"items": [{"value": "Application"}, {"value": "Key"}, {"value": "ManagedIdentity"}, {"value": "User"}]}}, {"type": "dateTime", "name": "lastModifiedAt", "format": {"protocol": "iso"}}, {"type": "string", "name": "lastModifiedBy"}, {"type": "string", "name": "lastModifiedByType", "enum": {"items": [{"value": "Application"}, {"value": "Key"}, {"value": "ManagedIdentity"}, {"value": "User"}]}}]}, {"readOnly": true, "type": "string", "name": "type"}]}}]}}}}, {"isError": true, "body": {"json": {"schema": {"type": "@MgmtErrorFormat"}}}}]}}], "outputs": [{"type": "array", "ref": "$Instance.value", "clientFlatten": true, "nextLink": "$Instance.nextLink"}]}]}]}
Original file line number Diff line number Diff line change
@@ -0,0 +1,139 @@
<?xml version='1.0' encoding='utf-8'?>
<CodeGen plane="mgmt-plane">
<resource id="/subscriptions/{}/resourcegroups/{}/providers/microsoft.horizondb/clusters/{}/pools/{}/maintenanceevents" version="2026-10-01-preview" swagger="mgmt-plane/horizondb/ResourceProviders/Microsoft.HorizonDb/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9yZXNvdXJjZUdyb3Vwcy97cmVzb3VyY2VHcm91cE5hbWV9L3Byb3ZpZGVycy9NaWNyb3NvZnQuSG9yaXpvbkRiL2NsdXN0ZXJzL3tjbHVzdGVyTmFtZX0vcG9vbHMve3Bvb2xOYW1lfS9tYWludGVuYW5jZUV2ZW50cw==/V/MjAyNi0xMC0wMS1wcmV2aWV3"/>
<commandGroup name="horizondb cluster pool maintenance-event">
<command name="list" version="2026-10-01-preview">
<resource id="/subscriptions/{}/resourcegroups/{}/providers/microsoft.horizondb/clusters/{}/pools/{}/maintenanceevents" version="2026-10-01-preview" swagger="mgmt-plane/horizondb/ResourceProviders/Microsoft.HorizonDb/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9yZXNvdXJjZUdyb3Vwcy97cmVzb3VyY2VHcm91cE5hbWV9L3Byb3ZpZGVycy9NaWNyb3NvZnQuSG9yaXpvbkRiL2NsdXN0ZXJzL3tjbHVzdGVyTmFtZX0vcG9vbHMve3Bvb2xOYW1lfS9tYWludGVuYW5jZUV2ZW50cw==/V/MjAyNi0xMC0wMS1wcmV2aWV3"/>
<argGroup name="">
<arg type="string" var="$Path.clusterName" options="cluster-name" required="True" idPart="name">
<help short="The name of the HorizonDB cluster."/>
<format pattern="^[a-z0-9](?:[-a-z0-9]*[a-z0-9])?$" maxLength="63" minLength="1"/>
</arg>
<arg type="string" var="$Path.poolName" options="pool-name" required="True" idPart="child_name_1">
<help short="The name of the HorizonDB pool."/>
<format pattern="^[a-z0-9](?:[-a-z0-9]*[a-z0-9])?$" maxLength="63" minLength="1"/>
</arg>
<arg type="ResourceGroupName" var="$Path.resourceGroupName" options="resource-group g" required="True" idPart="resource_group"/>
<arg type="SubscriptionId" var="$Path.subscriptionId" options="subscription" required="True" idPart="subscription"/>
<arg type="string" var="$Query.filter" options="filter">
<help short="The OData filter expression to apply to the list operation."/>
</arg>
</argGroup>
<operation operationId="MaintenanceEvents_List">
<http path="/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HorizonDb/clusters/{clusterName}/pools/{poolName}/maintenanceEvents">
<request method="get">
<path>
<param type="string" name="clusterName" arg="$Path.clusterName" required="True">
<format pattern="^[a-z0-9](?:[-a-z0-9]*[a-z0-9])?$" maxLength="63" minLength="1"/>
</param>
<param type="string" name="poolName" arg="$Path.poolName" required="True">
<format pattern="^[a-z0-9](?:[-a-z0-9]*[a-z0-9])?$" maxLength="63" minLength="1"/>
</param>
<param type="string" name="resourceGroupName" arg="$Path.resourceGroupName" required="True">
<format maxLength="90" minLength="1"/>
</param>
<param type="uuid" name="subscriptionId" arg="$Path.subscriptionId" required="True"/>
</path>
<query>
<param type="string" name="$filter" arg="$Query.filter"/>
<const readOnly="True" const="True" type="string" name="api-version" required="True">
<default value="&quot;2026-10-01-preview&quot;"/>
<format minLength="1"/>
</const>
</query>
</request>
<response statusCode="200">
<body>
<json var="$Instance">
<schema type="object">
<prop type="string" name="nextLink"/>
<prop type="array<object>" name="value" required="True">
<item type="object">
<prop readOnly="True" type="ResourceId" name="id">
<format template="/subscriptions/{}/resourceGroups/{}/providers/Microsoft.HorizonDb/clusters/{}/pools/{}/maintenanceEvents/{}"/>
</prop>
<prop readOnly="True" type="string" name="name"/>
<prop type="object" name="properties">
<prop readOnly="True" type="boolean" name="deferrable"/>
<prop readOnly="True" type="dateTime" name="deferralDeadlineUtc">
<format protocol="iso"/>
</prop>
<prop readOnly="True" type="string" name="description"/>
<prop readOnly="True" type="dateTime" name="endTimeUtc">
<format protocol="iso"/>
</prop>
<prop readOnly="True" type="duration" name="estimatedDowntime"/>
<prop readOnly="True" type="dateTime" name="lastUpdatedTimeUtc">
<format protocol="iso"/>
</prop>
<prop readOnly="True" type="string" name="maintenanceEventId"/>
<prop readOnly="True" type="string" name="maintenanceType">
<enum>
<item value="&quot;PlannedMaintenance&quot;"/>
</enum>
</prop>
<prop readOnly="True" type="dateTime" name="originalStartTimeUtc">
<format protocol="iso"/>
</prop>
<prop readOnly="True" type="dateTime" name="rescheduledFromUtc">
<format protocol="iso"/>
</prop>
<prop readOnly="True" type="dateTime" name="startTimeUtc">
<format protocol="iso"/>
</prop>
<prop readOnly="True" type="string" name="status">
<enum>
<item value="&quot;Canceled&quot;"/>
<item value="&quot;Complete&quot;"/>
<item value="&quot;InProgress&quot;"/>
<item value="&quot;Planned&quot;"/>
<item value="&quot;Rescheduled&quot;"/>
</enum>
</prop>
</prop>
<prop readOnly="True" type="object" name="systemData">
<prop type="dateTime" name="createdAt">
<format protocol="iso"/>
</prop>
<prop type="string" name="createdBy"/>
<prop type="string" name="createdByType">
<enum>
<item value="&quot;Application&quot;"/>
<item value="&quot;Key&quot;"/>
<item value="&quot;ManagedIdentity&quot;"/>
<item value="&quot;User&quot;"/>
</enum>
</prop>
<prop type="dateTime" name="lastModifiedAt">
<format protocol="iso"/>
</prop>
<prop type="string" name="lastModifiedBy"/>
<prop type="string" name="lastModifiedByType">
<enum>
<item value="&quot;Application&quot;"/>
<item value="&quot;Key&quot;"/>
<item value="&quot;ManagedIdentity&quot;"/>
<item value="&quot;User&quot;"/>
</enum>
</prop>
</prop>
<prop readOnly="True" type="string" name="type"/>
</item>
</prop>
</schema>
</json>
</body>
</response>
<response isError="True">
<body>
<json>
<schema type="@MgmtErrorFormat"/>
</json>
</body>
</response>
</http>
</operation>
<output type="array" ref="$Instance.value" clientFlatten="True" nextLink="$Instance.nextLink"/>
</command>
</commandGroup>
</CodeGen>
Loading
Loading