Skip to content

Commit 4108d34

Browse files
azure-service-operator-automation[bot]theunrepentantgeek
azure-service-operator-automation[bot]
and
theunrepentantgeek
authored
Update API Docs (#4220)
Co-authored-by: theunrepentantgeek <[email protected]>
1 parent 9edee56 commit 4108d34

File tree

5 files changed

+3810
-6
lines changed

5 files changed

+3810
-6
lines changed

‎docs/hugo/content/reference/_index.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -577,9 +577,9 @@ To install the CRDs for these resources, your ASO configuration must include `re
577577

578578
These resource(s) are available for use in the current release of ASO. Different versions of a given resource reflect different versions of the Azure ARM API.
579579

580-
| Resource | ARM Version | CRD Version | Supported From | Sample |
581-
|------------------|-------------|---------------|----------------|----------------------------------------------------------------------------------------------------------------------------------------|
582-
| OpenShiftCluster | 2023-11-22 | v1api20231122 | v2.9.0 | [View](https://github.com/Azure/azure-service-operator/tree/main/v2/samples/redhatopenshift/v1api/v1api20231122_openshiftcluster.yaml) |
580+
| Resource | ARM Version | CRD Version | Supported From | Sample |
581+
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|---------------|----------------|----------------------------------------------------------------------------------------------------------------------------------------|
582+
| [OpenShiftCluster](https://azure.github.io/azure-service-operator/reference/redhatopenshift/v1api20231122/#redhatopenshift.azure.com/v1api20231122.OpenShiftCluster) | 2023-11-22 | v1api20231122 | v2.9.0 | [View](https://github.com/Azure/azure-service-operator/tree/main/v2/samples/redhatopenshift/v1api/v1api20231122_openshiftcluster.yaml) |
583583

584584
## Resources
585585

‎docs/hugo/content/reference/authorization/v1api20200801preview.md‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,20 @@ string
126126
</tr>
127127
<tr>
128128
<td>
129+
<code>operatorSpec</code><br/>
130+
<em>
131+
<a href="#authorization.azure.com/v1api20200801preview.RoleAssignmentOperatorSpec">
132+
RoleAssignmentOperatorSpec
133+
</a>
134+
</em>
135+
</td>
136+
<td>
137+
<p>OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not
138+
passed directly to Azure</p>
139+
</td>
140+
</tr>
141+
<tr>
142+
<td>
129143
<code>owner</code><br/>
130144
<em>
131145
<a href="https://pkg.go.dev/github.com/Azure/azure-service-operator/v2/pkg/genruntime#ArbitraryOwnerReference">
@@ -206,6 +220,36 @@ RoleAssignment_STATUS
206220
</tr>
207221
</tbody>
208222
</table>
223+
<h3 id="authorization.azure.com/v1api20200801preview.RoleAssignmentOperatorSpec">RoleAssignmentOperatorSpec
224+
</h3>
225+
<p>
226+
(<em>Appears on:</em><a href="#authorization.azure.com/v1api20200801preview.RoleAssignment_Spec">RoleAssignment_Spec</a>)
227+
</p>
228+
<div>
229+
<p>Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure</p>
230+
</div>
231+
<table>
232+
<thead>
233+
<tr>
234+
<th>Field</th>
235+
<th>Description</th>
236+
</tr>
237+
</thead>
238+
<tbody>
239+
<tr>
240+
<td>
241+
<code>namingConvention</code><br/>
242+
<em>
243+
string
244+
</em>
245+
</td>
246+
<td>
247+
<p>NamingConvention: The uuid generation technique to use for any role without an explicit AzureName. One of &lsquo;stable&rsquo; or
248+
&lsquo;random&rsquo;.</p>
249+
</td>
250+
</tr>
251+
</tbody>
252+
</table>
209253
<h3 id="authorization.azure.com/v1api20200801preview.RoleAssignmentProperties_ARM">RoleAssignmentProperties_ARM
210254
</h3>
211255
<p>
@@ -843,6 +887,20 @@ string
843887
</tr>
844888
<tr>
845889
<td>
890+
<code>operatorSpec</code><br/>
891+
<em>
892+
<a href="#authorization.azure.com/v1api20200801preview.RoleAssignmentOperatorSpec">
893+
RoleAssignmentOperatorSpec
894+
</a>
895+
</em>
896+
</td>
897+
<td>
898+
<p>OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not
899+
passed directly to Azure</p>
900+
</td>
901+
</tr>
902+
<tr>
903+
<td>
846904
<code>owner</code><br/>
847905
<em>
848906
<a href="https://pkg.go.dev/github.com/Azure/azure-service-operator/v2/pkg/genruntime#ArbitraryOwnerReference">

‎docs/hugo/content/reference/authorization/v1api20220401.md‎

Lines changed: 116 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -374,6 +374,20 @@ string
374374
</tr>
375375
<tr>
376376
<td>
377+
<code>operatorSpec</code><br/>
378+
<em>
379+
<a href="#authorization.azure.com/v1api20220401.RoleAssignmentOperatorSpec">
380+
RoleAssignmentOperatorSpec
381+
</a>
382+
</em>
383+
</td>
384+
<td>
385+
<p>OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not
386+
passed directly to Azure</p>
387+
</td>
388+
</tr>
389+
<tr>
390+
<td>
377391
<code>owner</code><br/>
378392
<em>
379393
<a href="https://pkg.go.dev/github.com/Azure/azure-service-operator/v2/pkg/genruntime#ArbitraryOwnerReference">
@@ -454,6 +468,36 @@ RoleAssignment_STATUS
454468
</tr>
455469
</tbody>
456470
</table>
471+
<h3 id="authorization.azure.com/v1api20220401.RoleAssignmentOperatorSpec">RoleAssignmentOperatorSpec
472+
</h3>
473+
<p>
474+
(<em>Appears on:</em><a href="#authorization.azure.com/v1api20220401.RoleAssignment_Spec">RoleAssignment_Spec</a>)
475+
</p>
476+
<div>
477+
<p>Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure</p>
478+
</div>
479+
<table>
480+
<thead>
481+
<tr>
482+
<th>Field</th>
483+
<th>Description</th>
484+
</tr>
485+
</thead>
486+
<tbody>
487+
<tr>
488+
<td>
489+
<code>namingConvention</code><br/>
490+
<em>
491+
string
492+
</em>
493+
</td>
494+
<td>
495+
<p>NamingConvention: The uuid generation technique to use for any role without an explicit AzureName. One of &lsquo;stable&rsquo; or
496+
&lsquo;random&rsquo;.</p>
497+
</td>
498+
</tr>
499+
</tbody>
500+
</table>
457501
<h3 id="authorization.azure.com/v1api20220401.RoleAssignmentProperties_ARM">RoleAssignmentProperties_ARM
458502
</h3>
459503
<p>
@@ -1095,6 +1139,20 @@ string
10951139
</tr>
10961140
<tr>
10971141
<td>
1142+
<code>operatorSpec</code><br/>
1143+
<em>
1144+
<a href="#authorization.azure.com/v1api20220401.RoleAssignmentOperatorSpec">
1145+
RoleAssignmentOperatorSpec
1146+
</a>
1147+
</em>
1148+
</td>
1149+
<td>
1150+
<p>OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not
1151+
passed directly to Azure</p>
1152+
</td>
1153+
</tr>
1154+
<tr>
1155+
<td>
10981156
<code>owner</code><br/>
10991157
<em>
11001158
<a href="https://pkg.go.dev/github.com/Azure/azure-service-operator/v2/pkg/genruntime#ArbitraryOwnerReference">
@@ -1277,6 +1335,20 @@ string
12771335
</tr>
12781336
<tr>
12791337
<td>
1338+
<code>operatorSpec</code><br/>
1339+
<em>
1340+
<a href="#authorization.azure.com/v1api20220401.RoleDefinitionOperatorSpec">
1341+
RoleDefinitionOperatorSpec
1342+
</a>
1343+
</em>
1344+
</td>
1345+
<td>
1346+
<p>OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not
1347+
passed directly to Azure</p>
1348+
</td>
1349+
</tr>
1350+
<tr>
1351+
<td>
12801352
<code>owner</code><br/>
12811353
<em>
12821354
<a href="https://pkg.go.dev/github.com/Azure/azure-service-operator/v2/pkg/genruntime#ArbitraryOwnerReference">
@@ -1342,6 +1414,36 @@ RoleDefinition_STATUS
13421414
</tr>
13431415
</tbody>
13441416
</table>
1417+
<h3 id="authorization.azure.com/v1api20220401.RoleDefinitionOperatorSpec">RoleDefinitionOperatorSpec
1418+
</h3>
1419+
<p>
1420+
(<em>Appears on:</em><a href="#authorization.azure.com/v1api20220401.RoleDefinition_Spec">RoleDefinition_Spec</a>)
1421+
</p>
1422+
<div>
1423+
<p>Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure</p>
1424+
</div>
1425+
<table>
1426+
<thead>
1427+
<tr>
1428+
<th>Field</th>
1429+
<th>Description</th>
1430+
</tr>
1431+
</thead>
1432+
<tbody>
1433+
<tr>
1434+
<td>
1435+
<code>namingConvention</code><br/>
1436+
<em>
1437+
string
1438+
</em>
1439+
</td>
1440+
<td>
1441+
<p>NamingConvention: The uuid generation technique to use for any role without an explicit AzureName. One of &lsquo;stable&rsquo; or
1442+
&lsquo;random&rsquo;.</p>
1443+
</td>
1444+
</tr>
1445+
</tbody>
1446+
</table>
13451447
<h3 id="authorization.azure.com/v1api20220401.RoleDefinitionProperties_ARM">RoleDefinitionProperties_ARM
13461448
</h3>
13471449
<p>
@@ -1814,6 +1916,20 @@ string
18141916
</tr>
18151917
<tr>
18161918
<td>
1919+
<code>operatorSpec</code><br/>
1920+
<em>
1921+
<a href="#authorization.azure.com/v1api20220401.RoleDefinitionOperatorSpec">
1922+
RoleDefinitionOperatorSpec
1923+
</a>
1924+
</em>
1925+
</td>
1926+
<td>
1927+
<p>OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not
1928+
passed directly to Azure</p>
1929+
</td>
1930+
</tr>
1931+
<tr>
1932+
<td>
18171933
<code>owner</code><br/>
18181934
<em>
18191935
<a href="https://pkg.go.dev/github.com/Azure/azure-service-operator/v2/pkg/genruntime#ArbitraryOwnerReference">

‎docs/hugo/content/reference/redhatopenshift/_index.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ To install the CRDs for these resources, your ASO configuration must include `re
99

1010
These resource(s) are available for use in the current release of ASO. Different versions of a given resource reflect different versions of the Azure ARM API.
1111

12-
| Resource | ARM Version | CRD Version | Supported From | Sample |
13-
|------------------|-------------|---------------|----------------|----------------------------------------------------------------------------------------------------------------------------------------|
14-
| OpenShiftCluster | 2023-11-22 | v1api20231122 | v2.9.0 | [View](https://github.com/Azure/azure-service-operator/tree/main/v2/samples/redhatopenshift/v1api/v1api20231122_openshiftcluster.yaml) |
12+
| Resource | ARM Version | CRD Version | Supported From | Sample |
13+
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|---------------|----------------|----------------------------------------------------------------------------------------------------------------------------------------|
14+
| [OpenShiftCluster](https://azure.github.io/azure-service-operator/reference/redhatopenshift/v1api20231122/#redhatopenshift.azure.com/v1api20231122.OpenShiftCluster) | 2023-11-22 | v1api20231122 | v2.9.0 | [View](https://github.com/Azure/azure-service-operator/tree/main/v2/samples/redhatopenshift/v1api/v1api20231122_openshiftcluster.yaml) |
1515

0 commit comments

Comments
 (0)