Secret Syncs - Update
更新 SecretSync 实例。
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SecretSyncController/secretSyncs/{secretSyncName}?api-version=2024-08-21-preview
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
resource
|
path | True |
string minLength: 1maxLength: 90 |
资源组的名称。 名称不区分大小写。 |
secret
|
path | True |
string maxLength: 253pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$ |
SecretSync 的名称 |
subscription
|
path | True |
string (uuid) |
目标订阅的 ID。 该值必须是 UUID。 |
api-version
|
query | True |
string minLength: 1 |
用于此操作的 API 版本。 |
请求正文
名称 | 类型 | 说明 |
---|---|---|
properties.forceSynchronization |
string maxLength: 253pattern: ^[A-Za-z0-9]([-A-Za-z0-9]+([-._a-zA-Z0-9]?[A-Za-z0-9])*)? |
ForceSynchronization 可用于强制进行机密同步。 通过更改此字段中的值来触发机密同步。 此字段不用于解决同步冲突。 |
properties.objectSecretMapping |
SecretObjectData 数组,用于将机密数据从外部机密提供程序映射到 Kubernetes 机密。 每个条目指定外部提供程序中的源机密以及 Kubernetes 机密中的相应密钥。 |
|
properties.secretProviderClassName |
string minLength: 1maxLength: 253 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$ |
SecretProviderClassName 指定 SecretProviderClass 资源的名称,其中包含访问云提供程序机密存储所需的信息。 |
properties.serviceAccountName |
string minLength: 1maxLength: 253 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$ |
ServiceAccountName 指定用于访问云提供程序机密存储的服务帐户的名称。 必须在控制器配置中将服务帐户令牌中的受众字段作为参数传递。 从服务帐户的 API 服务器请求令牌时,将使用访问群体;支持受众由每个提供程序定义。 |
tags |
object |
资源标记。 |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
Azure 操作已成功完成。 |
|
202 Accepted |
接受资源更新请求。 标头
|
|
Other Status Codes |
意外的错误响应。 |
安全性
azure_auth
Azure Active Directory OAuth2 Flow。
类型:
oauth2
流向:
implicit
授权 URL:
https://login.microsoftonline.com/common/oauth2/authorize
作用域
名称 | 说明 |
---|---|
user_impersonation | 模拟用户帐户 |
示例
SecretSyncs_Update
示例请求
PATCH https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-ssc-example/providers/Microsoft.SecretSyncController/secretSyncs/secretsync-ssc-example?api-version=2024-08-21-preview
{
"tags": {
"example-tag": "example-tag-value"
},
"properties": {
"secretProviderClassName": "jttlpenhtpxfrrlxdsmqqvmvtmgqrficvqngkggjwciilrexenlstxncyvkqcydxrivkioujssncoaiysdklfouukczzdbxniipbyiqsarqaespuqrbbydwtdaulllostoomntkadklihemfpeffvuyvyilequiqewzspaootvkibrynbqrsbiptjdhywynvydaadprdc",
"serviceAccountName": "fcldqfdfpktndlntuoxicsftelhefevovmlycflfwzckvamiqjnjugandqaqqeccsbzztfmmeunvhsafgerbcsdbnmsyqivygornebbkusuvphwghgouxvcbvmbydqjzoxextnyowsnyymadniwdrrxtogeveldpejixmsrzzfqkquaxdpzwvecevqwasxgxxchrfa",
"objectSecretMapping": [
{
"sourcePath": "ssrzmbvdiomkvzrdsyilwlfzicfydnbjwjsnohrppkukjddrunfslkrnexunuckmghixdssposvndpiqchpqrkjuqbapoisvqdvgstvdonsmlpsmticfvuhqlofpaxfdg",
"targetKey": "lojegeqiqfjxyblfxhxloccqzwgpgcelrwqwsbsltcjvjvceejgdrmxhenokxrylhynkltvqntjcvujjrppzvcxyivxeksgmzhifrcklizbpntdepzdl"
}
],
"forceSynchronization": "arbitrarystring"
}
}
示例响应
{
"properties": {
"provisioningState": "Succeeded",
"secretProviderClassName": "akvspc-ssc-example",
"serviceAccountName": "example-k8s-sa-name",
"kubernetesSecretType": "Opaque",
"objectSecretMapping": [
{
"sourcePath": "kv-secret-name/0",
"targetKey": "kv-secret-name/0"
}
],
"forceSynchronization": "arbitrarystring",
"status": {
"conditions": [
{
"lastTransitionTime": "2024-08-02T12:50:34Z",
"message": "Secret created successfully.",
"observedGeneration": 25,
"reason": "CreateSucceeded",
"status": "True",
"type": "Create"
}
],
"lastSuccessfulSyncTime": "2024-07-28T18:12:04Z"
}
},
"extendedLocation": {
"name": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-ssc-example/providers/Microsoft.ExtendedLocation/customLocations/example-custom-location",
"type": "CustomLocation"
},
"tags": {
"example-tag": "example-tag-value"
},
"location": "eastus",
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-ssc-example/providers/Microsoft.SecretSyncController/secretsync/secretsync-ssc-example",
"name": "secretsync-ssc-example"
}
location: https://contoso.com/operationstatus
定义
名称 | 说明 |
---|---|
Azure. |
扩展位置的复杂类型。 |
created |
创建资源的标识的类型。 |
Error |
资源管理错误附加信息。 |
Error |
错误详细信息。 |
Error |
错误响应 |
Extended |
扩展位置的类型。 |
Kubernetes |
定义云机密存储对象与 Kubernetes 机密之间的映射的属性。 |
Kubernetes |
支持的 Kubernetes 机密类型。 |
Provisioning |
资源的预配状态。 |
Secret |
SecretSync 资源。 |
Secret |
条件表示机密创建和更新进程的状态。 |
Secret |
SecretSyncStatus 定义机密同步过程的观察状态。 |
Secret |
用于 SecretSync 更新操作的类型。 |
Status |
状态条件类型 |
system |
与创建和上次修改资源相关的元数据。 |
Azure.ResourceManager.CommonTypes.ExtendedLocation
扩展位置的复杂类型。
名称 | 类型 | 说明 |
---|---|---|
name |
string |
扩展位置的名称。 |
type |
扩展位置的类型。 |
createdByType
创建资源的标识的类型。
值 | 说明 |
---|---|
Application | |
Key | |
ManagedIdentity | |
User |
ErrorAdditionalInfo
资源管理错误附加信息。
名称 | 类型 | 说明 |
---|---|---|
info |
object |
其他信息。 |
type |
string |
其他信息类型。 |
ErrorDetail
错误详细信息。
名称 | 类型 | 说明 |
---|---|---|
additionalInfo |
错误附加信息。 |
|
code |
string |
错误代码。 |
details |
错误详细信息。 |
|
message |
string |
错误消息。 |
target |
string |
错误目标。 |
ErrorResponse
错误响应
名称 | 类型 | 说明 |
---|---|---|
error |
错误对象。 |
ExtendedLocationType
扩展位置的类型。
值 | 说明 |
---|---|
CustomLocation |
Azure 自定义位置类型 |
EdgeZone |
Azure Edge 区域位置类型 |
KubernetesSecretObjectMapping
定义云机密存储对象与 Kubernetes 机密之间的映射的属性。
名称 | 类型 | 说明 |
---|---|---|
sourcePath |
string minLength: 1maxLength: 253 pattern: ^[A-Za-z0-9.]([-A-Za-z0-9]+([-._a-zA-Z0-9]?[A-Za-z0-9])*)?(\/([0-9]+))*$ |
SourcePath 是外部机密提供程序定义的机密数据的标识符。 这是提供程序系统中机密的密钥或路径,该密钥或路径将装载到 Pod 中的特定路径。 该值应与 SecretProviderClass 的对象数组中指定的机密名称匹配。 |
targetKey |
string minLength: 1maxLength: 253 pattern: ^[A-Za-z0-9.]([-A-Za-z0-9]+([-._a-zA-Z0-9]?[A-Za-z0-9])*)?(\/([0-9]+))*$ |
TargetKey 是 Kubernetes 机密数据字段中的密钥,其中将存储机密值。 此密钥用于引用 Kubernetes 中的机密数据,该密钥在机密中应是唯一的。 |
KubernetesSecretType
支持的 Kubernetes 机密类型。
值 | 说明 |
---|---|
Opaque |
不透明是默认机密类型。 |
kubernetes.io/tls |
kubernetes.io/tls 机密类型用于存储证书及其通常用于 TLS 的关联密钥。 |
ProvisioningState
资源的预配状态。
值 | 说明 |
---|---|
Canceled |
资源创建已取消。 |
Failed |
资源创建失败。 |
Succeeded |
已创建资源。 |
SecretSync
SecretSync 资源。
名称 | 类型 | 说明 |
---|---|---|
extendedLocation |
扩展位置的复杂类型。 |
|
id |
string (arm-id) |
资源的完全限定资源 ID。 例如“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}” |
location |
string |
资源所在的地理位置 |
name |
string |
资源的名称 |
properties.forceSynchronization |
string maxLength: 253pattern: ^[A-Za-z0-9]([-A-Za-z0-9]+([-._a-zA-Z0-9]?[A-Za-z0-9])*)? |
ForceSynchronization 可用于强制进行机密同步。 通过更改此字段中的值来触发机密同步。 此字段不用于解决同步冲突。 |
properties.kubernetesSecretType |
类型指定 Kubernetes 机密对象的类型,例如“Opaque”或“kubernetes.io/tls”。 控制器必须具有创建指定类型的机密的权限。 |
|
properties.objectSecretMapping |
SecretObjectData 数组,用于将机密数据从外部机密提供程序映射到 Kubernetes 机密。 每个条目指定外部提供程序中的源机密以及 Kubernetes 机密中的相应密钥。 |
|
properties.provisioningState |
SecretSync 实例的预配状态。 |
|
properties.secretProviderClassName |
string minLength: 1maxLength: 253 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$ |
SecretProviderClassName 指定 SecretProviderClass 资源的名称,其中包含访问云提供程序机密存储所需的信息。 |
properties.serviceAccountName |
string minLength: 1maxLength: 253 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$ |
ServiceAccountName 指定用于访问云提供程序机密存储的服务帐户的名称。 必须在控制器配置中将服务帐户令牌中的受众字段作为参数传递。 从服务帐户的 API 服务器请求令牌时,将使用访问群体;支持受众由每个提供程序定义。 |
properties.status |
SecretSyncStatus 定义机密同步过程的观察状态。 |
|
systemData |
包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。 |
|
tags |
object |
资源标记。 |
type |
string |
资源的类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts” |
SecretSyncCondition
条件表示机密创建和更新进程的状态。
名称 | 类型 | 说明 |
---|---|---|
lastTransitionTime |
string (date-time) |
LastTransitionTime 是条件从一个状态转换到另一个状态的最后一次。 这应该是基础条件更改时。 如果不知道,则使用 API 字段更改的时间是可接受的。 |
message |
string |
消息是一条可读消息,指示有关转换的详细信息。 这可能是空字符串。 |
observedGeneration |
integer (int64) |
ObservedGeneration 表示基于条件设置的 .metadata.generation。 例如,如果 .metadata.generation 当前为 12,但 .status.conditions[x].observedGeneration 为 9,则条件相对于实例的当前状态已过期。 |
reason |
string minLength: 1maxLength: 1024 pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$ |
Reason 包含一个编程标识符,指示条件上次转换的原因。 特定条件类型的生成者可以定义此字段的预期值和含义,以及这些值是否被视为有保证的 API。 该值应为 CamelCase 字符串。 此字段可能不为空。 |
status |
条件的状态,其中一个为 True、False、Unknown。 |
|
type |
string maxLength: 316pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$ |
CamelCase 或 foo.example.com/CamelCase 中的条件类型。 许多 .condition.type 值在可用等资源之间是一致的,但由于任意条件可能很有用(请参阅 .node.status.conditions),因此去冲突的能力非常重要。 它匹配的正则表达式是 (dns1123SubdomainFmt/)?(qualifiedNameFmt) |
SecretSyncStatus
SecretSyncStatus 定义机密同步过程的观察状态。
名称 | 类型 | 说明 |
---|---|---|
conditions |
条件表示机密创建和更新过程的状态。 状态可以是 True、False 或 Unknown,并有多种原因和说明状态的消息。 原因示例包括 CreateSucceeded、ProviderError、InvalidClusterSecretLabelError、InvalidClusterSecretAnnotationError、UnknownError、ValidatingAdmissionPolicyCheckFailed、UserInputValidationFailed、ControllerSpcError、ControllerInternalError、NoValueChange 和 ValueChangeOrForceUpdateDetected。 |
|
lastSuccessfulSyncTime |
string (date-time) |
LastSuccessfulSyncTime 表示上次从提供程序检索机密并更新的时间。 |
SecretSyncUpdate
用于 SecretSync 更新操作的类型。
名称 | 类型 | 说明 |
---|---|---|
properties.forceSynchronization |
string maxLength: 253pattern: ^[A-Za-z0-9]([-A-Za-z0-9]+([-._a-zA-Z0-9]?[A-Za-z0-9])*)? |
ForceSynchronization 可用于强制进行机密同步。 通过更改此字段中的值来触发机密同步。 此字段不用于解决同步冲突。 |
properties.objectSecretMapping |
SecretObjectData 数组,用于将机密数据从外部机密提供程序映射到 Kubernetes 机密。 每个条目指定外部提供程序中的源机密以及 Kubernetes 机密中的相应密钥。 |
|
properties.secretProviderClassName |
string minLength: 1maxLength: 253 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$ |
SecretProviderClassName 指定 SecretProviderClass 资源的名称,其中包含访问云提供程序机密存储所需的信息。 |
properties.serviceAccountName |
string minLength: 1maxLength: 253 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$ |
ServiceAccountName 指定用于访问云提供程序机密存储的服务帐户的名称。 必须在控制器配置中将服务帐户令牌中的受众字段作为参数传递。 从服务帐户的 API 服务器请求令牌时,将使用访问群体;支持受众由每个提供程序定义。 |
tags |
object |
资源标记。 |
StatusConditionType
状态条件类型
值 | 说明 |
---|---|
False |
状态为 false |
True |
状态为 true |
Unknown |
状态未知 |
systemData
与创建和上次修改资源相关的元数据。
名称 | 类型 | 说明 |
---|---|---|
createdAt |
string (date-time) |
资源创建时间戳(UTC)。 |
createdBy |
string |
创建资源的标识。 |
createdByType |
创建资源的标识的类型。 |
|
lastModifiedAt |
string (date-time) |
上次修改的资源时间戳(UTC) |
lastModifiedBy |
string |
上次修改资源的标识。 |
lastModifiedByType |
上次修改资源的标识的类型。 |