Microsoft.DevCenter devcenters/catalogs 2023-08-01-preview

Bicep resource definition

The devcenters/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.DevCenter/devcenters/catalogs resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.DevCenter/devcenters/catalogs@2023-08-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    adoGit: {
      branch: 'string'
      path: 'string'
      secretIdentifier: 'string'
      uri: 'string'
    }
    gitHub: {
      branch: 'string'
      path: 'string'
      secretIdentifier: 'string'
      uri: 'string'
    }
  }
}

Property values

CatalogProperties

Name Description Value
adoGit Properties for an Azure DevOps catalog type. GitCatalog
gitHub Properties for a GitHub catalog type. GitCatalog

GitCatalog

Name Description Value
branch Git branch. string
path The folder where the catalog items can be found inside the repository. string
secretIdentifier A reference to the Key Vault secret containing a security token to authenticate to a Git repository. string
uri Git URI. string

Microsoft.DevCenter/devcenters/catalogs

Name Description Value
name The resource name string

Constraints:
Min length = 3
Max length = 3
Pattern = ^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$ (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.
Symbolic name for resource of type: devcenters
properties Catalog properties. CatalogProperties

Quickstart samples

The following quickstart samples deploy this resource type.

Bicep File Description
Configure Deployment Environments service This template provides a way to configure Deployment Environments.

ARM template resource definition

The devcenters/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.DevCenter/devcenters/catalogs resource, add the following JSON to your template.

{
  "type": "Microsoft.DevCenter/devcenters/catalogs",
  "apiVersion": "2023-08-01-preview",
  "name": "string",
  "properties": {
    "adoGit": {
      "branch": "string",
      "path": "string",
      "secretIdentifier": "string",
      "uri": "string"
    },
    "gitHub": {
      "branch": "string",
      "path": "string",
      "secretIdentifier": "string",
      "uri": "string"
    }
  }
}

Property values

CatalogProperties

Name Description Value
adoGit Properties for an Azure DevOps catalog type. GitCatalog
gitHub Properties for a GitHub catalog type. GitCatalog

GitCatalog

Name Description Value
branch Git branch. string
path The folder where the catalog items can be found inside the repository. string
secretIdentifier A reference to the Key Vault secret containing a security token to authenticate to a Git repository. string
uri Git URI. string

Microsoft.DevCenter/devcenters/catalogs

Name Description Value
apiVersion The api version '2023-08-01-preview'
name The resource name string

Constraints:
Min length = 3
Max length = 3
Pattern = ^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$ (required)
properties Catalog properties. CatalogProperties
type The resource type 'Microsoft.DevCenter/devcenters/catalogs'

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Configure Deployment Environments service

Deploy to Azure
This template provides a way to configure Deployment Environments.

Terraform (AzAPI provider) resource definition

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

  • Resource groups

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

Resource format

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DevCenter/devcenters/catalogs@2023-08-01-preview"
  name = "string"
  body = jsonencode({
    properties = {
      adoGit = {
        branch = "string"
        path = "string"
        secretIdentifier = "string"
        uri = "string"
      }
      gitHub = {
        branch = "string"
        path = "string"
        secretIdentifier = "string"
        uri = "string"
      }
    }
  })
}

Property values

CatalogProperties

Name Description Value
adoGit Properties for an Azure DevOps catalog type. GitCatalog
gitHub Properties for a GitHub catalog type. GitCatalog

GitCatalog

Name Description Value
branch Git branch. string
path The folder where the catalog items can be found inside the repository. string
secretIdentifier A reference to the Key Vault secret containing a security token to authenticate to a Git repository. string
uri Git URI. string

Microsoft.DevCenter/devcenters/catalogs

Name Description Value
name The resource name string

Constraints:
Min length = 3
Max length = 3
Pattern = ^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$ (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: devcenters
properties Catalog properties. CatalogProperties
type The resource type "Microsoft.DevCenter/devcenters/catalogs@2023-08-01-preview"