Skip to content

Commit 6104ede

Browse files
azure-service-operator-automation[bot]theunrepentantgeek
azure-service-operator-automation[bot]
and
theunrepentantgeek
authored
Update API Docs (#4793)
Co-authored-by: theunrepentantgeek <1272094+theunrepentantgeek@users.noreply.github.com>
1 parent 52b8ce8 commit 6104ede

File tree

2 files changed

+119
-4
lines changed

2 files changed

+119
-4
lines changed

‎docs/hugo/content/reference/entra/v1.md‎

Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
1+
---
2+
3+
title: entra.azure.com/
4+
5+
linktitle:
6+
----------
7+
8+
SecurityGroup{#SecurityGroup}
9+
-----------------------------
10+
11+
<br/>SecurityGroup is an Entra Security Group.
12+
13+
Used by: [SecurityGroupList](#SecurityGroupList).
14+
15+
| Property | Description | Type |
16+
|-----------------------------------------------------------------------------------------|-------------|-------------------------------------------------------------------------|
17+
| [metav1.TypeMeta](https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#TypeMeta) | | |
18+
| [metav1.ObjectMeta](https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#ObjectMeta) | | |
19+
| spec | | [SecurityGroupSpec](#SecurityGroupSpec)<br/><small>Optional</small> |
20+
| status | | [SecurityGroupStatus](#SecurityGroupStatus)<br/><small>Optional</small> |
21+
22+
### SecurityGroupSpec {#SecurityGroupSpec}
23+
24+
| Property | Description | Type |
25+
|--------------------|--------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------|
26+
| description | The description of the group. | string<br/><small>Optional</small> |
27+
| displayName | The display name of the group. | string<br/><small>Required</small> |
28+
| isAssignableToRole | Indicates whether the group can be assigned to a role. | bool<br/><small>Optional</small> |
29+
| mailNickname | The email address of the group, specified either as a mail nickname (`mygroup`) or as a full email address (`mygroup@mydomain.com`). | string<br/><small>Required</small> |
30+
| membershipType | The membership type of the group. | [SecurityGroupMembershipType](#SecurityGroupMembershipType)<br/><small>Optional</small> |
31+
| operatorSpec | The operator specific configuration for the resource. | [SecurityGroupOperatorSpec](#SecurityGroupOperatorSpec)<br/><small>Optional</small> |
32+
33+
### SecurityGroupStatus{#SecurityGroupStatus}
34+
35+
| Property | Description | Type |
36+
|-------------------|-------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|
37+
| conditions | The observed state of the resource | [conditions.Condition[]](https://pkg.go.dev/github.com/Azure/azure-service-operator/v2/pkg/genruntime/conditions#Condition)<br/><small>Optional</small> |
38+
| description | The description of the group. | string<br/><small>Optional</small> |
39+
| displayName | The display name of the group. | string<br/><small>Optional</small> |
40+
| entraID | The GUID identifing the resource in Entra | string<br/><small>Optional</small> |
41+
| groupEmailAddress | The email address of the group. | string<br/><small>Required</small> |
42+
43+
SecurityGroupList{#SecurityGroupList}
44+
-------------------------------------
45+
46+
| Property | Description | Type |
47+
|-------------------------------------------------------------------------------------|-------------|---------------------------------------------------------------|
48+
| [metav1.TypeMeta](https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#TypeMeta) | | |
49+
| [metav1.ListMeta](https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#ListMeta) | | |
50+
| items | | [SecurityGroup[]](#SecurityGroup)<br/><small>Optional</small> |
51+
52+
SecurityGroupSpec{#SecurityGroupSpec}
53+
-------------------------------------
54+
55+
Used by: [SecurityGroup](#SecurityGroup).
56+
57+
| Property | Description | Type |
58+
|--------------------|--------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------|
59+
| description | The description of the group. | string<br/><small>Optional</small> |
60+
| displayName | The display name of the group. | string<br/><small>Required</small> |
61+
| isAssignableToRole | Indicates whether the group can be assigned to a role. | bool<br/><small>Optional</small> |
62+
| mailNickname | The email address of the group, specified either as a mail nickname (`mygroup`) or as a full email address (`mygroup@mydomain.com`). | string<br/><small>Required</small> |
63+
| membershipType | The membership type of the group. | [SecurityGroupMembershipType](#SecurityGroupMembershipType)<br/><small>Optional</small> |
64+
| operatorSpec | The operator specific configuration for the resource. | [SecurityGroupOperatorSpec](#SecurityGroupOperatorSpec)<br/><small>Optional</small> |
65+
66+
SecurityGroupStatus{#SecurityGroupStatus}
67+
-----------------------------------------
68+
69+
Used by: [SecurityGroup](#SecurityGroup).
70+
71+
| Property | Description | Type |
72+
|-------------------|-------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|
73+
| conditions | The observed state of the resource | [conditions.Condition[]](https://pkg.go.dev/github.com/Azure/azure-service-operator/v2/pkg/genruntime/conditions#Condition)<br/><small>Optional</small> |
74+
| description | The description of the group. | string<br/><small>Optional</small> |
75+
| displayName | The display name of the group. | string<br/><small>Optional</small> |
76+
| entraID | The GUID identifing the resource in Entra | string<br/><small>Optional</small> |
77+
| groupEmailAddress | The email address of the group. | string<br/><small>Required</small> |
78+
79+
SecurityGroupMembershipType{#SecurityGroupMembershipType}
80+
---------------------------------------------------------
81+
82+
Used by: [SecurityGroupSpec](#SecurityGroupSpec).
83+
84+
SecurityGroupOperatorSpec{#SecurityGroupOperatorSpec}
85+
-----------------------------------------------------
86+
87+
Used by: [SecurityGroupSpec](#SecurityGroupSpec).
88+
89+
| Property | Description | Type |
90+
|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------|
91+
| configmaps | ConfigMaps specifies any config maps that should be created by the operator. | [SecurityGroupOperatorConfigMaps](#SecurityGroupOperatorConfigMaps)<br/><small>Optional</small> |
92+
| creationMode | Specifies how ASO will try to create the resource. Specify "AlwaysCreate" to always create a new security group when first reconciled. Or specify "AdoptOrCreate" to first try to adopt an existing security group with the same display name. If multiple security groups with the same display name are found, the resource condition will show an error. If not specified, defaults to "AdoptOrCreate". | [CreationMode](#CreationMode)<br/><small>Optional</small> |
93+
94+
CreationMode{#CreationMode}
95+
---------------------------
96+
97+
CreationMode specifies how ASO will try to create the Entra resource.
98+
99+
Used by: [SecurityGroupOperatorSpec](#SecurityGroupOperatorSpec).
100+
101+
SecurityGroupOperatorConfigMaps{#SecurityGroupOperatorConfigMaps}
102+
-----------------------------------------------------------------
103+
104+
Used by: [SecurityGroupOperatorSpec](#SecurityGroupOperatorSpec).
105+
106+
| Property | Description | Type |
107+
|----------|----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------|
108+
| entraID | The Entra ID of the group. | [genruntime.ConfigMapDestination](https://pkg.go.dev/github.com/Azure/azure-service-operator/v2/pkg/genruntime#ConfigMapDestination)<br/><small>Optional</small> |

0 commit comments

Comments
 (0)