Microsoft.AzureSphere catalogs 2022-09-01-preview

• Latest
• 2024-04-01
• 2022-09-01-preview

Bicep resource definition

The catalogs resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.AzureSphere/catalogs resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.AzureSphere/catalogs@2022-09-01-preview' = {
  scope: resourceSymbolicName or scope
  location: 'string'
  name: 'string'
  properties: {}
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.AzureSphere/catalogs

Name	Description	Value
location	The geo-location where the resource lives	string (required)
name	The resource name	string Constraints: Pattern = ^[A-Za-z0-9_-]{1,50}$ (required)
properties	The resource-specific properties for this resource.	CatalogProperties
scope	Use when creating a resource at a scope that is different than the deployment scope.	Set this property to the symbolic name of a resource to apply the extension resource.
tags	Resource tags	Dictionary of tag names and values. See Tags in templates

CatalogProperties

Name	Description	Value

TrackedResourceTags

Name	Description	Value

ARM template resource definition

The catalogs resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.AzureSphere/catalogs resource, add the following JSON to your template.

{
  "type": "Microsoft.AzureSphere/catalogs",
  "apiVersion": "2022-09-01-preview",
  "name": "string",
  "location": "string",
  "properties": {
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.AzureSphere/catalogs

Name	Description	Value
apiVersion	The api version	'2022-09-01-preview'
location	The geo-location where the resource lives	string (required)
name	The resource name	string Constraints: Pattern = ^[A-Za-z0-9_-]{1,50}$ (required)
properties	The resource-specific properties for this resource.	CatalogProperties
tags	Resource tags	Dictionary of tag names and values. See Tags in templates
type	The resource type	'Microsoft.AzureSphere/catalogs'

CatalogProperties

Name	Description	Value

TrackedResourceTags

Name	Description	Value

Usage Examples

Terraform (AzAPI provider) resource definition

The catalogs resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.AzureSphere/catalogs resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.AzureSphere/catalogs@2022-09-01-preview"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
    }
  }
}

Property Values

Microsoft.AzureSphere/catalogs

Name	Description	Value
location	The geo-location where the resource lives	string (required)
name	The resource name	string Constraints: Pattern = ^[A-Za-z0-9_-]{1,50}$ (required)
parent_id	The ID of the resource to apply this extension resource to.	string (required)
properties	The resource-specific properties for this resource.	CatalogProperties
tags	Resource tags	Dictionary of tag names and values.
type	The resource type	"Microsoft.AzureSphere/catalogs@2022-09-01-preview"

CatalogProperties

Name	Description	Value

TrackedResourceTags

Name	Description	Value