Secret Syncs - Get

Referência

Serviço:: Secret Sync Controller

Versão da API:: 2024-08-21-preview

Obtém as propriedades de uma instância do SecretSync.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SecretSyncController/secretSyncs/{secretSyncName}?api-version=2024-08-21-preview

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
resourceGroupName	path	True	string	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
secretSyncName	path	True	string	O nome do SecretSync Padrão Regex: `^[a-z0-9]([-a-z0-9][a-z0-9])?(\.[a-z0-9]([-a-z0-9][a-z0-9])?)*$`
subscriptionId	path	True	string uuid	A ID da assinatura de destino. O valor deve ser um UUID.
api-version	query	True	string	A versão da API a ser usada para esta operação.

Respostas

Name	Tipo	Description
200 OK	SecretSync	Operação do Azure concluída com êxito.
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo OAuth2 do Azure Ative Directory.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

SecretSyncs_Get

Pedido de amostra

HTTP

GET 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

Resposta da amostra

Código de estado:: 200

{
  "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"
}

Definições

Name	Description
Azure.ResourceManager.CommonTypes.ExtendedLocation	O tipo complexo do local estendido.
createdByType	O tipo de identidade que criou o recurso.
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
ExtendedLocationType	O tipo de local estendido.
KubernetesSecretObjectMapping	Propriedades que definem o mapeamento entre um objeto de armazenamento secreto na nuvem e um Segredo do Kubernetes.
KubernetesSecretType	Tipos secretos Kubernetes suportados.
ProvisioningState	Estado de provisionamento do recurso.
SecretSync	O recurso SecretSync.
SecretSyncCondition	Uma condição representa o status dos processos secretos de criação e atualização.
SecretSyncStatus	SecretSyncStatus define o estado observado do processo de sincronização secreta.
StatusConditionType	Tipos de condições de status
systemData	Metadados referentes à criação e última modificação do recurso.

Azure.ResourceManager.CommonTypes.ExtendedLocation

O tipo complexo do local estendido.

Name	Tipo	Description
name	string	O nome do local estendido.
type	ExtendedLocationType	O tipo de local estendido.

createdByType

O tipo de identidade que criou o recurso.

Name	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

O erro de gerenciamento de recursos informações adicionais.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Resposta de erro

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

ExtendedLocationType

O tipo de local estendido.

Name	Tipo	Description
CustomLocation	string	Tipo de Locais Personalizados do Azure
EdgeZone	string	Tipo de local das Zonas de Borda do Azure

KubernetesSecretObjectMapping

Propriedades que definem o mapeamento entre um objeto de armazenamento secreto na nuvem e um Segredo do Kubernetes.

Name	Tipo	Description
sourcePath	string	SourcePath é o identificador dos dados secretos, conforme definido pelo provedor de segredo externo. Esta é a chave ou caminho para o segredo no sistema do provedor, que é montado em um caminho específico no pod. O valor deve corresponder ao nome do segredo conforme especificado na matriz de objetos de SecretProviderClass.
targetKey	string	TargetKey é a chave no campo de dados do segredo do Kubernetes onde o valor secreto será armazenado. Essa chave é usada para fazer referência aos dados secretos dentro do Kubernetes e deve ser exclusiva dentro do segredo.

KubernetesSecretType

Tipos secretos Kubernetes suportados.

Name	Tipo	Description
Opaque	string	Opaco é o tipo secreto padrão.
kubernetes.io/tls	string	O tipo de segredo kubernetes.io/tls é para armazenar um certificado e sua chave associada que normalmente são usados para TLS.

ProvisioningState

Estado de provisionamento do recurso.

Name	Tipo	Description
Canceled	string	A criação de recursos foi cancelada.
Failed	string	Falha na criação de recursos.
Succeeded	string	O recurso foi criado.

SecretSync

O recurso SecretSync.

Name	Tipo	Description
extendedLocation	Azure.ResourceManager.CommonTypes.ExtendedLocation	O tipo complexo do local estendido.
id	string	ID de recurso totalmente qualificado para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string	A geolocalização onde o recurso vive
name	string	O nome do recurso
properties.forceSynchronization	string	ForceSynchronization pode ser usado para forçar a sincronização secreta. A sincronização secreta é acionada alterando o valor neste campo. Este campo não é usado para resolver conflitos de sincronização.
properties.kubernetesSecretType	KubernetesSecretType	Type especifica o tipo do objeto secreto do Kubernetes, por exemplo, "Opaco" ou "kubernetes.io/tls". O controlador deve ter permissão para criar segredos do tipo especificado.
properties.objectSecretMapping	KubernetesSecretObjectMapping[]	Uma matriz de SecretObjectData que mapeia dados secretos do provedor secreto externo para o segredo do Kubernetes. Cada entrada especifica o segredo de origem no provedor externo e a chave correspondente no segredo do Kubernetes.
properties.provisioningState	ProvisioningState	Estado de provisionamento da instância SecretSync.
properties.secretProviderClassName	string	SecretProviderClassName especifica o nome do recurso SecretProviderClass, que contém as informações necessárias para acessar o armazenamento secreto do provedor de nuvem.
properties.serviceAccountName	string	ServiceAccountName especifica o nome da conta de serviço usada para acessar o armazenamento secreto do provedor de nuvem. O campo audiência no token da conta de serviço deve ser passado como parâmetro na configuração do controlador. A audiência é usada ao solicitar um token do servidor de API para a conta de serviço; Os públicos suportados são definidos por cada provedor.
properties.status	SecretSyncStatus	SecretSyncStatus define o estado observado do processo de sincronização secreta.
systemData	systemData	Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.
tags	object	Tags de recursos.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

SecretSyncCondition

Uma condição representa o status dos processos secretos de criação e atualização.

Name	Tipo	Description
lastTransitionTime	string	LastTransitionTime é a última vez que a condição transitou de um status para outro. Isto deve ocorrer quando a condição subjacente mudou. Se isso não for conhecido, então usar o tempo em que o campo API foi alterado é aceitável.
message	string	Mensagem é uma mensagem legível por humanos que indica detalhes sobre a transição. Esta pode ser uma cadeia de caracteres vazia.
observedGeneration	integer	ObservedGeneration representa o .metadata.generation no qual a condição foi definida com base. Por exemplo, se .metadata.generation for atualmente 12, mas o .status.conditions[x].observedGeneration for 9, a condição está desatualizada em relação ao estado atual da instância.
reason	string	Reason contém um identificador programático que indica o motivo da última transição da condição. Os produtores de tipos de condição específicos podem definir valores e significados esperados para este campo e se os valores são considerados uma API garantida. O valor deve ser uma cadeia de caracteres CamelCase. Este campo pode não estar vazio.
status	StatusConditionType	Status da condição, um de Verdadeiro, Falso, Desconhecido.
type	string	Tipo de condição em CamelCase ou em foo.example.com/CamelCase. Muitos valores .condition.type são consistentes entre recursos como Disponível, mas como condições arbitrárias podem ser úteis (consulte .node.status.conditions), a capacidade de eliminar conflitos é importante. O regex que corresponde é (dns1123SubdomainFmt/)? (qualificadoNameFmt)

SecretSyncStatus

SecretSyncStatus define o estado observado do processo de sincronização secreta.

Name	Tipo	Description
conditions	SecretSyncCondition[]	As condições representam o status dos processos secretos de criação e atualização. O status pode ser Verdadeiro, Falso ou Desconhecido com vários motivos e mensagens explicando o estado. Exemplos de razões incluem CreateSucceeded, ProviderError, InvalidClusterSecretLabelError, InvalidClusterSecretAnnotationError, UnknownError, ValidatingAdmissionPolicyCheckFailed, UserInputValidationFailed, ControllerSpcError, ControllerInternalError, NoValueChange e ValueChangeOrForceUpdateDetected.
lastSuccessfulSyncTime	string	LastSuccessfulSyncTime representa a última vez que o segredo foi recuperado do Provedor e atualizado.

StatusConditionType

Tipos de condições de status

Name	Tipo	Description
False	string	O status é falso
True	string	O status é verdadeiro
Unknown	string	O status é desconhecido

systemData

Metadados referentes à criação e última modificação do recurso.

Name	Tipo	Description
createdAt	string	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

Partilhar via