-
Notifications
You must be signed in to change notification settings - Fork 492
/
ad-admin.yml
175 lines (175 loc) · 7.14 KB
/
ad-admin.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
### YamlMime:AzureCLIGroup
uid: az_sql_server_ad-admin
name: az sql server ad-admin
summary: |-
Manage a server's Active Directory administrator.
status: GA
sourceType: Core
directCommands:
- uid: az_sql_server_ad-admin_create
name: az sql server ad-admin create
summary: |-
Create a new server Active Directory administrator.
status: GA
sourceType: Core
editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/sql/_help.py
syntax: >-
az sql server ad-admin create --display-name
--object-id
--resource-group
--server
requiredParameters:
- isRequired: true
name: --display-name -u
summary: |-
Display name of the Azure AD administrator user or group.
- isRequired: true
name: --object-id -i
summary: |-
The unique ID of the Azure AD administrator.
- isRequired: true
name: --resource-group -g
summary: |-
Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
- isRequired: true
name: --server --server-name -s
summary: |-
Name of the Azure SQL Server. You can configure the default using `az configure --defaults sql-server=<name>`.
- uid: az_sql_server_ad-admin_delete
name: az sql server ad-admin delete
summary: |-
Sets a server's AD admin.
status: GA
sourceType: Core
editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/sql/_help.py
syntax: >-
az sql server ad-admin delete [--ids]
[--resource-group]
[--server]
[--subscription]
optionalParameters:
- name: --ids
summary: |-
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
- name: --resource-group -g
summary: |-
Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
- name: --server --server-name -s
summary: |-
Name of the Azure SQL Server. You can configure the default using `az configure --defaults sql-server=<name>`.
- name: --subscription
summary: |-
Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.
- uid: az_sql_server_ad-admin_list
name: az sql server ad-admin list
summary: |-
Gets a list of Azure Active Directory administrators in a server.
status: GA
sourceType: Core
editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/sql/_help.py
syntax: >-
az sql server ad-admin list [--ids]
[--resource-group]
[--server]
[--subscription]
optionalParameters:
- name: --ids
summary: |-
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
- name: --resource-group -g
summary: |-
Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
- name: --server --server-name -s
summary: |-
Name of the Azure SQL Server. You can configure the default using `az configure --defaults sql-server=<name>`.
- name: --subscription
summary: |-
Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.
- uid: az_sql_server_ad-admin_update
name: az sql server ad-admin update
summary: |-
Update an existing server Active Directory administrator.
status: GA
sourceType: Core
editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/sql/_help.py
syntax: >-
az sql server ad-admin update --display-name
--object-id
[--add]
[--force-string]
[--ids]
[--remove]
[--resource-group]
[--server]
[--set]
[--subscription]
requiredParameters:
- isRequired: true
name: --display-name -u
summary: |-
Display name of the Azure AD administrator user or group.
- isRequired: true
name: --object-id -i
summary: |-
The unique ID of the Azure AD administrator.
optionalParameters:
- name: --add
defaultValue: "[]"
summary: |-
Add an object to a list of objects by specifying a path and key value pairs. Example: `--add property.listProperty <key=value, string or JSON string>`.
- name: --force-string
defaultValue: "False"
summary: |-
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
- name: --ids
summary: |-
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
- name: --remove
defaultValue: "[]"
summary: |-
Remove a property or an element from a list. Example: `--remove property.list <indexToRemove>` OR `--remove propertyToRemove`.
- name: --resource-group -g
summary: |-
Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
- name: --server --server-name -s
summary: |-
Name of the Azure SQL Server. You can configure the default using `az configure --defaults sql-server=<name>`.
- name: --set
defaultValue: "[]"
summary: |-
Update an object by specifying a property path and value to set. Example: `--set property1.property2=<value>`.
- name: --subscription
summary: |-
Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.
commands:
- az_sql_server_ad-admin_create
- az_sql_server_ad-admin_delete
- az_sql_server_ad-admin_list
- az_sql_server_ad-admin_update
globalParameters:
- name: --debug
summary: |-
Increase logging verbosity to show all debug logs.
- name: --help -h
summary: |-
Show this help message and exit.
- name: --only-show-errors
summary: |-
Only show errors, suppressing warnings.
- name: --output -o
defaultValue: "json"
parameterValueGroup: "json, jsonc, none, table, tsv, yaml, yamlc"
summary: |-
Output format.
- name: --query
summary: |-
JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.
- name: --subscription
summary: |-
Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.
- name: --verbose
summary: |-
Increase logging verbosity. Use --debug for full debug logs.
metadata:
ms.date: 09/13/2024
description: Manage a server's Active Directory administrator.