Todos os produtos
Search
Central de documentação

Resource Orchestration Service:DATASOURCE::OOS::SecretParameter

Última atualização: Jun 27, 2026

Consulta os detalhes de um parâmetro de criptografia no Operation Orchestration Service (OOS).

Sintaxe

{
  "Type": "DATASOURCE::OOS::SecretParameter",
  "Properties": {
    "SecretParameterName": String,
    "RefreshOptions": String
  }
}

Propriedades

Propriedade

Tipo

Obrigatório

Editável

Descrição

Restrição

SecretParameterName

String

Sim

Sim

Nome do parâmetro.

Nenhuma.

RefreshOptions

String

Não

Sim

Estratégia de atualização dos recursos da source de dados durante a atualização da pilha.

Valores válidos:

  • Never (padrão): não atualiza os recursos da source de dados durante a atualização da pilha.

  • Always: atualiza os recursos da source de dados durante a atualização da pilha.

Valores de retorno

Fn::GetAtt

  • Description: descrição do parâmetro.

  • CreatedBy: usuário que criou o parâmetro.

  • ResourceGroupId: ID do grupo de recursos.

  • SecretParameterName: nome do parâmetro.

  • UpdatedDate: hora da última atualização do parâmetro.

  • CreateTime: hora de criação do parâmetro.

  • KeyId: ID da chave do Key Management Service (KMS) usada para criptografar o parâmetro.

  • SecretParameterId: ID do parâmetro.

  • UpdatedBy: usuário que atualizou o parâmetro.

  • Type: tipo do parâmetro.

  • Constraints: restrições do parâmetro.

  • ParameterVersion: versão do parâmetro.

  • Value: valor do parâmetro.

  • Tags: tags personalizadas do parâmetro.

  • ShareType: tipo de compartilhamento do parâmetro.

Exemplos

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  SecretParameterName:
    Type: String
    Description:
      en: The name of the parameter.
    Required: true
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::OOS::SecretParameter
    Properties:
      SecretParameterName:
        Ref: SecretParameterName
Outputs:
  Description:
    Description: The description of the encryption parameter.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Description
  CreatedBy:
    Description: The user who created the encryption parameter.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - CreatedBy
  ResourceGroupId:
    Description: The ID of the resource group.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ResourceGroupId
  SecretParameterName:
    Description: 'The name of the parameter. '
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - SecretParameterName
  UpdatedDate:
    Description: The time when the encryption parameter was updated.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - UpdatedDate
  CreateTime:
    Description: The time when the encryption parameter was created.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - CreateTime
  KeyId:
    Description: The ID of the key of Key Management Service (KMS) that is used for encryption.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - KeyId
  SecretParameterId:
    Description: The ID of the encryption parameter.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - SecretParameterId
  UpdatedBy:
    Description: The user who updated the encryption parameter.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - UpdatedBy
  Type:
    Description: The type of the parameter.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Type
  Constraints:
    Description: The constraints of the encryption parameter.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Constraints
  ParameterVersion:
    Description: The version number of the encryption parameter.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ParameterVersion
  Value:
    Description: The value of the encryption parameter.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Value
  Tags:
    Description: The tags of the parameter.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Tags
  ShareType:
    Description: The share type of the encryption parameter.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ShareType
{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "SecretParameterName": {
      "Type": "String",
      "Description": {
        "en": "The name of the parameter."
      },
      "Required": true
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::OOS::SecretParameter",
      "Properties": {
        "SecretParameterName": {
          "Ref": "SecretParameterName"
        }
      }
    }
  },
  "Outputs": {
    "Description": {
      "Description": "The description of the encryption parameter.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Description"
        ]
      }
    },
    "CreatedBy": {
      "Description": "The user who created the encryption parameter.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CreatedBy"
        ]
      }
    },
    "ResourceGroupId": {
      "Description": "The ID of the resource group.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ResourceGroupId"
        ]
      }
    },
    "SecretParameterName": {
      "Description": "The name of the parameter. ",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SecretParameterName"
        ]
      }
    },
    "UpdatedDate": {
      "Description": "The time when the encryption parameter was updated.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "UpdatedDate"
        ]
      }
    },
    "CreateTime": {
      "Description": "The time when the encryption parameter was created.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CreateTime"
        ]
      }
    },
    "KeyId": {
      "Description": "The ID of the key of Key Management Service (KMS) that is used for encryption.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "KeyId"
        ]
      }
    },
    "SecretParameterId": {
      "Description": "The ID of the encryption parameter.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SecretParameterId"
        ]
      }
    },
    "UpdatedBy": {
      "Description": "The user who updated the encryption parameter.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "UpdatedBy"
        ]
      }
    },
    "Type": {
      "Description": "The type of the parameter.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Type"
        ]
      }
    },
    "Constraints": {
      "Description": "The constraints of the encryption parameter.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Constraints"
        ]
      }
    },
    "ParameterVersion": {
      "Description": "The version number of the encryption parameter.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ParameterVersion"
        ]
      }
    },
    "Value": {
      "Description": "The value of the encryption parameter.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Value"
        ]
      }
    },
    "Tags": {
      "Description": "The tags of the parameter.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Tags"
        ]
      }
    },
    "ShareType": {
      "Description": "The share type of the encryption parameter.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ShareType"
        ]
      }
    }
  }
}