Skip to content

Commit a01aab4

Browse files
committed
feat(sqlserverflex): add docs
relates to STACKITCLI-437
1 parent feb6378 commit a01aab4

29 files changed

Lines changed: 1237 additions & 0 deletions

docs/stackit_sqlserverflex.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
## stackit sqlserverflex
2+
3+
Provides functionality for SQLServer Flex
4+
5+
### Synopsis
6+
7+
Provides functionality for SQLServer Flex.
8+
9+
```
10+
stackit sqlserverflex [flags]
11+
```
12+
13+
### Options
14+
15+
```
16+
-h, --help Help for "stackit sqlserverflex"
17+
```
18+
19+
### Options inherited from parent commands
20+
21+
```
22+
-y, --assume-yes If set, skips all confirmation prompts
23+
--async If set, runs the command asynchronously
24+
-o, --output-format string Output format, (one of: [json, pretty, none, yaml])
25+
-p, --project-id string Project ID
26+
--region string Target region for region-specific requests
27+
--verbosity string Verbosity of the CLI, (one of: [debug, info, warning, error]) (default "info")
28+
```
29+
30+
### SEE ALSO
31+
32+
* [stackit](./stackit.md) - Manage STACKIT resources using the command line
33+
* [stackit sqlserverflex database](./stackit_sqlserverflex_database.md) - Provides functionality for SQLServer Flex databases
34+
* [stackit sqlserverflex flavor](./stackit_sqlserverflex_flavor.md) - Provides functionality for SQLServer Flex flavors
35+
* [stackit sqlserverflex instance](./stackit_sqlserverflex_instance.md) - Provides functionality for SQLServer Flex instances
36+
* [stackit sqlserverflex user](./stackit_sqlserverflex_user.md) - Provides functionality for SQLServer Flex users
37+
* [stackit sqlserverflex version](./stackit_sqlserverflex_version.md) - Provides functionality for SQLServer Flex versions
38+
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
## stackit sqlserverflex database
2+
3+
Provides functionality for SQLServer Flex databases
4+
5+
### Synopsis
6+
7+
Provides functionality for SQLServer Flex databases.
8+
9+
```
10+
stackit sqlserverflex database [flags]
11+
```
12+
13+
### Options
14+
15+
```
16+
-h, --help Help for "stackit sqlserverflex database"
17+
```
18+
19+
### Options inherited from parent commands
20+
21+
```
22+
-y, --assume-yes If set, skips all confirmation prompts
23+
--async If set, runs the command asynchronously
24+
-o, --output-format string Output format, (one of: [json, pretty, none, yaml])
25+
-p, --project-id string Project ID
26+
--region string Target region for region-specific requests
27+
--verbosity string Verbosity of the CLI, (one of: [debug, info, warning, error]) (default "info")
28+
```
29+
30+
### SEE ALSO
31+
32+
* [stackit sqlserverflex](./stackit_sqlserverflex.md) - Provides functionality for SQLServer Flex
33+
* [stackit sqlserverflex database create](./stackit_sqlserverflex_database_create.md) - Creates a SQLServer Flex database
34+
* [stackit sqlserverflex database delete](./stackit_sqlserverflex_database_delete.md) - Deletes a SQLServer Flex database
35+
* [stackit sqlserverflex database describe](./stackit_sqlserverflex_database_describe.md) - Shows details of an SQLServer Flex database
36+
* [stackit sqlserverflex database list](./stackit_sqlserverflex_database_list.md) - Lists all SQLServer Flex databases
37+
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
## stackit sqlserverflex database create
2+
3+
Creates a SQLServer Flex database
4+
5+
### Synopsis
6+
7+
Creates a SQLServer Flex database.
8+
This operation cannot be triggered asynchronously (the "--async" flag will have no effect).
9+
10+
```
11+
stackit sqlserverflex database create DATABASE_NAME [flags]
12+
```
13+
14+
### Examples
15+
16+
```
17+
Create a SQLServer Flex database with name "my-database" on instance with ID "xxx"
18+
$ stackit sqlserverflex database create my-database --instance-id xxx --owner some-username
19+
```
20+
21+
### Options
22+
23+
```
24+
-h, --help Help for "stackit sqlserverflex database create"
25+
--instance-id string SQLServer Flex instance ID
26+
--owner string Username of the owner user
27+
```
28+
29+
### Options inherited from parent commands
30+
31+
```
32+
-y, --assume-yes If set, skips all confirmation prompts
33+
--async If set, runs the command asynchronously
34+
-o, --output-format string Output format, (one of: [json, pretty, none, yaml])
35+
-p, --project-id string Project ID
36+
--region string Target region for region-specific requests
37+
--verbosity string Verbosity of the CLI, (one of: [debug, info, warning, error]) (default "info")
38+
```
39+
40+
### SEE ALSO
41+
42+
* [stackit sqlserverflex database](./stackit_sqlserverflex_database.md) - Provides functionality for SQLServer Flex databases
43+
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
## stackit sqlserverflex database delete
2+
3+
Deletes a SQLServer Flex database
4+
5+
### Synopsis
6+
7+
Deletes a SQLServer Flex database.
8+
This operation cannot be triggered asynchronously (the "--async" flag will have no effect).
9+
10+
```
11+
stackit sqlserverflex database delete DATABASE_NAME [flags]
12+
```
13+
14+
### Examples
15+
16+
```
17+
Delete a SQLServer Flex database with name "my-database" of instance with ID "xxx"
18+
$ stackit sqlserverflex database delete my-database --instance-id xxx
19+
```
20+
21+
### Options
22+
23+
```
24+
-h, --help Help for "stackit sqlserverflex database delete"
25+
--instance-id string SQLServer Flex instance ID
26+
```
27+
28+
### Options inherited from parent commands
29+
30+
```
31+
-y, --assume-yes If set, skips all confirmation prompts
32+
--async If set, runs the command asynchronously
33+
-o, --output-format string Output format, (one of: [json, pretty, none, yaml])
34+
-p, --project-id string Project ID
35+
--region string Target region for region-specific requests
36+
--verbosity string Verbosity of the CLI, (one of: [debug, info, warning, error]) (default "info")
37+
```
38+
39+
### SEE ALSO
40+
41+
* [stackit sqlserverflex database](./stackit_sqlserverflex_database.md) - Provides functionality for SQLServer Flex databases
42+
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
## stackit sqlserverflex database describe
2+
3+
Shows details of an SQLServer Flex database
4+
5+
### Synopsis
6+
7+
Shows details of an SQLServer Flex database.
8+
9+
```
10+
stackit sqlserverflex database describe DATABASE_NAME [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
Get details of an SQLServer Flex database with name "my-database" of instance with ID "xxx"
17+
$ stackit sqlserverflex database describe my-database --instance-id xxx
18+
19+
Get details of an SQLServer Flex database with name "my-database" of instance with ID "xxx" in JSON format
20+
$ stackit sqlserverflex database describe my-database --instance-id xxx --output-format json
21+
```
22+
23+
### Options
24+
25+
```
26+
-h, --help Help for "stackit sqlserverflex database describe"
27+
--instance-id string SQLServer Flex instance ID
28+
```
29+
30+
### Options inherited from parent commands
31+
32+
```
33+
-y, --assume-yes If set, skips all confirmation prompts
34+
--async If set, runs the command asynchronously
35+
-o, --output-format string Output format, (one of: [json, pretty, none, yaml])
36+
-p, --project-id string Project ID
37+
--region string Target region for region-specific requests
38+
--verbosity string Verbosity of the CLI, (one of: [debug, info, warning, error]) (default "info")
39+
```
40+
41+
### SEE ALSO
42+
43+
* [stackit sqlserverflex database](./stackit_sqlserverflex_database.md) - Provides functionality for SQLServer Flex databases
44+
Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
## stackit sqlserverflex database list
2+
3+
Lists all SQLServer Flex databases
4+
5+
### Synopsis
6+
7+
Lists all SQLServer Flex databases.
8+
9+
```
10+
stackit sqlserverflex database list [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
List all SQLServer Flex databases of instance with ID "xxx"
17+
$ stackit sqlserverflex database list --instance-id xxx
18+
19+
List all SQLServer Flex databases of instance with ID "xxx" in JSON format
20+
$ stackit sqlserverflex database list --instance-id xxx --output-format json
21+
22+
List up to 10 SQLServer Flex databases of instance with ID "xxx"
23+
$ stackit sqlserverflex database list --instance-id xxx --limit 10
24+
```
25+
26+
### Options
27+
28+
```
29+
-h, --help Help for "stackit sqlserverflex database list"
30+
--instance-id string SQLServer Flex instance ID
31+
--limit int Maximum number of entries to list
32+
```
33+
34+
### Options inherited from parent commands
35+
36+
```
37+
-y, --assume-yes If set, skips all confirmation prompts
38+
--async If set, runs the command asynchronously
39+
-o, --output-format string Output format, (one of: [json, pretty, none, yaml])
40+
-p, --project-id string Project ID
41+
--region string Target region for region-specific requests
42+
--verbosity string Verbosity of the CLI, (one of: [debug, info, warning, error]) (default "info")
43+
```
44+
45+
### SEE ALSO
46+
47+
* [stackit sqlserverflex database](./stackit_sqlserverflex_database.md) - Provides functionality for SQLServer Flex databases
48+
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
## stackit sqlserverflex flavor
2+
3+
Provides functionality for SQLServer Flex flavors
4+
5+
### Synopsis
6+
7+
Provides functionality for SQLServer Flex flavors.
8+
9+
```
10+
stackit sqlserverflex flavor [flags]
11+
```
12+
13+
### Options
14+
15+
```
16+
-h, --help Help for "stackit sqlserverflex flavor"
17+
```
18+
19+
### Options inherited from parent commands
20+
21+
```
22+
-y, --assume-yes If set, skips all confirmation prompts
23+
--async If set, runs the command asynchronously
24+
-o, --output-format string Output format, (one of: [json, pretty, none, yaml])
25+
-p, --project-id string Project ID
26+
--region string Target region for region-specific requests
27+
--verbosity string Verbosity of the CLI, (one of: [debug, info, warning, error]) (default "info")
28+
```
29+
30+
### SEE ALSO
31+
32+
* [stackit sqlserverflex](./stackit_sqlserverflex.md) - Provides functionality for SQLServer Flex
33+
* [stackit sqlserverflex flavor describe](./stackit_sqlserverflex_flavor_describe.md) - Show details of a SQLServer Flex flavor
34+
* [stackit sqlserverflex flavor list](./stackit_sqlserverflex_flavor_list.md) - Lists SQLServer Flex flavors
35+
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
## stackit sqlserverflex flavor describe
2+
3+
Show details of a SQLServer Flex flavor
4+
5+
### Synopsis
6+
7+
Show details of a SQLServer Flex flavor.
8+
9+
```
10+
stackit sqlserverflex flavor describe [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
Show SQLServer Flex flavor details
17+
$ stackit sqlserverflex flavor describe xxx
18+
```
19+
20+
### Options
21+
22+
```
23+
-h, --help Help for "stackit sqlserverflex flavor describe"
24+
```
25+
26+
### Options inherited from parent commands
27+
28+
```
29+
-y, --assume-yes If set, skips all confirmation prompts
30+
--async If set, runs the command asynchronously
31+
-o, --output-format string Output format, (one of: [json, pretty, none, yaml])
32+
-p, --project-id string Project ID
33+
--region string Target region for region-specific requests
34+
--verbosity string Verbosity of the CLI, (one of: [debug, info, warning, error]) (default "info")
35+
```
36+
37+
### SEE ALSO
38+
39+
* [stackit sqlserverflex flavor](./stackit_sqlserverflex_flavor.md) - Provides functionality for SQLServer Flex flavors
40+
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
## stackit sqlserverflex flavor list
2+
3+
Lists SQLServer Flex flavors
4+
5+
### Synopsis
6+
7+
Lists SQLServer Flex flavors.
8+
9+
```
10+
stackit sqlserverflex flavor list [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
List SQLServer Flex flavors
17+
$ stackit sqlserverflex flavor list
18+
19+
List up to 10 SQLServer Flex flavors
20+
$ stackit sqlserverflex flavor list --limit 10
21+
```
22+
23+
### Options
24+
25+
```
26+
-h, --help Help for "stackit sqlserverflex flavor list"
27+
--limit int Maximum number of entries to list
28+
```
29+
30+
### Options inherited from parent commands
31+
32+
```
33+
-y, --assume-yes If set, skips all confirmation prompts
34+
--async If set, runs the command asynchronously
35+
-o, --output-format string Output format, (one of: [json, pretty, none, yaml])
36+
-p, --project-id string Project ID
37+
--region string Target region for region-specific requests
38+
--verbosity string Verbosity of the CLI, (one of: [debug, info, warning, error]) (default "info")
39+
```
40+
41+
### SEE ALSO
42+
43+
* [stackit sqlserverflex flavor](./stackit_sqlserverflex_flavor.md) - Provides functionality for SQLServer Flex flavors
44+

0 commit comments

Comments
 (0)