We recommend using Azure Native.
azure.devcenter.Catalog
Explore with Pulumi AI
Manages a Dev Center Catalog.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const example = new azure.core.ResourceGroup("example", {
name: "example-resources",
location: "West Europe",
});
const exampleDevCenter = new azure.devcenter.DevCenter("example", {
location: example.location,
name: "example",
resourceGroupName: example.name,
identity: {
type: "SystemAssigned",
},
});
const exampleCatalog = new azure.devcenter.Catalog("example", {
name: "example",
resourceGroupName: testAzurermResourceGroup.name,
devCenterId: test.id,
catalogGithub: {
branch: "foo",
path: "",
uri: "example URI",
keyVaultKeyUrl: "secret",
},
});
import pulumi
import pulumi_azure as azure
example = azure.core.ResourceGroup("example",
name="example-resources",
location="West Europe")
example_dev_center = azure.devcenter.DevCenter("example",
location=example.location,
name="example",
resource_group_name=example.name,
identity={
"type": "SystemAssigned",
})
example_catalog = azure.devcenter.Catalog("example",
name="example",
resource_group_name=test_azurerm_resource_group["name"],
dev_center_id=test["id"],
catalog_github={
"branch": "foo",
"path": "",
"uri": "example URI",
"key_vault_key_url": "secret",
})
package main
import (
"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/devcenter"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
Name: pulumi.String("example-resources"),
Location: pulumi.String("West Europe"),
})
if err != nil {
return err
}
_, err = devcenter.NewDevCenter(ctx, "example", &devcenter.DevCenterArgs{
Location: example.Location,
Name: pulumi.String("example"),
ResourceGroupName: example.Name,
Identity: &devcenter.DevCenterIdentityArgs{
Type: pulumi.String("SystemAssigned"),
},
})
if err != nil {
return err
}
_, err = devcenter.NewCatalog(ctx, "example", &devcenter.CatalogArgs{
Name: pulumi.String("example"),
ResourceGroupName: pulumi.Any(testAzurermResourceGroup.Name),
DevCenterId: pulumi.Any(test.Id),
CatalogGithub: &devcenter.CatalogCatalogGithubArgs{
Branch: pulumi.String("foo"),
Path: pulumi.String(""),
Uri: pulumi.String("example URI"),
KeyVaultKeyUrl: pulumi.String("secret"),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() =>
{
var example = new Azure.Core.ResourceGroup("example", new()
{
Name = "example-resources",
Location = "West Europe",
});
var exampleDevCenter = new Azure.DevCenter.DevCenter("example", new()
{
Location = example.Location,
Name = "example",
ResourceGroupName = example.Name,
Identity = new Azure.DevCenter.Inputs.DevCenterIdentityArgs
{
Type = "SystemAssigned",
},
});
var exampleCatalog = new Azure.DevCenter.Catalog("example", new()
{
Name = "example",
ResourceGroupName = testAzurermResourceGroup.Name,
DevCenterId = test.Id,
CatalogGithub = new Azure.DevCenter.Inputs.CatalogCatalogGithubArgs
{
Branch = "foo",
Path = "",
Uri = "example URI",
KeyVaultKeyUrl = "secret",
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.devcenter.DevCenter;
import com.pulumi.azure.devcenter.DevCenterArgs;
import com.pulumi.azure.devcenter.inputs.DevCenterIdentityArgs;
import com.pulumi.azure.devcenter.Catalog;
import com.pulumi.azure.devcenter.CatalogArgs;
import com.pulumi.azure.devcenter.inputs.CatalogCatalogGithubArgs;
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 example = new ResourceGroup("example", ResourceGroupArgs.builder()
.name("example-resources")
.location("West Europe")
.build());
var exampleDevCenter = new DevCenter("exampleDevCenter", DevCenterArgs.builder()
.location(example.location())
.name("example")
.resourceGroupName(example.name())
.identity(DevCenterIdentityArgs.builder()
.type("SystemAssigned")
.build())
.build());
var exampleCatalog = new Catalog("exampleCatalog", CatalogArgs.builder()
.name("example")
.resourceGroupName(testAzurermResourceGroup.name())
.devCenterId(test.id())
.catalogGithub(CatalogCatalogGithubArgs.builder()
.branch("foo")
.path("")
.uri("example URI")
.keyVaultKeyUrl("secret")
.build())
.build());
}
}
resources:
example:
type: azure:core:ResourceGroup
properties:
name: example-resources
location: West Europe
exampleDevCenter:
type: azure:devcenter:DevCenter
name: example
properties:
location: ${example.location}
name: example
resourceGroupName: ${example.name}
identity:
type: SystemAssigned
exampleCatalog:
type: azure:devcenter:Catalog
name: example
properties:
name: example
resourceGroupName: ${testAzurermResourceGroup.name}
devCenterId: ${test.id}
catalogGithub:
branch: foo
path: ""
uri: example URI
keyVaultKeyUrl: secret
API Providers
This resource uses the following Azure API Providers:
Microsoft.DevCenter
: 2025-02-01
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,
dev_center_id: Optional[str] = None,
resource_group_name: Optional[str] = None,
catalog_adogit: Optional[CatalogCatalogAdogitArgs] = None,
catalog_github: Optional[CatalogCatalogGithubArgs] = None,
name: Optional[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:devcenter:Catalog
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 CatalogArgs
- 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 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 string
- The unique name of the resource.
- args CatalogArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args CatalogArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args 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 Azure.DevCenter.Catalog("catalogResource", new()
{
DevCenterId = "string",
ResourceGroupName = "string",
CatalogAdogit = new Azure.DevCenter.Inputs.CatalogCatalogAdogitArgs
{
Branch = "string",
KeyVaultKeyUrl = "string",
Path = "string",
Uri = "string",
},
CatalogGithub = new Azure.DevCenter.Inputs.CatalogCatalogGithubArgs
{
Branch = "string",
KeyVaultKeyUrl = "string",
Path = "string",
Uri = "string",
},
Name = "string",
});
example, err := devcenter.NewCatalog(ctx, "catalogResource", &devcenter.CatalogArgs{
DevCenterId: pulumi.String("string"),
ResourceGroupName: pulumi.String("string"),
CatalogAdogit: &devcenter.CatalogCatalogAdogitArgs{
Branch: pulumi.String("string"),
KeyVaultKeyUrl: pulumi.String("string"),
Path: pulumi.String("string"),
Uri: pulumi.String("string"),
},
CatalogGithub: &devcenter.CatalogCatalogGithubArgs{
Branch: pulumi.String("string"),
KeyVaultKeyUrl: pulumi.String("string"),
Path: pulumi.String("string"),
Uri: pulumi.String("string"),
},
Name: pulumi.String("string"),
})
var catalogResource = new Catalog("catalogResource", CatalogArgs.builder()
.devCenterId("string")
.resourceGroupName("string")
.catalogAdogit(CatalogCatalogAdogitArgs.builder()
.branch("string")
.keyVaultKeyUrl("string")
.path("string")
.uri("string")
.build())
.catalogGithub(CatalogCatalogGithubArgs.builder()
.branch("string")
.keyVaultKeyUrl("string")
.path("string")
.uri("string")
.build())
.name("string")
.build());
catalog_resource = azure.devcenter.Catalog("catalogResource",
dev_center_id="string",
resource_group_name="string",
catalog_adogit={
"branch": "string",
"key_vault_key_url": "string",
"path": "string",
"uri": "string",
},
catalog_github={
"branch": "string",
"key_vault_key_url": "string",
"path": "string",
"uri": "string",
},
name="string")
const catalogResource = new azure.devcenter.Catalog("catalogResource", {
devCenterId: "string",
resourceGroupName: "string",
catalogAdogit: {
branch: "string",
keyVaultKeyUrl: "string",
path: "string",
uri: "string",
},
catalogGithub: {
branch: "string",
keyVaultKeyUrl: "string",
path: "string",
uri: "string",
},
name: "string",
});
type: azure:devcenter:Catalog
properties:
catalogAdogit:
branch: string
keyVaultKeyUrl: string
path: string
uri: string
catalogGithub:
branch: string
keyVaultKeyUrl: string
path: string
uri: string
devCenterId: string
name: string
resourceGroupName: string
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:
- Dev
Center stringId - Specifies the Dev Center Id within which this Dev Center Catalog should exist. Changing this forces a new Dev Center Catalog to be created.
- Resource
Group stringName - Specifies the name of the Resource Group within which this Dev Center Catalog should exist. Changing this forces a new Dev Center to be created.
- Catalog
Adogit CatalogCatalog Adogit - A
catalog_adogit
block as defined below. - Catalog
Github CatalogCatalog Github - A
catalog_github
block as defined below. - Name string
- Specifies the name of this Dev Center Catalog. Changing this forces a new Dev Center to be created.
- Dev
Center stringId - Specifies the Dev Center Id within which this Dev Center Catalog should exist. Changing this forces a new Dev Center Catalog to be created.
- Resource
Group stringName - Specifies the name of the Resource Group within which this Dev Center Catalog should exist. Changing this forces a new Dev Center to be created.
- Catalog
Adogit CatalogCatalog Adogit Args - A
catalog_adogit
block as defined below. - Catalog
Github CatalogCatalog Github Args - A
catalog_github
block as defined below. - Name string
- Specifies the name of this Dev Center Catalog. Changing this forces a new Dev Center to be created.
- dev
Center StringId - Specifies the Dev Center Id within which this Dev Center Catalog should exist. Changing this forces a new Dev Center Catalog to be created.
- resource
Group StringName - Specifies the name of the Resource Group within which this Dev Center Catalog should exist. Changing this forces a new Dev Center to be created.
- catalog
Adogit CatalogCatalog Adogit - A
catalog_adogit
block as defined below. - catalog
Github CatalogCatalog Github - A
catalog_github
block as defined below. - name String
- Specifies the name of this Dev Center Catalog. Changing this forces a new Dev Center to be created.
- dev
Center stringId - Specifies the Dev Center Id within which this Dev Center Catalog should exist. Changing this forces a new Dev Center Catalog to be created.
- resource
Group stringName - Specifies the name of the Resource Group within which this Dev Center Catalog should exist. Changing this forces a new Dev Center to be created.
- catalog
Adogit CatalogCatalog Adogit - A
catalog_adogit
block as defined below. - catalog
Github CatalogCatalog Github - A
catalog_github
block as defined below. - name string
- Specifies the name of this Dev Center Catalog. Changing this forces a new Dev Center to be created.
- dev_
center_ strid - Specifies the Dev Center Id within which this Dev Center Catalog should exist. Changing this forces a new Dev Center Catalog to be created.
- resource_
group_ strname - Specifies the name of the Resource Group within which this Dev Center Catalog should exist. Changing this forces a new Dev Center to be created.
- catalog_
adogit CatalogCatalog Adogit Args - A
catalog_adogit
block as defined below. - catalog_
github CatalogCatalog Github Args - A
catalog_github
block as defined below. - name str
- Specifies the name of this Dev Center Catalog. Changing this forces a new Dev Center to be created.
- dev
Center StringId - Specifies the Dev Center Id within which this Dev Center Catalog should exist. Changing this forces a new Dev Center Catalog to be created.
- resource
Group StringName - Specifies the name of the Resource Group within which this Dev Center Catalog should exist. Changing this forces a new Dev Center to be created.
- catalog
Adogit Property Map - A
catalog_adogit
block as defined below. - catalog
Github Property Map - A
catalog_github
block as defined below. - name String
- Specifies the name of this Dev Center Catalog. Changing this forces a new Dev Center to be created.
Outputs
All input properties are implicitly available as output properties. Additionally, the Catalog resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing Catalog Resource
Get an existing Catalog resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: CatalogState, opts?: CustomResourceOptions): Catalog
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
catalog_adogit: Optional[CatalogCatalogAdogitArgs] = None,
catalog_github: Optional[CatalogCatalogGithubArgs] = None,
dev_center_id: Optional[str] = None,
name: Optional[str] = None,
resource_group_name: Optional[str] = None) -> Catalog
func GetCatalog(ctx *Context, name string, id IDInput, state *CatalogState, opts ...ResourceOption) (*Catalog, error)
public static Catalog Get(string name, Input<string> id, CatalogState? state, CustomResourceOptions? opts = null)
public static Catalog get(String name, Output<String> id, CatalogState state, CustomResourceOptions options)
resources: _: type: azure:devcenter:Catalog get: id: ${id}
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Catalog
Adogit CatalogCatalog Adogit - A
catalog_adogit
block as defined below. - Catalog
Github CatalogCatalog Github - A
catalog_github
block as defined below. - Dev
Center stringId - Specifies the Dev Center Id within which this Dev Center Catalog should exist. Changing this forces a new Dev Center Catalog to be created.
- Name string
- Specifies the name of this Dev Center Catalog. Changing this forces a new Dev Center to be created.
- Resource
Group stringName - Specifies the name of the Resource Group within which this Dev Center Catalog should exist. Changing this forces a new Dev Center to be created.
- Catalog
Adogit CatalogCatalog Adogit Args - A
catalog_adogit
block as defined below. - Catalog
Github CatalogCatalog Github Args - A
catalog_github
block as defined below. - Dev
Center stringId - Specifies the Dev Center Id within which this Dev Center Catalog should exist. Changing this forces a new Dev Center Catalog to be created.
- Name string
- Specifies the name of this Dev Center Catalog. Changing this forces a new Dev Center to be created.
- Resource
Group stringName - Specifies the name of the Resource Group within which this Dev Center Catalog should exist. Changing this forces a new Dev Center to be created.
- catalog
Adogit CatalogCatalog Adogit - A
catalog_adogit
block as defined below. - catalog
Github CatalogCatalog Github - A
catalog_github
block as defined below. - dev
Center StringId - Specifies the Dev Center Id within which this Dev Center Catalog should exist. Changing this forces a new Dev Center Catalog to be created.
- name String
- Specifies the name of this Dev Center Catalog. Changing this forces a new Dev Center to be created.
- resource
Group StringName - Specifies the name of the Resource Group within which this Dev Center Catalog should exist. Changing this forces a new Dev Center to be created.
- catalog
Adogit CatalogCatalog Adogit - A
catalog_adogit
block as defined below. - catalog
Github CatalogCatalog Github - A
catalog_github
block as defined below. - dev
Center stringId - Specifies the Dev Center Id within which this Dev Center Catalog should exist. Changing this forces a new Dev Center Catalog to be created.
- name string
- Specifies the name of this Dev Center Catalog. Changing this forces a new Dev Center to be created.
- resource
Group stringName - Specifies the name of the Resource Group within which this Dev Center Catalog should exist. Changing this forces a new Dev Center to be created.
- catalog_
adogit CatalogCatalog Adogit Args - A
catalog_adogit
block as defined below. - catalog_
github CatalogCatalog Github Args - A
catalog_github
block as defined below. - dev_
center_ strid - Specifies the Dev Center Id within which this Dev Center Catalog should exist. Changing this forces a new Dev Center Catalog to be created.
- name str
- Specifies the name of this Dev Center Catalog. Changing this forces a new Dev Center to be created.
- resource_
group_ strname - Specifies the name of the Resource Group within which this Dev Center Catalog should exist. Changing this forces a new Dev Center to be created.
- catalog
Adogit Property Map - A
catalog_adogit
block as defined below. - catalog
Github Property Map - A
catalog_github
block as defined below. - dev
Center StringId - Specifies the Dev Center Id within which this Dev Center Catalog should exist. Changing this forces a new Dev Center Catalog to be created.
- name String
- Specifies the name of this Dev Center Catalog. Changing this forces a new Dev Center to be created.
- resource
Group StringName - Specifies the name of the Resource Group within which this Dev Center Catalog should exist. Changing this forces a new Dev Center to be created.
Supporting Types
CatalogCatalogAdogit, CatalogCatalogAdogitArgs
- Branch string
- The Git branch of the Dev Center Catalog.
- Key
Vault stringKey Url - A reference to the Key Vault secret containing a security token to authenticate to a Git repository.
- Path string
- The folder where the catalog items can be found inside the repository.
- Uri string
- The Git URI of the Dev Center Catalog.
- Branch string
- The Git branch of the Dev Center Catalog.
- Key
Vault stringKey Url - A reference to the Key Vault secret containing a security token to authenticate to a Git repository.
- Path string
- The folder where the catalog items can be found inside the repository.
- Uri string
- The Git URI of the Dev Center Catalog.
- branch String
- The Git branch of the Dev Center Catalog.
- key
Vault StringKey Url - A reference to the Key Vault secret containing a security token to authenticate to a Git repository.
- path String
- The folder where the catalog items can be found inside the repository.
- uri String
- The Git URI of the Dev Center Catalog.
- branch string
- The Git branch of the Dev Center Catalog.
- key
Vault stringKey Url - A reference to the Key Vault secret containing a security token to authenticate to a Git repository.
- path string
- The folder where the catalog items can be found inside the repository.
- uri string
- The Git URI of the Dev Center Catalog.
- branch str
- The Git branch of the Dev Center Catalog.
- key_
vault_ strkey_ url - A reference to the Key Vault secret containing a security token to authenticate to a Git repository.
- path str
- The folder where the catalog items can be found inside the repository.
- uri str
- The Git URI of the Dev Center Catalog.
- branch String
- The Git branch of the Dev Center Catalog.
- key
Vault StringKey Url - A reference to the Key Vault secret containing a security token to authenticate to a Git repository.
- path String
- The folder where the catalog items can be found inside the repository.
- uri String
- The Git URI of the Dev Center Catalog.
CatalogCatalogGithub, CatalogCatalogGithubArgs
- Branch string
- The Git branch of the Dev Center Catalog.
- Key
Vault stringKey Url - A reference to the Key Vault secret containing a security token to authenticate to a Git repository.
- Path string
- The folder where the catalog items can be found inside the repository.
- Uri string
- The Git URI of the Dev Center Catalog.
- Branch string
- The Git branch of the Dev Center Catalog.
- Key
Vault stringKey Url - A reference to the Key Vault secret containing a security token to authenticate to a Git repository.
- Path string
- The folder where the catalog items can be found inside the repository.
- Uri string
- The Git URI of the Dev Center Catalog.
- branch String
- The Git branch of the Dev Center Catalog.
- key
Vault StringKey Url - A reference to the Key Vault secret containing a security token to authenticate to a Git repository.
- path String
- The folder where the catalog items can be found inside the repository.
- uri String
- The Git URI of the Dev Center Catalog.
- branch string
- The Git branch of the Dev Center Catalog.
- key
Vault stringKey Url - A reference to the Key Vault secret containing a security token to authenticate to a Git repository.
- path string
- The folder where the catalog items can be found inside the repository.
- uri string
- The Git URI of the Dev Center Catalog.
- branch str
- The Git branch of the Dev Center Catalog.
- key_
vault_ strkey_ url - A reference to the Key Vault secret containing a security token to authenticate to a Git repository.
- path str
- The folder where the catalog items can be found inside the repository.
- uri str
- The Git URI of the Dev Center Catalog.
- branch String
- The Git branch of the Dev Center Catalog.
- key
Vault StringKey Url - A reference to the Key Vault secret containing a security token to authenticate to a Git repository.
- path String
- The folder where the catalog items can be found inside the repository.
- uri String
- The Git URI of the Dev Center Catalog.
Import
An existing Dev Center Catalog can be imported into Pulumi using the resource id
, e.g.
$ pulumi import azure:devcenter/catalog:Catalog example /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devCenters/{devCenterName}/catalogs/{catalogName}
Where
{subscriptionId}
is the ID of the Azure Subscription where the Dev Center exists. For example12345678-1234-9876-4563-123456789012
.Where
{resourceGroupName}
is the name of Resource Group where this Dev Center exists. For exampleexample-resource-group
.Where
{devCenterName}
is the name of the Dev Center. For exampledevCenterValue
.Where
{catalogName}
is the name of the Dev Center Catalog. For examplecatalogValue
.
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Classic pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
azurerm
Terraform Provider.