azure-native.hybridnetwork.ConfigurationGroupSchema
Explore with Pulumi AI
Configuration group schema resource.
Uses Azure REST API version 2024-04-15. In version 2.x of the Azure Native provider, it used API version 2023-09-01.
Other available API versions: 2023-09-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native hybridnetwork [ApiVersion]
. See the version guide for details.
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
This property is required. string - The unique name of the resource.
- args
This property is required. ConfigurationGroupSchemaArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
This property is required. str - The unique name of the resource.
- args
This property is required. 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
This property is required. string - The unique name of the resource.
- args
This property is required. ConfigurationGroupSchemaArgs - The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. ConfigurationGroupSchemaArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name
This property is required. String - The unique name of the resource.
- args
This property is required. 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",
"schema_definition": "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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The ConfigurationGroupSchema resource accepts the following input properties:
- Publisher
Name This property is required. Changes to this property will trigger replacement.
- The name of the publisher.
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- Configuration
Group Schema Name Changes to this property will trigger replacement.
- The name of the configuration group schema.
- Location
Changes to this property will trigger replacement.
- The geo-location where the resource lives
- Properties
Pulumi.
Azure Native. Hybrid Network. Inputs. Configuration Group Schema Properties Format - Configuration group schema properties.
- Dictionary<string, string>
- Resource tags.
- Publisher
Name This property is required. Changes to this property will trigger replacement.
- The name of the publisher.
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- Configuration
Group Schema Name Changes to this property will trigger replacement.
- The name of the configuration group schema.
- Location
Changes to this property will trigger replacement.
- The geo-location where the resource lives
- Properties
Configuration
Group Schema Properties Format Args - Configuration group schema properties.
- map[string]string
- Resource tags.
- publisher
Name This property is required. Changes to this property will trigger replacement.
- The name of the publisher.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- configuration
Group Schema Name Changes to this property will trigger replacement.
- The name of the configuration group schema.
- location
Changes to this property will trigger replacement.
- The geo-location where the resource lives
- properties
Configuration
Group Schema Properties Format - Configuration group schema properties.
- Map<String,String>
- Resource tags.
- publisher
Name This property is required. Changes to this property will trigger replacement.
- The name of the publisher.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- configuration
Group Schema Name Changes to this property will trigger replacement.
- The name of the configuration group schema.
- location
Changes to this property will trigger replacement.
- The geo-location where the resource lives
- properties
Configuration
Group Schema Properties Format - Configuration group schema properties.
- {[key: string]: string}
- Resource tags.
- publisher_
name This property is required. Changes to this property will trigger replacement.
- The name of the publisher.
- resource_
group_ name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- configuration_
group_ schema_ name Changes to this property will trigger replacement.
- The name of the configuration group schema.
- location
Changes to this property will trigger replacement.
- The geo-location where the resource lives
- properties
Configuration
Group Schema Properties Format Args - Configuration group schema properties.
- Mapping[str, str]
- Resource tags.
- publisher
Name This property is required. Changes to this property will trigger replacement.
- The name of the publisher.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- configuration
Group Schema Name Changes to this property will trigger replacement.
- The name of the configuration group schema.
- location
Changes to this property will trigger replacement.
- The geo-location where the resource lives
- properties Property Map
- Configuration group schema properties.
- Map<String>
- Resource tags.
Outputs
All input properties are implicitly available as output properties. Additionally, the ConfigurationGroupSchema resource produces the following output properties:
- Azure
Api stringVersion - The Azure API version of the resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The name of the resource
- System
Data Pulumi.Azure Native. Hybrid Network. Outputs. System Data Response - 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"
- Azure
Api stringVersion - The Azure API version of the resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The name of the resource
- System
Data SystemData Response - 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"
- azure
Api StringVersion - The Azure API version of the resource.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The name of the resource
- system
Data SystemData Response - 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"
- azure
Api stringVersion - The Azure API version of the resource.
- id string
- The provider-assigned unique ID for this managed resource.
- name string
- The name of the resource
- system
Data SystemData Response - 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"
- azure_
api_ strversion - The Azure API version of the resource.
- id str
- The provider-assigned unique ID for this managed resource.
- name str
- The name of the resource
- system_
data SystemData Response - 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"
- azure
Api StringVersion - The Azure API version of the resource.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The name of the resource
- system
Data 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.
- Schema
Definition 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.
- Schema
Definition 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.
- schema
Definition 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.
- schema
Definition 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.
- schema
Definition String - Name and value pairs that define the configuration value. It can be a well formed escaped JSON string.
ConfigurationGroupSchemaPropertiesFormatResponse, ConfigurationGroupSchemaPropertiesFormatResponseArgs
- Provisioning
State This property is required. string - The provisioning state of the Configuration group schema resource.
- Version
State This property is required. string - The configuration group schema version state.
- Description string
- Description of what schema can contain.
- Schema
Definition string - Name and value pairs that define the configuration value. It can be a well formed escaped JSON string.
- Provisioning
State This property is required. string - The provisioning state of the Configuration group schema resource.
- Version
State This property is required. string - The configuration group schema version state.
- Description string
- Description of what schema can contain.
- Schema
Definition string - Name and value pairs that define the configuration value. It can be a well formed escaped JSON string.
- provisioning
State This property is required. String - The provisioning state of the Configuration group schema resource.
- version
State This property is required. String - The configuration group schema version state.
- description String
- Description of what schema can contain.
- schema
Definition String - Name and value pairs that define the configuration value. It can be a well formed escaped JSON string.
- provisioning
State This property is required. string - The provisioning state of the Configuration group schema resource.
- version
State This property is required. string - The configuration group schema version state.
- description string
- Description of what schema can contain.
- schema
Definition string - Name and value pairs that define the configuration value. It can be a well formed escaped JSON string.
- provisioning_
state This property is required. str - The provisioning state of the Configuration group schema resource.
- version_
state This property is required. 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.
- provisioning
State This property is required. String - The provisioning state of the Configuration group schema resource.
- version
State This property is required. String - The configuration group schema version state.
- description String
- Description of what schema can contain.
- schema
Definition String - Name and value pairs that define the configuration value. It can be a well formed escaped JSON string.
SystemDataResponse, SystemDataResponseArgs
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified 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 timestamp of resource last modification (UTC)
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified 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: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