Skip to content

Commit 49d4305

Browse files
Update API Docs (#5022)
Co-authored-by: theunrepentantgeek <[email protected]>
1 parent 74b51f7 commit 49d4305

File tree

4 files changed

+44
-0
lines changed

4 files changed

+44
-0
lines changed

docs/hugo/content/reference/cache/v1api20210301.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -385,6 +385,7 @@ Used by: [RedisEnterpriseDatabase_Spec](#RedisEnterpriseDatabase_Spec).
385385
|----------------------|-----------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|
386386
| configMapExpressions | configures where to place operator written dynamic ConfigMaps (created with CEL expressions). | [core.DestinationExpression[]](https://pkg.go.dev/github.com/Azure/azure-service-operator/v2/pkg/genruntime/core#DestinationExpression)<br/><small>Optional</small> |
387387
| secretExpressions | configures where to place operator written dynamic secrets (created with CEL expressions). | [core.DestinationExpression[]](https://pkg.go.dev/github.com/Azure/azure-service-operator/v2/pkg/genruntime/core#DestinationExpression)<br/><small>Optional</small> |
388+
| secrets | configures where to place Azure generated secrets. | [RedisEnterpriseDatabaseOperatorSecrets](#RedisEnterpriseDatabaseOperatorSecrets)<br/><small>Optional</small> |
388389

389390
RedisEnterpriseOperatorSpec{#RedisEnterpriseOperatorSpec}
390391
---------------------------------------------------------
@@ -486,6 +487,16 @@ Used by: [Persistence_STATUS](#Persistence_STATUS).
486487
| "1h" | |
487488
| "6h" | |
488489

490+
RedisEnterpriseDatabaseOperatorSecrets{#RedisEnterpriseDatabaseOperatorSecrets}
491+
-------------------------------------------------------------------------------
492+
493+
Used by: [RedisEnterpriseDatabaseOperatorSpec](#RedisEnterpriseDatabaseOperatorSpec).
494+
495+
| Property | Description | Type |
496+
|--------------|--------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------|
497+
| primaryKey | indicates where the PrimaryKey secret should be placed. If omitted, the secret will not be retrieved from Azure. | [genruntime.SecretDestination](https://pkg.go.dev/github.com/Azure/azure-service-operator/v2/pkg/genruntime#SecretDestination)<br/><small>Optional</small> |
498+
| secondaryKey | indicates where the SecondaryKey secret should be placed. If omitted, the secret will not be retrieved from Azure. | [genruntime.SecretDestination](https://pkg.go.dev/github.com/Azure/azure-service-operator/v2/pkg/genruntime#SecretDestination)<br/><small>Optional</small> |
499+
489500
Sku_Name{#Sku_Name}
490501
-------------------
491502

docs/hugo/content/reference/cache/v1api20230701.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -409,6 +409,7 @@ Used by: [RedisEnterpriseDatabase_Spec](#RedisEnterpriseDatabase_Spec).
409409
|----------------------|-----------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|
410410
| configMapExpressions | configures where to place operator written dynamic ConfigMaps (created with CEL expressions). | [core.DestinationExpression[]](https://pkg.go.dev/github.com/Azure/azure-service-operator/v2/pkg/genruntime/core#DestinationExpression)<br/><small>Optional</small> |
411411
| secretExpressions | configures where to place operator written dynamic secrets (created with CEL expressions). | [core.DestinationExpression[]](https://pkg.go.dev/github.com/Azure/azure-service-operator/v2/pkg/genruntime/core#DestinationExpression)<br/><small>Optional</small> |
412+
| secrets | configures where to place Azure generated secrets. | [RedisEnterpriseDatabaseOperatorSecrets](#RedisEnterpriseDatabaseOperatorSecrets)<br/><small>Optional</small> |
412413

413414
RedisEnterpriseOperatorSpec{#RedisEnterpriseOperatorSpec}
414415
---------------------------------------------------------
@@ -533,6 +534,16 @@ Used by: [Persistence_STATUS](#Persistence_STATUS).
533534
| "1h" | |
534535
| "6h" | |
535536

537+
RedisEnterpriseDatabaseOperatorSecrets{#RedisEnterpriseDatabaseOperatorSecrets}
538+
-------------------------------------------------------------------------------
539+
540+
Used by: [RedisEnterpriseDatabaseOperatorSpec](#RedisEnterpriseDatabaseOperatorSpec).
541+
542+
| Property | Description | Type |
543+
|--------------|--------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------|
544+
| primaryKey | indicates where the PrimaryKey secret should be placed. If omitted, the secret will not be retrieved from Azure. | [genruntime.SecretDestination](https://pkg.go.dev/github.com/Azure/azure-service-operator/v2/pkg/genruntime#SecretDestination)<br/><small>Optional</small> |
545+
| secondaryKey | indicates where the SecondaryKey secret should be placed. If omitted, the secret will not be retrieved from Azure. | [genruntime.SecretDestination](https://pkg.go.dev/github.com/Azure/azure-service-operator/v2/pkg/genruntime#SecretDestination)<br/><small>Optional</small> |
546+
536547
Sku_Name{#Sku_Name}
537548
-------------------
538549

docs/hugo/content/reference/cache/v1api20250401.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -578,6 +578,7 @@ Used by: [RedisEnterpriseDatabase_Spec](#RedisEnterpriseDatabase_Spec).
578578
|----------------------|-----------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|
579579
| configMapExpressions | configures where to place operator written dynamic ConfigMaps (created with CEL expressions). | [core.DestinationExpression[]](https://pkg.go.dev/github.com/Azure/azure-service-operator/v2/pkg/genruntime/core#DestinationExpression)<br/><small>Optional</small> |
580580
| secretExpressions | configures where to place operator written dynamic secrets (created with CEL expressions). | [core.DestinationExpression[]](https://pkg.go.dev/github.com/Azure/azure-service-operator/v2/pkg/genruntime/core#DestinationExpression)<br/><small>Optional</small> |
581+
| secrets | configures where to place Azure generated secrets. | [RedisEnterpriseDatabaseOperatorSecrets](#RedisEnterpriseDatabaseOperatorSecrets)<br/><small>Optional</small> |
581582

582583
RedisEnterpriseOperatorSpec{#RedisEnterpriseOperatorSpec}
583584
---------------------------------------------------------
@@ -769,6 +770,16 @@ Used by: [Persistence_STATUS](#Persistence_STATUS).
769770
| "1h" | |
770771
| "6h" | |
771772

773+
RedisEnterpriseDatabaseOperatorSecrets{#RedisEnterpriseDatabaseOperatorSecrets}
774+
-------------------------------------------------------------------------------
775+
776+
Used by: [RedisEnterpriseDatabaseOperatorSpec](#RedisEnterpriseDatabaseOperatorSpec).
777+
778+
| Property | Description | Type |
779+
|--------------|--------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------|
780+
| primaryKey | indicates where the PrimaryKey secret should be placed. If omitted, the secret will not be retrieved from Azure. | [genruntime.SecretDestination](https://pkg.go.dev/github.com/Azure/azure-service-operator/v2/pkg/genruntime#SecretDestination)<br/><small>Optional</small> |
781+
| secondaryKey | indicates where the SecondaryKey secret should be placed. If omitted, the secret will not be retrieved from Azure. | [genruntime.SecretDestination](https://pkg.go.dev/github.com/Azure/azure-service-operator/v2/pkg/genruntime#SecretDestination)<br/><small>Optional</small> |
782+
772783
Sku_Name{#Sku_Name}
773784
-------------------
774785

docs/hugo/content/reference/operationalinsights/v1api20210601.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -232,6 +232,7 @@ Used by: [Workspace_Spec](#Workspace_Spec).
232232
|----------------------|-----------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|
233233
| configMapExpressions | configures where to place operator written dynamic ConfigMaps (created with CEL expressions). | [core.DestinationExpression[]](https://pkg.go.dev/github.com/Azure/azure-service-operator/v2/pkg/genruntime/core#DestinationExpression)<br/><small>Optional</small> |
234234
| secretExpressions | configures where to place operator written dynamic secrets (created with CEL expressions). | [core.DestinationExpression[]](https://pkg.go.dev/github.com/Azure/azure-service-operator/v2/pkg/genruntime/core#DestinationExpression)<br/><small>Optional</small> |
235+
| secrets | configures where to place Azure generated secrets. | [WorkspaceOperatorSecrets](#WorkspaceOperatorSecrets)<br/><small>Optional</small> |
235236

236237
WorkspaceProperties_ProvisioningState{#WorkspaceProperties_ProvisioningState}
237238
-----------------------------------------------------------------------------
@@ -302,6 +303,16 @@ Used by: [WorkspaceCapping_STATUS](#WorkspaceCapping_STATUS).
302303
| "RespectQuota" | |
303304
| "SubscriptionSuspended" | |
304305

306+
WorkspaceOperatorSecrets{#WorkspaceOperatorSecrets}
307+
---------------------------------------------------
308+
309+
Used by: [WorkspaceOperatorSpec](#WorkspaceOperatorSpec).
310+
311+
| Property | Description | Type |
312+
|--------------------|--------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------|
313+
| primarySharedKey | indicates where the PrimarySharedKey secret should be placed. If omitted, the secret will not be retrieved from Azure. | [genruntime.SecretDestination](https://pkg.go.dev/github.com/Azure/azure-service-operator/v2/pkg/genruntime#SecretDestination)<br/><small>Optional</small> |
314+
| secondarySharedKey | indicates where the SecondarySharedKey secret should be placed. If omitted, the secret will not be retrieved from Azure. | [genruntime.SecretDestination](https://pkg.go.dev/github.com/Azure/azure-service-operator/v2/pkg/genruntime#SecretDestination)<br/><small>Optional</small> |
315+
305316
WorkspaceSku_CapacityReservationLevel{#WorkspaceSku_CapacityReservationLevel}
306317
-----------------------------------------------------------------------------
307318

0 commit comments

Comments
 (0)