Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. azuresphere
  5. Catalog
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.azuresphere.Catalog

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

An Azure Sphere catalog

Uses Azure REST API version 2024-04-01. In version 2.x of the Azure Native provider, it used API version 2022-09-01-preview.

Other available API versions: 2022-09-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native azuresphere [ApiVersion]. See the version guide for details.

Example Usage

Catalogs_CreateOrUpdate

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var catalog = new AzureNative.AzureSphere.Catalog("catalog", new()
    {
        CatalogName = "MyCatalog1",
        Location = "global",
        ResourceGroupName = "MyResourceGroup1",
    });

});
Copy
package main

import (
	azuresphere "github.com/pulumi/pulumi-azure-native-sdk/azuresphere/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := azuresphere.NewCatalog(ctx, "catalog", &azuresphere.CatalogArgs{
			CatalogName:       pulumi.String("MyCatalog1"),
			Location:          pulumi.String("global"),
			ResourceGroupName: pulumi.String("MyResourceGroup1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.azuresphere.Catalog;
import com.pulumi.azurenative.azuresphere.CatalogArgs;
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 catalog = new Catalog("catalog", CatalogArgs.builder()
            .catalogName("MyCatalog1")
            .location("global")
            .resourceGroupName("MyResourceGroup1")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const catalog = new azure_native.azuresphere.Catalog("catalog", {
    catalogName: "MyCatalog1",
    location: "global",
    resourceGroupName: "MyResourceGroup1",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

catalog = azure_native.azuresphere.Catalog("catalog",
    catalog_name="MyCatalog1",
    location="global",
    resource_group_name="MyResourceGroup1")
Copy
resources:
  catalog:
    type: azure-native:azuresphere:Catalog
    properties:
      catalogName: MyCatalog1
      location: global
      resourceGroupName: MyResourceGroup1
Copy

Create Catalog Resource

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

Constructor syntax

new Catalog(name: string, args: CatalogArgs, opts?: CustomResourceOptions);
@overload
def Catalog(resource_name: str,
            args: CatalogArgs,
            opts: Optional[ResourceOptions] = None)

@overload
def Catalog(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            resource_group_name: Optional[str] = None,
            catalog_name: Optional[str] = None,
            location: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None)
func NewCatalog(ctx *Context, name string, args CatalogArgs, opts ...ResourceOption) (*Catalog, error)
public Catalog(string name, CatalogArgs args, CustomResourceOptions? opts = null)
public Catalog(String name, CatalogArgs args)
public Catalog(String name, CatalogArgs args, CustomResourceOptions options)

type: azure-native:azuresphere:Catalog
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. CatalogArgs
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. CatalogArgs
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. CatalogArgs
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. CatalogArgs
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. CatalogArgs
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 catalogResource = new AzureNative.AzureSphere.Catalog("catalogResource", new()
{
    ResourceGroupName = "string",
    CatalogName = "string",
    Location = "string",
    Tags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := azuresphere.NewCatalog(ctx, "catalogResource", &azuresphere.CatalogArgs{
	ResourceGroupName: pulumi.String("string"),
	CatalogName:       pulumi.String("string"),
	Location:          pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var catalogResource = new com.pulumi.azurenative.azuresphere.Catalog("catalogResource", com.pulumi.azurenative.azuresphere.CatalogArgs.builder()
    .resourceGroupName("string")
    .catalogName("string")
    .location("string")
    .tags(Map.of("string", "string"))
    .build());
Copy
catalog_resource = azure_native.azuresphere.Catalog("catalogResource",
    resource_group_name="string",
    catalog_name="string",
    location="string",
    tags={
        "string": "string",
    })
Copy
const catalogResource = new azure_native.azuresphere.Catalog("catalogResource", {
    resourceGroupName: "string",
    catalogName: "string",
    location: "string",
    tags: {
        string: "string",
    },
});
Copy
type: azure-native:azuresphere:Catalog
properties:
    catalogName: string
    location: string
    resourceGroupName: string
    tags:
        string: string
Copy

Catalog 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 Catalog resource accepts the following input properties:

ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
CatalogName Changes to this property will trigger replacement. string
Name of catalog
Location Changes to this property will trigger replacement. string
The geo-location where the resource lives
Tags Dictionary<string, string>
Resource tags.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
CatalogName Changes to this property will trigger replacement. string
Name of catalog
Location Changes to this property will trigger replacement. string
The geo-location where the resource lives
Tags map[string]string
Resource tags.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
catalogName Changes to this property will trigger replacement. String
Name of catalog
location Changes to this property will trigger replacement. String
The geo-location where the resource lives
tags Map<String,String>
Resource tags.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
catalogName Changes to this property will trigger replacement. string
Name of catalog
location Changes to this property will trigger replacement. string
The geo-location where the resource lives
tags {[key: string]: string}
Resource tags.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
catalog_name Changes to this property will trigger replacement. str
Name of catalog
location Changes to this property will trigger replacement. str
The geo-location where the resource lives
tags Mapping[str, str]
Resource tags.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
catalogName Changes to this property will trigger replacement. String
Name of catalog
location Changes to this property will trigger replacement. String
The geo-location where the resource lives
tags Map<String>
Resource tags.

Outputs

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

AzureApiVersion string
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
ProvisioningState string
The status of the last operation.
SystemData Pulumi.AzureNative.AzureSphere.Outputs.SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
TenantId string
The Azure Sphere tenant ID associated with the catalog.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
AzureApiVersion string
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
ProvisioningState string
The status of the last operation.
SystemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
TenantId string
The Azure Sphere tenant ID associated with the catalog.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azureApiVersion String
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
provisioningState String
The status of the last operation.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
tenantId String
The Azure Sphere tenant ID associated with the catalog.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azureApiVersion string
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
provisioningState string
The status of the last operation.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
tenantId string
The Azure Sphere tenant ID associated with the catalog.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azure_api_version str
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
provisioning_state str
The status of the last operation.
system_data SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
tenant_id str
The Azure Sphere tenant ID associated with the catalog.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azureApiVersion String
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
provisioningState String
The status of the last operation.
systemData Property Map
Azure Resource Manager metadata containing createdBy and modifiedBy information.
tenantId String
The Azure Sphere tenant ID associated with the catalog.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Supporting Types

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:azuresphere:Catalog MyCatalog1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}
Copy

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

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native