azure-native.eventhub.SchemaRegistry
Explore with Pulumi AI
Single item in List or Get Schema Group operation Azure REST API version: 2022-10-01-preview. Prior API version in Azure Native 1.x: 2022-01-01-preview.
Other available API versions: 2023-01-01-preview, 2024-01-01, 2024-05-01-preview.
Example Usage
SchemaRegistryCreate
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() => 
{
    var schemaRegistry = new AzureNative.EventHub.SchemaRegistry("schemaRegistry", new()
    {
        GroupProperties = null,
        NamespaceName = "ali-ua-test-eh-system-1",
        ResourceGroupName = "alitest",
        SchemaCompatibility = AzureNative.EventHub.SchemaCompatibility.Forward,
        SchemaGroupName = "testSchemaGroup1",
        SchemaType = AzureNative.EventHub.SchemaType.Avro,
    });
});
package main
import (
	eventhub "github.com/pulumi/pulumi-azure-native-sdk/eventhub/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := eventhub.NewSchemaRegistry(ctx, "schemaRegistry", &eventhub.SchemaRegistryArgs{
			GroupProperties:     pulumi.StringMap{},
			NamespaceName:       pulumi.String("ali-ua-test-eh-system-1"),
			ResourceGroupName:   pulumi.String("alitest"),
			SchemaCompatibility: pulumi.String(eventhub.SchemaCompatibilityForward),
			SchemaGroupName:     pulumi.String("testSchemaGroup1"),
			SchemaType:          pulumi.String(eventhub.SchemaTypeAvro),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.eventhub.SchemaRegistry;
import com.pulumi.azurenative.eventhub.SchemaRegistryArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var schemaRegistry = new SchemaRegistry("schemaRegistry", SchemaRegistryArgs.builder()
            .groupProperties()
            .namespaceName("ali-ua-test-eh-system-1")
            .resourceGroupName("alitest")
            .schemaCompatibility("Forward")
            .schemaGroupName("testSchemaGroup1")
            .schemaType("Avro")
            .build());
    }
}
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const schemaRegistry = new azure_native.eventhub.SchemaRegistry("schemaRegistry", {
    groupProperties: {},
    namespaceName: "ali-ua-test-eh-system-1",
    resourceGroupName: "alitest",
    schemaCompatibility: azure_native.eventhub.SchemaCompatibility.Forward,
    schemaGroupName: "testSchemaGroup1",
    schemaType: azure_native.eventhub.SchemaType.Avro,
});
import pulumi
import pulumi_azure_native as azure_native
schema_registry = azure_native.eventhub.SchemaRegistry("schemaRegistry",
    group_properties={},
    namespace_name="ali-ua-test-eh-system-1",
    resource_group_name="alitest",
    schema_compatibility=azure_native.eventhub.SchemaCompatibility.FORWARD,
    schema_group_name="testSchemaGroup1",
    schema_type=azure_native.eventhub.SchemaType.AVRO)
resources:
  schemaRegistry:
    type: azure-native:eventhub:SchemaRegistry
    properties:
      groupProperties: {}
      namespaceName: ali-ua-test-eh-system-1
      resourceGroupName: alitest
      schemaCompatibility: Forward
      schemaGroupName: testSchemaGroup1
      schemaType: Avro
Create SchemaRegistry Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new SchemaRegistry(name: string, args: SchemaRegistryArgs, opts?: CustomResourceOptions);@overload
def SchemaRegistry(resource_name: str,
                   args: SchemaRegistryArgs,
                   opts: Optional[ResourceOptions] = None)
@overload
def SchemaRegistry(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   namespace_name: Optional[str] = None,
                   resource_group_name: Optional[str] = None,
                   group_properties: Optional[Mapping[str, str]] = None,
                   schema_compatibility: Optional[Union[str, SchemaCompatibility]] = None,
                   schema_group_name: Optional[str] = None,
                   schema_type: Optional[Union[str, SchemaType]] = None)func NewSchemaRegistry(ctx *Context, name string, args SchemaRegistryArgs, opts ...ResourceOption) (*SchemaRegistry, error)public SchemaRegistry(string name, SchemaRegistryArgs args, CustomResourceOptions? opts = null)
public SchemaRegistry(String name, SchemaRegistryArgs args)
public SchemaRegistry(String name, SchemaRegistryArgs args, CustomResourceOptions options)
type: azure-native:eventhub:SchemaRegistry
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args SchemaRegistryArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args SchemaRegistryArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args SchemaRegistryArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args SchemaRegistryArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args SchemaRegistryArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var azure_nativeSchemaRegistryResource = new AzureNative.EventHub.SchemaRegistry("azure-nativeSchemaRegistryResource", new()
{
    NamespaceName = "string",
    ResourceGroupName = "string",
    GroupProperties = 
    {
        { "string", "string" },
    },
    SchemaCompatibility = "string",
    SchemaGroupName = "string",
    SchemaType = "string",
});
example, err := eventhub.NewSchemaRegistry(ctx, "azure-nativeSchemaRegistryResource", &eventhub.SchemaRegistryArgs{
	NamespaceName:     pulumi.String("string"),
	ResourceGroupName: pulumi.String("string"),
	GroupProperties: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	SchemaCompatibility: pulumi.String("string"),
	SchemaGroupName:     pulumi.String("string"),
	SchemaType:          pulumi.String("string"),
})
var azure_nativeSchemaRegistryResource = new SchemaRegistry("azure-nativeSchemaRegistryResource", SchemaRegistryArgs.builder()
    .namespaceName("string")
    .resourceGroupName("string")
    .groupProperties(Map.of("string", "string"))
    .schemaCompatibility("string")
    .schemaGroupName("string")
    .schemaType("string")
    .build());
azure_native_schema_registry_resource = azure_native.eventhub.SchemaRegistry("azure-nativeSchemaRegistryResource",
    namespace_name="string",
    resource_group_name="string",
    group_properties={
        "string": "string",
    },
    schema_compatibility="string",
    schema_group_name="string",
    schema_type="string")
const azure_nativeSchemaRegistryResource = new azure_native.eventhub.SchemaRegistry("azure-nativeSchemaRegistryResource", {
    namespaceName: "string",
    resourceGroupName: "string",
    groupProperties: {
        string: "string",
    },
    schemaCompatibility: "string",
    schemaGroupName: "string",
    schemaType: "string",
});
type: azure-native:eventhub:SchemaRegistry
properties:
    groupProperties:
        string: string
    namespaceName: string
    resourceGroupName: string
    schemaCompatibility: string
    schemaGroupName: string
    schemaType: string
SchemaRegistry Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The SchemaRegistry resource accepts the following input properties:
- NamespaceName string
- The Namespace name
- ResourceGroup stringName 
- Name of the resource group within the azure subscription.
- GroupProperties Dictionary<string, string>
- dictionary object for SchemaGroup group properties
- SchemaCompatibility string | Pulumi.Azure Native. Event Hub. Schema Compatibility 
- SchemaGroup stringName 
- The Schema Group name
- SchemaType string | Pulumi.Azure Native. Event Hub. Schema Type 
- NamespaceName string
- The Namespace name
- ResourceGroup stringName 
- Name of the resource group within the azure subscription.
- GroupProperties map[string]string
- dictionary object for SchemaGroup group properties
- SchemaCompatibility string | SchemaCompatibility 
- SchemaGroup stringName 
- The Schema Group name
- SchemaType string | SchemaType 
- namespaceName String
- The Namespace name
- resourceGroup StringName 
- Name of the resource group within the azure subscription.
- groupProperties Map<String,String>
- dictionary object for SchemaGroup group properties
- schemaCompatibility String | SchemaCompatibility 
- schemaGroup StringName 
- The Schema Group name
- schemaType String | SchemaType 
- namespaceName string
- The Namespace name
- resourceGroup stringName 
- Name of the resource group within the azure subscription.
- groupProperties {[key: string]: string}
- dictionary object for SchemaGroup group properties
- schemaCompatibility string | SchemaCompatibility 
- schemaGroup stringName 
- The Schema Group name
- schemaType string | SchemaType 
- namespace_name str
- The Namespace name
- resource_group_ strname 
- Name of the resource group within the azure subscription.
- group_properties Mapping[str, str]
- dictionary object for SchemaGroup group properties
- schema_compatibility str | SchemaCompatibility 
- schema_group_ strname 
- The Schema Group name
- schema_type str | SchemaType 
- namespaceName String
- The Namespace name
- resourceGroup StringName 
- Name of the resource group within the azure subscription.
- groupProperties Map<String>
- dictionary object for SchemaGroup group properties
- schemaCompatibility String | "None" | "Backward" | "Forward"
- schemaGroup StringName 
- The Schema Group name
- schemaType String | "Unknown" | "Avro"
Outputs
All input properties are implicitly available as output properties. Additionally, the SchemaRegistry resource produces the following output properties:
- CreatedAt stringUtc 
- Exact time the Schema Group was created.
- ETag string
- The ETag value.
- Id string
- The provider-assigned unique ID for this managed resource.
- Location string
- The geo-location where the resource lives
- Name string
- The name of the resource
- SystemData Pulumi.Azure Native. Event Hub. Outputs. System Data Response 
- The system meta data relating to this resource.
- Type string
- The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
- UpdatedAt stringUtc 
- Exact time the Schema Group was updated
- CreatedAt stringUtc 
- Exact time the Schema Group was created.
- ETag string
- The ETag value.
- Id string
- The provider-assigned unique ID for this managed resource.
- Location string
- The geo-location where the resource lives
- Name string
- The name of the resource
- SystemData SystemData Response 
- The system meta data relating to this resource.
- Type string
- The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
- UpdatedAt stringUtc 
- Exact time the Schema Group was updated
- createdAt StringUtc 
- Exact time the Schema Group was created.
- eTag String
- The ETag value.
- id String
- The provider-assigned unique ID for this managed resource.
- location String
- The geo-location where the resource lives
- name String
- The name of the resource
- systemData SystemData Response 
- The system meta data relating to this resource.
- type String
- The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
- updatedAt StringUtc 
- Exact time the Schema Group was updated
- createdAt stringUtc 
- Exact time the Schema Group was created.
- eTag string
- The ETag value.
- id string
- The provider-assigned unique ID for this managed resource.
- location string
- The geo-location where the resource lives
- name string
- The name of the resource
- systemData SystemData Response 
- The system meta data relating to this resource.
- type string
- The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
- updatedAt stringUtc 
- Exact time the Schema Group was updated
- created_at_ strutc 
- Exact time the Schema Group was created.
- e_tag str
- The ETag value.
- id str
- The provider-assigned unique ID for this managed resource.
- location str
- The geo-location where the resource lives
- name str
- The name of the resource
- system_data SystemData Response 
- The system meta data relating to this resource.
- type str
- The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
- updated_at_ strutc 
- Exact time the Schema Group was updated
- createdAt StringUtc 
- Exact time the Schema Group was created.
- eTag String
- The ETag value.
- id String
- The provider-assigned unique ID for this managed resource.
- location String
- The geo-location where the resource lives
- name String
- The name of the resource
- systemData Property Map
- The system meta data relating to this resource.
- type String
- The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
- updatedAt StringUtc 
- Exact time the Schema Group was updated
Supporting Types
SchemaCompatibility, SchemaCompatibilityArgs    
- None
- None
- Backward
- Backward
- Forward
- Forward
- SchemaCompatibility None 
- None
- SchemaCompatibility Backward 
- Backward
- SchemaCompatibility Forward 
- Forward
- None
- None
- Backward
- Backward
- Forward
- Forward
- None
- None
- Backward
- Backward
- Forward
- Forward
- NONE
- None
- BACKWARD
- Backward
- FORWARD
- Forward
- "None"
- None
- "Backward"
- Backward
- "Forward"
- Forward
SchemaType, SchemaTypeArgs    
- Unknown
- Unknown
- Avro
- Avro
- SchemaType Unknown 
- Unknown
- SchemaType Avro 
- Avro
- Unknown
- Unknown
- Avro
- Avro
- Unknown
- Unknown
- Avro
- Avro
- UNKNOWN
- Unknown
- AVRO
- Avro
- "Unknown"
- Unknown
- "Avro"
- Avro
SystemDataResponse, SystemDataResponseArgs      
- CreatedAt string
- The timestamp of resource creation (UTC).
- CreatedBy string
- The identity that created the resource.
- CreatedBy stringType 
- The type of identity that created the resource.
- LastModified stringAt 
- The type of identity that last modified the resource.
- LastModified stringBy 
- The identity that last modified the resource.
- LastModified stringBy Type 
- The type of identity that last modified the resource.
- CreatedAt string
- The timestamp of resource creation (UTC).
- CreatedBy string
- The identity that created the resource.
- CreatedBy stringType 
- The type of identity that created the resource.
- LastModified stringAt 
- The type of identity that last modified the resource.
- LastModified stringBy 
- The identity that last modified the resource.
- LastModified stringBy Type 
- The type of identity that last modified the resource.
- createdAt String
- The timestamp of resource creation (UTC).
- createdBy String
- The identity that created the resource.
- createdBy StringType 
- The type of identity that created the resource.
- lastModified StringAt 
- The type of identity that last modified the resource.
- lastModified StringBy 
- The identity that last modified the resource.
- lastModified StringBy Type 
- The type of identity that last modified the resource.
- createdAt string
- The timestamp of resource creation (UTC).
- createdBy string
- The identity that created the resource.
- createdBy stringType 
- The type of identity that created the resource.
- lastModified stringAt 
- The type of identity that last modified the resource.
- lastModified stringBy 
- The identity that last modified the resource.
- lastModified stringBy Type 
- The type of identity that last modified the resource.
- created_at str
- The timestamp of resource creation (UTC).
- created_by str
- The identity that created the resource.
- created_by_ strtype 
- The type of identity that created the resource.
- last_modified_ strat 
- The type of identity that last modified the resource.
- last_modified_ strby 
- The identity that last modified the resource.
- last_modified_ strby_ type 
- The type of identity that last modified the resource.
- createdAt String
- The timestamp of resource creation (UTC).
- createdBy String
- The identity that created the resource.
- createdBy StringType 
- The type of identity that created the resource.
- lastModified StringAt 
- The type of identity that last modified the resource.
- lastModified StringBy 
- The identity that last modified the resource.
- lastModified StringBy Type 
- The type of identity that last modified the resource.
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:eventhub:SchemaRegistry testSchemaGroup1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/schemagroups/{schemaGroupName} 
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0