Microsoft.ApiCenter services/workspaces 2024-03-01

Bicep resource definition

The services/workspaces resource type can be deployed with operations that target:

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

Usage Examples

Azure Quickstart Samples

The following Azure Quickstart templates contain Bicep samples for deploying this resource type.

Bicep File Description
Create an Azure API Center instance using a template This template creates an API center and registers an API in the API center.

Resource format

To create a Microsoft.ApiCenter/services/workspaces resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.ApiCenter/services/workspaces@2024-03-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    description: 'string'
    title: 'string'
  }
}

Property Values

Microsoft.ApiCenter/services/workspaces

Name Description Value
name The resource name string

Constraints:
Min length = 1
Max length = 90
Pattern = ^[a-zA-Z0-9-]{3,90}$ (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: services
properties The resource-specific properties for this resource. WorkspaceProperties

WorkspaceProperties

Name Description Value
description Workspace description. string
title Workspace title. string

Constraints:
Min length = 1
Max length = 50 (required)

ARM template resource definition

The services/workspaces resource type can be deployed with operations that target:

Usage Examples

Azure Quickstart Templates

The following Azure Quickstart templates deploy this resource type.

Template Description
Create an Azure API Center instance using a template

Deploy to Azure		 This template creates an API center and registers an API in the API center.

Resource format

To create a Microsoft.ApiCenter/services/workspaces resource, add the following JSON to your template.

{
  "type": "Microsoft.ApiCenter/services/workspaces",
  "apiVersion": "2024-03-01",
  "name": "string",
  "properties": {
    "description": "string",
    "title": "string"
  }
}

Property Values

Microsoft.ApiCenter/services/workspaces

Name Description Value
apiVersion The api version '2024-03-01'
name The resource name string

Constraints:
Min length = 1
Max length = 90
Pattern = ^[a-zA-Z0-9-]{3,90}$ (required)
properties The resource-specific properties for this resource. WorkspaceProperties
type The resource type 'Microsoft.ApiCenter/services/workspaces'

WorkspaceProperties

Name Description Value
description Workspace description. string
title Workspace title. string

Constraints:
Min length = 1
Max length = 50 (required)

Terraform (AzAPI provider) resource definition

The services/workspaces 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.ApiCenter/services/workspaces resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiCenter/services/workspaces@2024-03-01"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      description = "string"
      title = "string"
    }
  }
}

Property Values

Microsoft.ApiCenter/services/workspaces

Name Description Value
name The resource name string

Constraints:
Min length = 1
Max length = 90
Pattern = ^[a-zA-Z0-9-]{3,90}$ (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: services
properties The resource-specific properties for this resource. WorkspaceProperties
type The resource type "Microsoft.ApiCenter/services/workspaces@2024-03-01"

WorkspaceProperties

Name Description Value
description Workspace description. string
title Workspace title. string

Constraints:
Min length = 1
Max length = 50 (required)
  • Last updated on