1. Packages
  2. Azure Native
  3. API Docs
  4. hybridnetwork
  5. ConfigurationGroupSchema
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.49.1 published on Tuesday, Jul 9, 2024 by Pulumi

azure-native.hybridnetwork.ConfigurationGroupSchema

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.49.1 published on Tuesday, Jul 9, 2024 by Pulumi

    Configuration group schema resource. Azure REST API version: 2023-09-01.

    Example Usage

    Create or update the network function definition group

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var configurationGroupSchema = new AzureNative.HybridNetwork.ConfigurationGroupSchema("configurationGroupSchema", new()
        {
            ConfigurationGroupSchemaName = "testConfigurationGroupSchema",
            Location = "westUs2",
            Properties = new AzureNative.HybridNetwork.Inputs.ConfigurationGroupSchemaPropertiesFormatArgs
            {
                Description = "Schema with no secrets",
                SchemaDefinition = "{\"type\":\"object\",\"properties\":{\"interconnect-groups\":{\"type\":\"object\",\"properties\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\"},\"international-interconnects\":{\"type\":\"array\",\"item\":{\"type\":\"string\"}},\"domestic-interconnects\":{\"type\":\"array\",\"item\":{\"type\":\"string\"}}}}},\"interconnect-group-assignments\":{\"type\":\"object\",\"properties\":{\"type\":\"object\",\"properties\":{\"ssc\":{\"type\":\"string\"},\"interconnects-interconnects\":{\"type\":\"string\"}}}}},\"required\":[\"interconnect-groups\",\"interconnect-group-assignments\"]}",
            },
            PublisherName = "testPublisher",
            ResourceGroupName = "rg1",
        });
    
    });
    
    package main
    
    import (
    	hybridnetwork "github.com/pulumi/pulumi-azure-native-sdk/hybridnetwork/v2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := hybridnetwork.NewConfigurationGroupSchema(ctx, "configurationGroupSchema", &hybridnetwork.ConfigurationGroupSchemaArgs{
    			ConfigurationGroupSchemaName: pulumi.String("testConfigurationGroupSchema"),
    			Location:                     pulumi.String("westUs2"),
    			Properties: &hybridnetwork.ConfigurationGroupSchemaPropertiesFormatArgs{
    				Description:      pulumi.String("Schema with no secrets"),
    				SchemaDefinition: pulumi.String("{\"type\":\"object\",\"properties\":{\"interconnect-groups\":{\"type\":\"object\",\"properties\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\"},\"international-interconnects\":{\"type\":\"array\",\"item\":{\"type\":\"string\"}},\"domestic-interconnects\":{\"type\":\"array\",\"item\":{\"type\":\"string\"}}}}},\"interconnect-group-assignments\":{\"type\":\"object\",\"properties\":{\"type\":\"object\",\"properties\":{\"ssc\":{\"type\":\"string\"},\"interconnects-interconnects\":{\"type\":\"string\"}}}}},\"required\":[\"interconnect-groups\",\"interconnect-group-assignments\"]}"),
    			},
    			PublisherName:     pulumi.String("testPublisher"),
    			ResourceGroupName: pulumi.String("rg1"),
    		})
    		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.hybridnetwork.ConfigurationGroupSchema;
    import com.pulumi.azurenative.hybridnetwork.ConfigurationGroupSchemaArgs;
    import com.pulumi.azurenative.hybridnetwork.inputs.ConfigurationGroupSchemaPropertiesFormatArgs;
    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 configurationGroupSchema = new ConfigurationGroupSchema("configurationGroupSchema", ConfigurationGroupSchemaArgs.builder()
                .configurationGroupSchemaName("testConfigurationGroupSchema")
                .location("westUs2")
                .properties(ConfigurationGroupSchemaPropertiesFormatArgs.builder()
                    .description("Schema with no secrets")
                    .schemaDefinition("{\"type\":\"object\",\"properties\":{\"interconnect-groups\":{\"type\":\"object\",\"properties\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\"},\"international-interconnects\":{\"type\":\"array\",\"item\":{\"type\":\"string\"}},\"domestic-interconnects\":{\"type\":\"array\",\"item\":{\"type\":\"string\"}}}}},\"interconnect-group-assignments\":{\"type\":\"object\",\"properties\":{\"type\":\"object\",\"properties\":{\"ssc\":{\"type\":\"string\"},\"interconnects-interconnects\":{\"type\":\"string\"}}}}},\"required\":[\"interconnect-groups\",\"interconnect-group-assignments\"]}")
                    .build())
                .publisherName("testPublisher")
                .resourceGroupName("rg1")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    configuration_group_schema = azure_native.hybridnetwork.ConfigurationGroupSchema("configurationGroupSchema",
        configuration_group_schema_name="testConfigurationGroupSchema",
        location="westUs2",
        properties={
            "description": "Schema with no secrets",
            "schemaDefinition": "{\"type\":\"object\",\"properties\":{\"interconnect-groups\":{\"type\":\"object\",\"properties\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\"},\"international-interconnects\":{\"type\":\"array\",\"item\":{\"type\":\"string\"}},\"domestic-interconnects\":{\"type\":\"array\",\"item\":{\"type\":\"string\"}}}}},\"interconnect-group-assignments\":{\"type\":\"object\",\"properties\":{\"type\":\"object\",\"properties\":{\"ssc\":{\"type\":\"string\"},\"interconnects-interconnects\":{\"type\":\"string\"}}}}},\"required\":[\"interconnect-groups\",\"interconnect-group-assignments\"]}",
        },
        publisher_name="testPublisher",
        resource_group_name="rg1")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const configurationGroupSchema = new azure_native.hybridnetwork.ConfigurationGroupSchema("configurationGroupSchema", {
        configurationGroupSchemaName: "testConfigurationGroupSchema",
        location: "westUs2",
        properties: {
            description: "Schema with no secrets",
            schemaDefinition: "{\"type\":\"object\",\"properties\":{\"interconnect-groups\":{\"type\":\"object\",\"properties\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\"},\"international-interconnects\":{\"type\":\"array\",\"item\":{\"type\":\"string\"}},\"domestic-interconnects\":{\"type\":\"array\",\"item\":{\"type\":\"string\"}}}}},\"interconnect-group-assignments\":{\"type\":\"object\",\"properties\":{\"type\":\"object\",\"properties\":{\"ssc\":{\"type\":\"string\"},\"interconnects-interconnects\":{\"type\":\"string\"}}}}},\"required\":[\"interconnect-groups\",\"interconnect-group-assignments\"]}",
        },
        publisherName: "testPublisher",
        resourceGroupName: "rg1",
    });
    
    resources:
      configurationGroupSchema:
        type: azure-native:hybridnetwork:ConfigurationGroupSchema
        properties:
          configurationGroupSchemaName: testConfigurationGroupSchema
          location: westUs2
          properties:
            description: Schema with no secrets
            schemaDefinition: '{"type":"object","properties":{"interconnect-groups":{"type":"object","properties":{"type":"object","properties":{"name":{"type":"string"},"international-interconnects":{"type":"array","item":{"type":"string"}},"domestic-interconnects":{"type":"array","item":{"type":"string"}}}}},"interconnect-group-assignments":{"type":"object","properties":{"type":"object","properties":{"ssc":{"type":"string"},"interconnects-interconnects":{"type":"string"}}}}},"required":["interconnect-groups","interconnect-group-assignments"]}'
          publisherName: testPublisher
          resourceGroupName: rg1
    

    Create ConfigurationGroupSchema Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ConfigurationGroupSchema(name: string, args: ConfigurationGroupSchemaArgs, opts?: CustomResourceOptions);
    @overload
    def ConfigurationGroupSchema(resource_name: str,
                                 args: ConfigurationGroupSchemaArgs,
                                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def ConfigurationGroupSchema(resource_name: str,
                                 opts: Optional[ResourceOptions] = None,
                                 publisher_name: Optional[str] = None,
                                 resource_group_name: Optional[str] = None,
                                 configuration_group_schema_name: Optional[str] = None,
                                 location: Optional[str] = None,
                                 properties: Optional[ConfigurationGroupSchemaPropertiesFormatArgs] = None,
                                 tags: Optional[Mapping[str, str]] = None)
    func NewConfigurationGroupSchema(ctx *Context, name string, args ConfigurationGroupSchemaArgs, opts ...ResourceOption) (*ConfigurationGroupSchema, error)
    public ConfigurationGroupSchema(string name, ConfigurationGroupSchemaArgs args, CustomResourceOptions? opts = null)
    public ConfigurationGroupSchema(String name, ConfigurationGroupSchemaArgs args)
    public ConfigurationGroupSchema(String name, ConfigurationGroupSchemaArgs args, CustomResourceOptions options)
    
    type: azure-native:hybridnetwork:ConfigurationGroupSchema
    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 ConfigurationGroupSchemaArgs
    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 ConfigurationGroupSchemaArgs
    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 ConfigurationGroupSchemaArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ConfigurationGroupSchemaArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ConfigurationGroupSchemaArgs
    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 configurationGroupSchemaResource = new AzureNative.HybridNetwork.ConfigurationGroupSchema("configurationGroupSchemaResource", new()
    {
        PublisherName = "string",
        ResourceGroupName = "string",
        ConfigurationGroupSchemaName = "string",
        Location = "string",
        Properties = new AzureNative.HybridNetwork.Inputs.ConfigurationGroupSchemaPropertiesFormatArgs
        {
            Description = "string",
            SchemaDefinition = "string",
        },
        Tags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := hybridnetwork.NewConfigurationGroupSchema(ctx, "configurationGroupSchemaResource", &hybridnetwork.ConfigurationGroupSchemaArgs{
    PublisherName: pulumi.String("string"),
    ResourceGroupName: pulumi.String("string"),
    ConfigurationGroupSchemaName: pulumi.String("string"),
    Location: pulumi.String("string"),
    Properties: &hybridnetwork.ConfigurationGroupSchemaPropertiesFormatArgs{
    Description: pulumi.String("string"),
    SchemaDefinition: pulumi.String("string"),
    },
    Tags: pulumi.StringMap{
    "string": pulumi.String("string"),
    },
    })
    
    var configurationGroupSchemaResource = new ConfigurationGroupSchema("configurationGroupSchemaResource", ConfigurationGroupSchemaArgs.builder()
        .publisherName("string")
        .resourceGroupName("string")
        .configurationGroupSchemaName("string")
        .location("string")
        .properties(ConfigurationGroupSchemaPropertiesFormatArgs.builder()
            .description("string")
            .schemaDefinition("string")
            .build())
        .tags(Map.of("string", "string"))
        .build());
    
    configuration_group_schema_resource = azure_native.hybridnetwork.ConfigurationGroupSchema("configurationGroupSchemaResource",
        publisher_name="string",
        resource_group_name="string",
        configuration_group_schema_name="string",
        location="string",
        properties={
            "description": "string",
            "schemaDefinition": "string",
        },
        tags={
            "string": "string",
        })
    
    const configurationGroupSchemaResource = new azure_native.hybridnetwork.ConfigurationGroupSchema("configurationGroupSchemaResource", {
        publisherName: "string",
        resourceGroupName: "string",
        configurationGroupSchemaName: "string",
        location: "string",
        properties: {
            description: "string",
            schemaDefinition: "string",
        },
        tags: {
            string: "string",
        },
    });
    
    type: azure-native:hybridnetwork:ConfigurationGroupSchema
    properties:
        configurationGroupSchemaName: string
        location: string
        properties:
            description: string
            schemaDefinition: string
        publisherName: string
        resourceGroupName: string
        tags:
            string: string
    

    ConfigurationGroupSchema Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The ConfigurationGroupSchema resource accepts the following input properties:

    PublisherName string
    The name of the publisher.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ConfigurationGroupSchemaName string
    The name of the configuration group schema.
    Location string
    The geo-location where the resource lives
    Properties Pulumi.AzureNative.HybridNetwork.Inputs.ConfigurationGroupSchemaPropertiesFormat
    Configuration group schema properties.
    Tags Dictionary<string, string>
    Resource tags.
    PublisherName string
    The name of the publisher.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ConfigurationGroupSchemaName string
    The name of the configuration group schema.
    Location string
    The geo-location where the resource lives
    Properties ConfigurationGroupSchemaPropertiesFormatArgs
    Configuration group schema properties.
    Tags map[string]string
    Resource tags.
    publisherName String
    The name of the publisher.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    configurationGroupSchemaName String
    The name of the configuration group schema.
    location String
    The geo-location where the resource lives
    properties ConfigurationGroupSchemaPropertiesFormat
    Configuration group schema properties.
    tags Map<String,String>
    Resource tags.
    publisherName string
    The name of the publisher.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    configurationGroupSchemaName string
    The name of the configuration group schema.
    location string
    The geo-location where the resource lives
    properties ConfigurationGroupSchemaPropertiesFormat
    Configuration group schema properties.
    tags {[key: string]: string}
    Resource tags.
    publisher_name str
    The name of the publisher.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    configuration_group_schema_name str
    The name of the configuration group schema.
    location str
    The geo-location where the resource lives
    properties ConfigurationGroupSchemaPropertiesFormatArgs
    Configuration group schema properties.
    tags Mapping[str, str]
    Resource tags.
    publisherName String
    The name of the publisher.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    configurationGroupSchemaName String
    The name of the configuration group schema.
    location String
    The geo-location where the resource lives
    properties Property Map
    Configuration group schema properties.
    tags Map<String>
    Resource tags.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ConfigurationGroupSchema resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    SystemData Pulumi.AzureNative.HybridNetwork.Outputs.SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    SystemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The name of the resource
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The name of the resource
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    systemData Property Map
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    Supporting Types

    ConfigurationGroupSchemaPropertiesFormat, ConfigurationGroupSchemaPropertiesFormatArgs

    Description string
    Description of what schema can contain.
    SchemaDefinition string
    Name and value pairs that define the configuration value. It can be a well formed escaped JSON string.
    Description string
    Description of what schema can contain.
    SchemaDefinition string
    Name and value pairs that define the configuration value. It can be a well formed escaped JSON string.
    description String
    Description of what schema can contain.
    schemaDefinition String
    Name and value pairs that define the configuration value. It can be a well formed escaped JSON string.
    description string
    Description of what schema can contain.
    schemaDefinition string
    Name and value pairs that define the configuration value. It can be a well formed escaped JSON string.
    description str
    Description of what schema can contain.
    schema_definition str
    Name and value pairs that define the configuration value. It can be a well formed escaped JSON string.
    description String
    Description of what schema can contain.
    schemaDefinition String
    Name and value pairs that define the configuration value. It can be a well formed escaped JSON string.

    ConfigurationGroupSchemaPropertiesFormatResponse, ConfigurationGroupSchemaPropertiesFormatResponseArgs

    ProvisioningState string
    The provisioning state of the Configuration group schema resource.
    VersionState string
    The configuration group schema version state.
    Description string
    Description of what schema can contain.
    SchemaDefinition string
    Name and value pairs that define the configuration value. It can be a well formed escaped JSON string.
    ProvisioningState string
    The provisioning state of the Configuration group schema resource.
    VersionState string
    The configuration group schema version state.
    Description string
    Description of what schema can contain.
    SchemaDefinition string
    Name and value pairs that define the configuration value. It can be a well formed escaped JSON string.
    provisioningState String
    The provisioning state of the Configuration group schema resource.
    versionState String
    The configuration group schema version state.
    description String
    Description of what schema can contain.
    schemaDefinition String
    Name and value pairs that define the configuration value. It can be a well formed escaped JSON string.
    provisioningState string
    The provisioning state of the Configuration group schema resource.
    versionState string
    The configuration group schema version state.
    description string
    Description of what schema can contain.
    schemaDefinition string
    Name and value pairs that define the configuration value. It can be a well formed escaped JSON string.
    provisioning_state str
    The provisioning state of the Configuration group schema resource.
    version_state str
    The configuration group schema version state.
    description str
    Description of what schema can contain.
    schema_definition str
    Name and value pairs that define the configuration value. It can be a well formed escaped JSON string.
    provisioningState String
    The provisioning state of the Configuration group schema resource.
    versionState String
    The configuration group schema version state.
    description String
    Description of what schema can contain.
    schemaDefinition String
    Name and value pairs that define the configuration value. It can be a well formed escaped JSON string.

    SystemDataResponse, SystemDataResponseArgs

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    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.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    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.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    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.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    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_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    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.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    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:hybridnetwork:ConfigurationGroupSchema testConfigurationGroupSchema /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridNetwork/publishers/{publisherName}/configurationGroupSchemas/{configurationGroupSchemaName} 
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.49.1 published on Tuesday, Jul 9, 2024 by Pulumi