Skip to content

Commit aa80594

Browse files
committed
Stage ignite azdata refresh
1 parent d1ca317 commit aa80594

46 files changed

Lines changed: 469 additions & 131 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/azdata/reference/reference-azdata-app-template.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: Reference article for azdata app template commands.
55
author: MikeRayMSFT
66
ms.author: mikeray
77
ms.reviewer: seanw
8-
ms.date: 06/22/2020
8+
ms.date: 09/22/2020
99
ms.topic: reference
1010
ms.prod: sql
1111
ms.technology: big-data-cluster
@@ -98,3 +98,4 @@ Increase logging verbosity. Use --debug for full debug logs.
9898
For more information about other **azdata** commands, see [azdata reference](reference-azdata.md).
9999

100100
For more information about how to install the **azdata** tool, see [Install azdata](..\install\deploy-install-azdata.md).
101+

docs/azdata/reference/reference-azdata-app.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: Reference article for azdata app commands.
55
author: MikeRayMSFT
66
ms.author: mikeray
77
ms.reviewer: seanw
8-
ms.date: 06/22/2020
8+
ms.date: 09/22/2020
99
ms.topic: reference
1010
ms.prod: sql
1111
ms.technology: big-data-cluster
@@ -272,6 +272,7 @@ Increase logging verbosity. Use --debug for full debug logs.
272272

273273
## Next steps
274274

275-
For more information about other **azdata** commands, see [azdata reference](reference-azdata.md).
275+
For more information about other **azdata** commands, see [azdata reference](reference-azdata.md).
276276

277277
For more information about how to install the **azdata** tool, see [Install azdata](..\install\deploy-install-azdata.md).
278+

docs/azdata/reference/reference-azdata-arc-dc-config.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: Reference article for azdata arc dc config commands.
55
author: MikeRayMSFT
66
ms.author: mikeray
77
ms.reviewer: seanw
8-
ms.date: 06/22/2020
8+
ms.date: 09/22/2020
99
ms.topic: reference
1010
ms.prod: sql
1111
ms.technology: big-data-cluster
@@ -48,7 +48,7 @@ azdata arc dc config init --source aks-dev-test --path custom
4848
#### `--path -p`
4949
File path of where you would like the config profile placed, defaults to <cwd>/custom.
5050
#### `--source -s`
51-
Config profile source: ['azure-arc-aks-default-storage', 'azure-arc-eks', 'azure-arc-aks-premium-storage', 'azure-arc-azure-openshift', 'azure-arc-aks-dev-test', 'azure-arc-kubeadm', 'azure-arc-openshift', 'azure-arc-kubeadm-dev-test', 'azure-arc-ake']
51+
Config profile source: ['azure-arc-aks-premium-storage', 'azure-arc-ake', 'azure-arc-openshift', 'azure-arc-gke', 'azure-arc-aks-default-storage', 'azure-arc-aks-dev-test', 'azure-arc-kubeadm', 'azure-arc-kubeadm-dev-test', 'azure-arc-eks', 'azure-arc-azure-openshift', 'azure-arc-aks-hci']
5252
#### `--force -f`
5353
Force overwrite of the target file.
5454
### Global Arguments
@@ -79,7 +79,7 @@ azdata arc dc config list --config-profile aks-dev-test
7979
```
8080
### Optional Parameters
8181
#### `--config-profile -c`
82-
Default config profile: ['azure-arc-aks-default-storage', 'azure-arc-eks', 'azure-arc-aks-premium-storage', 'azure-arc-azure-openshift', 'azure-arc-aks-dev-test', 'azure-arc-kubeadm', 'azure-arc-openshift', 'azure-arc-kubeadm-dev-test', 'azure-arc-ake']
82+
Default config profile: ['azure-arc-aks-premium-storage', 'azure-arc-ake', 'azure-arc-openshift', 'azure-arc-gke', 'azure-arc-aks-default-storage', 'azure-arc-aks-dev-test', 'azure-arc-kubeadm', 'azure-arc-kubeadm-dev-test', 'azure-arc-eks', 'azure-arc-azure-openshift', 'azure-arc-aks-hci']
8383
### Global Arguments
8484
#### `--debug`
8585
Increase logging verbosity to show all debug logs.
@@ -219,3 +219,4 @@ Increase logging verbosity. Use --debug for full debug logs.
219219
For more information about other **azdata** commands, see [azdata reference](reference-azdata.md).
220220

221221
For more information about how to install the **azdata** tool, see [Install azdata](..\install\deploy-install-azdata.md).
222+

docs/azdata/reference/reference-azdata-arc-dc-debug.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: Reference article for azdata arc dc debug commands.
55
author: MikeRayMSFT
66
ms.author: mikeray
77
ms.reviewer: seanw
8-
ms.date: 06/22/2020
8+
ms.date: 09/22/2020
99
ms.topic: reference
1010
ms.prod: sql
1111
ms.technology: big-data-cluster
@@ -33,6 +33,10 @@ azdata arc dc debug copy-logs --namespace -ns
3333

3434
[--pod]
3535

36+
[--resource-kind -rk]
37+
38+
[--resource-name -rn]
39+
3640
[--timeout -t]
3741

3842
[--skip-compress -sc]
@@ -49,6 +53,10 @@ Copy the logs for the containers with similar name, Optional, by default copies
4953
Target folder path to copy logs to. Optional, by default creates the result in the local folder. Cannot be specified multiple times. If specified multiple times, last one will be used
5054
#### `--pod`
5155
Copy the logs for the pods with similar name. Optional, by default copies logs for all pods. Cannot be specified multiple times. If specified multiple times, last one will be used
56+
#### `--resource-kind -rk`
57+
Copy the logs for the resource of a particular kind. Cannot specified multiple times. If specified multiple times, last one will be used. If specified, --resource-name should also be specified to identify the resource.
58+
#### `--resource-name -rn`
59+
Copy the logs for the resource of the specified name. Cannot be specified multiple times. If specified multiple times, last one will be used. If specified, --resource-kind should also be specified to identify the resource.
5260
#### `--timeout -t`
5361
The number of seconds to wait for the command to complete. The default value is 0 which is unlimited
5462
#### `--skip-compress -sc`
@@ -101,3 +109,4 @@ Increase logging verbosity. Use --debug for full debug logs.
101109
For more information about other **azdata** commands, see [azdata reference](reference-azdata.md).
102110

103111
For more information about how to install the **azdata** tool, see [Install azdata](..\install\deploy-install-azdata.md).
112+

docs/azdata/reference/reference-azdata-arc-dc-endpoint.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: Reference article for azdata arc dc endpoint commands.
55
author: MikeRayMSFT
66
ms.author: mikeray
77
ms.reviewer: seanw
8-
ms.date: 06/22/2020
8+
ms.date: 09/22/2020
99
ms.topic: reference
1010
ms.prod: sql
1111
ms.technology: big-data-cluster
@@ -53,3 +53,4 @@ Increase logging verbosity. Use --debug for full debug logs.
5353
For more information about other **azdata** commands, see [azdata reference](reference-azdata.md).
5454

5555
For more information about how to install the **azdata** tool, see [Install azdata](..\install\deploy-install-azdata.md).
56+

docs/azdata/reference/reference-azdata-arc-dc-status.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: Reference article for azdata arc dc status commands.
55
author: MikeRayMSFT
66
ms.author: mikeray
77
ms.reviewer: seanw
8-
ms.date: 06/22/2020
8+
ms.date: 09/22/2020
99
ms.topic: reference
1010
ms.prod: sql
1111
ms.technology: big-data-cluster
@@ -53,3 +53,4 @@ Increase logging verbosity. Use --debug for full debug logs.
5353
For more information about other **azdata** commands, see [azdata reference](reference-azdata.md).
5454

5555
For more information about how to install the **azdata** tool, see [Install azdata](..\install\deploy-install-azdata.md).
56+

docs/azdata/reference/reference-azdata-arc-dc.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: Reference article for azdata arc dc commands.
55
author: MikeRayMSFT
66
ms.author: mikeray
77
ms.reviewer: seanw
8-
ms.date: 06/22/2020
8+
ms.date: 09/22/2020
99
ms.topic: reference
1010
ms.prod: sql
1111
ms.technology: big-data-cluster
@@ -56,9 +56,9 @@ azdata arc dc create
5656
```
5757
### Required Parameters
5858
#### `--namespace -ns`
59-
The Kubernetes namespace to deploy the data controller into. If it exists already it will be used. If it does not exist, an attempt will be made to create it first. This name will also be used for the data controller's local Kubernetes custom resource.
59+
The Kubernetes namespace to deploy the data controller into. If it exists already it will be used. If it does not exist, an attempt will be made to create it first.
6060
#### `--name -n`
61-
The name for the data controller in the Azure Portal.
61+
The name for the data controller.
6262
#### `--connectivity-mode`
6363
The connectivity to Azure - indirect or direct - which the data controller should operate in.
6464
#### `--resource-group -g`
@@ -69,7 +69,7 @@ The Azure location in which the data controller metadata will be stored (e.g. ea
6969
The Azure subscription ID in which the data controller resource should be added.
7070
### Optional Parameters
7171
#### `--profile-name`
72-
The name of an existing configuration profile. Run `azdata arc dc config list` to see available options. One of the following: ['azure-arc-aks-default-storage', 'azure-arc-eks', 'azure-arc-aks-premium-storage', 'azure-arc-azure-openshift', 'azure-arc-kubeadm', 'azure-arc-openshift', 'azure-arc-ake'].
72+
The name of an existing configuration profile. Run `azdata arc dc config list` to see available options. One of the following: ['azure-arc-aks-premium-storage', 'azure-arc-ake', 'azure-arc-openshift', 'azure-arc-gke', 'azure-arc-aks-default-storage', 'azure-arc-kubeadm', 'azure-arc-eks', 'azure-arc-azure-openshift', 'azure-arc-aks-hci'].
7373
#### `--path -p`
7474
The path to a directory containing a custom configuration profile to use. Run `azdata arc dc config init` to create a custom configuration profile.
7575
#### `--storage-class -sc`
@@ -170,3 +170,4 @@ Increase logging verbosity. Use --debug for full debug logs.
170170
For more information about other **azdata** commands, see [azdata reference](reference-azdata.md).
171171

172172
For more information about how to install the **azdata** tool, see [Install azdata](..\install\deploy-install-azdata.md).
173+

docs/azdata/reference/reference-azdata-arc-postgres-backup.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: Reference article for azdata arc postgres backup commands.
55
author: MikeRayMSFT
66
ms.author: mikeray
77
ms.reviewer: seanw
8-
ms.date: 06/22/2020
8+
ms.date: 09/22/2020
99
ms.topic: reference
1010
ms.prod: sql
1111
ms.technology: big-data-cluster
@@ -27,3 +27,4 @@ The following article provides reference for the **sql** commands in the **azdat
2727
For more information about other **azdata** commands, see [azdata reference](reference-azdata.md).
2828

2929
For more information about how to install the **azdata** tool, see [Install azdata](..\install\deploy-install-azdata.md).
30+

docs/azdata/reference/reference-azdata-arc-postgres-server-endpoint.md renamed to docs/azdata/reference/reference-azdata-arc-postgres-endpoint.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
---
2-
title: azdata arc postgres server endpoint reference
2+
title: azdata arc postgres endpoint reference
33
titleSuffix: SQL Server big data clusters
4-
description: Reference article for azdata arc postgres server endpoint commands.
4+
description: Reference article for azdata arc postgres endpoint commands.
55
author: MikeRayMSFT
66
ms.author: mikeray
77
ms.reviewer: seanw
8-
ms.date: 06/22/2020
8+
ms.date: 09/22/2020
99
ms.topic: reference
1010
ms.prod: sql
1111
ms.technology: big-data-cluster
1212
---
1313

14-
# azdata arc postgres server endpoint
14+
# azdata arc postgres endpoint
1515

1616
Applies to `azdata`
1717

@@ -21,24 +21,24 @@ The following article provides reference for the **sql** commands in the **azdat
2121

2222
|Command|Description|
2323
| --- | --- |
24-
[azdata arc postgres server endpoint list](#azdata-arc-postgres-server-endpoint-list) | List PostgreSQL server group endpoints.
25-
## azdata arc postgres server endpoint list
24+
[azdata arc postgres endpoint list](#azdata-arc-postgres-endpoint-list) | List PostgreSQL server group endpoints.
25+
## azdata arc postgres endpoint list
2626
List PostgreSQL server group endpoints.
2727
```bash
28-
azdata arc postgres server endpoint list --name -n
29-
[--engine-version -ev]
28+
azdata arc postgres endpoint list --name -n
29+
[--engine-version -ev]
3030
```
3131
### Examples
3232
List PostgreSQL server group endpoints.
3333
```bash
34-
azdata arc postgres server endpoint list -n postgres01
34+
azdata arc postgres endpoint list -n postgres01
3535
```
3636
### Required Parameters
3737
#### `--name -n`
3838
Name of the PostgreSQL server group.
3939
### Optional Parameters
4040
#### `--engine-version -ev`
41-
Must be 11 or 12. It is possible to create multiple PostgreSQL server groups with the same name but different engine version. Engine version will be used in conjunction with name to uniquely identify the PostgreSQL server group in such case. Otherwise engine version can be optional.
41+
--engine-version can be used in conjunction with --name to identify a PostgreSQL Hyperscale server group when two server groups of different engine version have the same name. --engine-version is optional and when used to identify a server group, it must be 11 or 12.
4242
### Global Arguments
4343
#### `--debug`
4444
Increase logging verbosity to show all debug logs.
@@ -56,3 +56,4 @@ Increase logging verbosity. Use --debug for full debug logs.
5656
For more information about other **azdata** commands, see [azdata reference](reference-azdata.md).
5757

5858
For more information about how to install the **azdata** tool, see [Install azdata](..\install\deploy-install-azdata.md).
59+

docs/azdata/reference/reference-azdata-arc-postgres-server-backup.md

Lines changed: 26 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: Reference article for azdata arc postgres server backup commands.
55
author: MikeRayMSFT
66
ms.author: mikeray
77
ms.reviewer: seanw
8-
ms.date: 06/22/2020
8+
ms.date: 09/22/2020
99
ms.topic: reference
1010
ms.prod: sql
1111
ms.technology: big-data-cluster
@@ -22,6 +22,7 @@ The following article provides reference for the **sql** commands in the **azdat
2222
|Command|Description|
2323
| --- | --- |
2424
[azdata arc postgres server backup create](#azdata-arc-postgres-server-backup-create) | Create a backup of a PostgreSQL server group.
25+
[azdata arc postgres server backup delete](#azdata-arc-postgres-server-backup-delete) | Delete a backup of a PostgreSQL server group.
2526
[azdata arc postgres server backup restore](#azdata-arc-postgres-server-backup-restore) | Restore a backup of a PostgreSQL server group.
2627
[azdata arc postgres server backup restorestatus](#azdata-arc-postgres-server-backup-restorestatus) | Get the status of the most recent restore operation, if any.
2728
[azdata arc postgres server backup show](#azdata-arc-postgres-server-backup-show) | Show details about a backup of a PostgreSQL server group.
@@ -50,6 +51,27 @@ Output format. Allowed values: json, jsonc, table, tsv. Default: json.
5051
JMESPath query string. See [http://jmespath.org/](http://jmespath.org) for more information and examples.
5152
#### `--verbose`
5253
Increase logging verbosity. Use --debug for full debug logs.
54+
## azdata arc postgres server backup delete
55+
Delete a backup of a PostgreSQL server group.
56+
```bash
57+
azdata arc postgres server backup delete
58+
```
59+
### Examples
60+
Delete a backup of a PostgreSQL server group.
61+
```bash
62+
azdata arc postgres backup delete -sn pg -id e07dd3940e374bd9acbc86869cbc123d
63+
```
64+
### Global Arguments
65+
#### `--debug`
66+
Increase logging verbosity to show all debug logs.
67+
#### `--help -h`
68+
Show this help message and exit.
69+
#### `--output -o`
70+
Output format. Allowed values: json, jsonc, table, tsv. Default: json.
71+
#### `--query -q`
72+
JMESPath query string. See [http://jmespath.org/](http://jmespath.org) for more information and examples.
73+
#### `--verbose`
74+
Increase logging verbosity. Use --debug for full debug logs.
5375
## azdata arc postgres server backup restore
5476
Restore a backup of a PostgreSQL server group.
5577
```bash
@@ -58,13 +80,10 @@ azdata arc postgres server backup restore
5880
### Examples
5981
Restore the most recent backup.
6082
```bash
61-
azdata arc postgres server restore -sn pg
62-
```
83+
azdata arc postgres server restore -sn pg```
6384
Restore a backup by ID
6485
```bash
65-
azdata arc postgres server restore -sn pg -id 123e4567e89b12d3a456426655440000
66-
67-
```
86+
azdata arc postgres server restore -sn pg -id 123e4567e89b12d3a456426655440000```
6887
### Global Arguments
6988
#### `--debug`
7089
Increase logging verbosity to show all debug logs.
@@ -124,3 +143,4 @@ Increase logging verbosity. Use --debug for full debug logs.
124143
For more information about other **azdata** commands, see [azdata reference](reference-azdata.md).
125144
126145
For more information about how to install the **azdata** tool, see [Install azdata](..\install\deploy-install-azdata.md).
146+

0 commit comments

Comments
 (0)