Microsoft.SecretSyncController (preview:2024-08-21)

2025/06/05 • 1 updated methods

SecretSyncs_Update (updated)
Description :  Updates a SecretSync instance.
Reference :  Link ¶

⚶ Changes

{
  "#id": "SecretSyncs_Update",
  "$parameters": {
    "properties": {
      "$properties": {
        "properties": [
          {
            "@removed_0439f8008b13423aa5e7a2e1bf05ea32": {
              "#name": "kubernetesSecretType",
              "Description": "Type specifies the type of the Kubernetes secret object, e.g. \"Opaque\" or\"kubernetes.io/tls\". The controller must have permission to create secrets of the specified type.",
              "Enum": [
                [
                  "Opaque",
                  "Opaque is the default secret type."
                ],
                [
                  "kubernetes.io/tls",
                  "The kubernetes.io/tls secret type is for storing a certificate and its associated key that are typically used for TLS."
                ]
              ],
              "Required": false,
              "Type": "string"
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SecretSyncController/secretSyncs/{secretSyncName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
secretSyncName:
{
Description: The name of the SecretSync ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
secretProviderClassName:
{
Description: SecretProviderClassName specifies the name of the SecretProviderClass resource, which contains the information needed to access the cloud provider secret store. ,
Required: False ,
}
string ,
serviceAccountName:
{
Description: ServiceAccountName specifies the name of the service account used to access the cloud provider secret store. The audience field in the service account token must be passed as parameter in the controller configuration. The audience is used when requesting a token from the API server for the service account; the supported audiences are defined by each provider. ,
Required: False ,
}
string ,
forceSynchronization:
{
Description: ForceSynchronization can be used to force the secret synchronization. The secret synchronization is triggered by changing the value in this field. This field is not used to resolve synchronization conflicts. ,
Required: False ,
}
string ,
objectSecretMapping:
{
Description: An array of SecretObjectData that maps secret data from the external secret provider to the Kubernetes secret. Each entry specifies the source secret in the external provider and the corresponding key in the Kubernetes secret. ,
Required: False ,
}
[
{
sourcePath:
{
Description: SourcePath is the identifier for the secret data as defined by the external secret provider. This is the key or path to the secret in the provider's system, which gets mounted to a specific path in the pod. The value should match the name of the secret as specified in the SecretProviderClass's objects array. ,
Required: True ,
}
string ,
targetKey:
{
Description: TargetKey is the key in the Kubernetes secret's data field where the secret value will be stored. This key is used to reference the secret data within Kubernetes, and it should be unique within the secret. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
secretProviderClassName:
{
Description: SecretProviderClassName specifies the name of the SecretProviderClass resource, which contains the information needed to access the cloud provider secret store. ,
Required: True ,
}
string ,
serviceAccountName:
{
Description: ServiceAccountName specifies the name of the service account used to access the cloud provider secret store. The audience field in the service account token must be passed as parameter in the controller configuration. The audience is used when requesting a token from the API server for the service account; the supported audiences are defined by each provider. ,
Required: True ,
}
string ,
kubernetesSecretType:
{
Description: Type specifies the type of the Kubernetes secret object, e.g. "Opaque" or"kubernetes.io/tls". The controller must have permission to create secrets of the specified type. ,
Enum:
{
Opaque: Opaque is the default secret type. ,
kubernetes.io/tls: The kubernetes.io/tls secret type is for storing a certificate and its associated key that are typically used for TLS. ,
}
,
Required: True ,
}
enum ,
forceSynchronization:
{
Description: ForceSynchronization can be used to force the secret synchronization. The secret synchronization is triggered by changing the value in this field. This field is not used to resolve synchronization conflicts. ,
Required: False ,
}
string ,
objectSecretMapping:
{
Description: An array of SecretObjectData that maps secret data from the external secret provider to the Kubernetes secret. Each entry specifies the source secret in the external provider and the corresponding key in the Kubernetes secret. ,
Required: True ,
}
[
{
sourcePath:
{
Description: SourcePath is the identifier for the secret data as defined by the external secret provider. This is the key or path to the secret in the provider's system, which gets mounted to a specific path in the pod. The value should match the name of the secret as specified in the SecretProviderClass's objects array. ,
Required: True ,
}
string ,
targetKey:
{
Description: TargetKey is the key in the Kubernetes secret's data field where the secret value will be stored. This key is used to reference the secret data within Kubernetes, and it should be unique within the secret. ,
Required: True ,
}
string ,
}
,
]
,
status:
{
Description: SecretSyncStatus defines the observed state of the secret synchronization process. ,
Required: False ,
}
{
lastSuccessfulSyncTime:
{
Description: LastSuccessfulSyncTime represents the last time the secret was retrieved from the Provider and updated. ,
Format: date-time ,
Required: False ,
}
string ,
conditions:
{
Description: Conditions represent the status of the secret create and update processes. The status can be True, False, or Unknown with various reasons and messages explaining the state. Examples of reasons include CreateSucceeded, ProviderError, InvalidClusterSecretLabelError, InvalidClusterSecretAnnotationError, UnknownError, ValidatingAdmissionPolicyCheckFailed, UserInputValidationFailed, ControllerSpcError, ControllerInternalError, NoValueChange, and ValueChangeOrForceUpdateDetected. ,
Required: False ,
}
[
{
lastTransitionTime:
{
Description: LastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. ,
Format: date-time ,
Required: False ,
}
string ,
message:
{
Description: Message is a human readable message indicating details about the transition. This may be an empty string. ,
Required: True ,
}
string ,
observedGeneration:
{
Description: ObservedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance. ,
Format: int64 ,
Required: False ,
}
integer ,
reason:
{
Description: Reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty. ,
Required: True ,
}
string ,
status:
{
Description: Status of the condition, one of True, False, Unknown. ,
Enum:
{
True: The status is true ,
False: The status is false ,
Unknown: The status is unknown ,
}
,
Required: True ,
}
enum ,
type:
{
Description: Type of condition in CamelCase or in foo.example.com/CamelCase. Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to de-conflict is important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt) ,
Required: True ,
}
string ,
}
,
]
,
}
,
provisioningState:
{
Description: Provisioning state of the SecretSync instance. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The complex type of the extended location. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: True ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: Azure Edge Zones location type ,
CustomLocation: Azure Custom Locations type ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}