Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Redpanda Provider
  3. API Docs
  4. getSchema
redpanda 1.2.1 published on Wednesday, Sep 10, 2025 by redpanda-data
redpanda-data/terraform-provider-redpanda

redpanda.getSchema

Explore with Pulumi AI

redpanda logo
redpanda 1.2.1 published on Wednesday, Sep 10, 2025 by redpanda-data
redpanda-data/terraform-provider-redpanda

    Schema data source allows you to retrieve information about a Schema Registry schema

    Using getSchema

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getSchema(args: GetSchemaArgs, opts?: InvokeOptions): Promise<GetSchemaResult>
function getSchemaOutput(args: GetSchemaOutputArgs, opts?: InvokeOptions): Output<GetSchemaResult>
    def get_schema(cluster_id: Optional[str] = None,
               subject: Optional[str] = None,
               version: Optional[float] = None,
               opts: Optional[InvokeOptions] = None) -> GetSchemaResult
def get_schema_output(cluster_id: Optional[pulumi.Input[str]] = None,
               subject: Optional[pulumi.Input[str]] = None,
               version: Optional[pulumi.Input[float]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetSchemaResult]
    func LookupSchema(ctx *Context, args *LookupSchemaArgs, opts ...InvokeOption) (*LookupSchemaResult, error)
func LookupSchemaOutput(ctx *Context, args *LookupSchemaOutputArgs, opts ...InvokeOption) LookupSchemaResultOutput

    > Note: This function is named LookupSchema in the Go SDK.

    public static class GetSchema 
{
    public static Task<GetSchemaResult> InvokeAsync(GetSchemaArgs args, InvokeOptions? opts = null)
    public static Output<GetSchemaResult> Invoke(GetSchemaInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetSchemaResult> getSchema(GetSchemaArgs args, InvokeOptions options)
public static Output<GetSchemaResult> getSchema(GetSchemaArgs args, InvokeOptions options)

    fn::invoke:
  function: redpanda:index/getSchema:getSchema
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ClusterId string
    The ID of the cluster where the schema is stored.
    Subject string
    The subject name for the schema.
    Version double
    The version of the schema. If not specified, the latest version is used.
    ClusterId string
    The ID of the cluster where the schema is stored.
    Subject string
    The subject name for the schema.
    Version float64
    The version of the schema. If not specified, the latest version is used.
    clusterId String
    The ID of the cluster where the schema is stored.
    subject String
    The subject name for the schema.
    version Double
    The version of the schema. If not specified, the latest version is used.
    clusterId string
    The ID of the cluster where the schema is stored.
    subject string
    The subject name for the schema.
    version number
    The version of the schema. If not specified, the latest version is used.
    cluster_id str
    The ID of the cluster where the schema is stored.
    subject str
    The subject name for the schema.
    version float
    The version of the schema. If not specified, the latest version is used.
    clusterId String
    The ID of the cluster where the schema is stored.
    subject String
    The subject name for the schema.
    version Number
    The version of the schema. If not specified, the latest version is used.

    getSchema Result

    The following output properties are available:

    ClusterId string
    The ID of the cluster where the schema is stored.
    Id double
    The unique identifier for the schema.
    References List<GetSchemaReference>
    List of schema references.
    Schema string
    The schema definition in JSON format.
    SchemaType string
    The type of schema (AVRO, JSON, PROTOBUF).
    Subject string
    The subject name for the schema.
    Version double
    The version of the schema. If not specified, the latest version is used.
    ClusterId string
    The ID of the cluster where the schema is stored.
    Id float64
    The unique identifier for the schema.
    References []GetSchemaReference
    List of schema references.
    Schema string
    The schema definition in JSON format.
    SchemaType string
    The type of schema (AVRO, JSON, PROTOBUF).
    Subject string
    The subject name for the schema.
    Version float64
    The version of the schema. If not specified, the latest version is used.
    clusterId String
    The ID of the cluster where the schema is stored.
    id Double
    The unique identifier for the schema.
    references List<GetSchemaReference>
    List of schema references.
    schema String
    The schema definition in JSON format.
    schemaType String
    The type of schema (AVRO, JSON, PROTOBUF).
    subject String
    The subject name for the schema.
    version Double
    The version of the schema. If not specified, the latest version is used.
    clusterId string
    The ID of the cluster where the schema is stored.
    id number
    The unique identifier for the schema.
    references GetSchemaReference[]
    List of schema references.
    schema string
    The schema definition in JSON format.
    schemaType string
    The type of schema (AVRO, JSON, PROTOBUF).
    subject string
    The subject name for the schema.
    version number
    The version of the schema. If not specified, the latest version is used.
    cluster_id str
    The ID of the cluster where the schema is stored.
    id float
    The unique identifier for the schema.
    references Sequence[GetSchemaReference]
    List of schema references.
    schema str
    The schema definition in JSON format.
    schema_type str
    The type of schema (AVRO, JSON, PROTOBUF).
    subject str
    The subject name for the schema.
    version float
    The version of the schema. If not specified, the latest version is used.
    clusterId String
    The ID of the cluster where the schema is stored.
    id Number
    The unique identifier for the schema.
    references List<Property Map>
    List of schema references.
    schema String
    The schema definition in JSON format.
    schemaType String
    The type of schema (AVRO, JSON, PROTOBUF).
    subject String
    The subject name for the schema.
    version Number
    The version of the schema. If not specified, the latest version is used.

    Supporting Types

    GetSchemaReference

    Name string
    The name of the referenced schema.
    Subject string
    The subject of the referenced schema.
    Version double
    The version of the referenced schema.
    Name string
    The name of the referenced schema.
    Subject string
    The subject of the referenced schema.
    Version float64
    The version of the referenced schema.
    name String
    The name of the referenced schema.
    subject String
    The subject of the referenced schema.
    version Double
    The version of the referenced schema.
    name string
    The name of the referenced schema.
    subject string
    The subject of the referenced schema.
    version number
    The version of the referenced schema.
    name str
    The name of the referenced schema.
    subject str
    The subject of the referenced schema.
    version float
    The version of the referenced schema.
    name String
    The name of the referenced schema.
    subject String
    The subject of the referenced schema.
    version Number
    The version of the referenced schema.

    Package Details

    Repository
    redpanda redpanda-data/terraform-provider-redpanda
    License
    Notes
    This Pulumi package is based on the redpanda Terraform Provider.
    redpanda logo
    redpanda 1.2.1 published on Wednesday, Sep 10, 2025 by redpanda-data
    redpanda-data/terraform-provider-redpanda