Share via


Microsoft.ApiCenter services/workspaces/apis

Choose a deployment language

Bicep resource definition

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

resource symbolicname 'Microsoft.ApiCenter/services/workspaces/apis@2024-03-01' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    contacts: [
      {
        email: 'string'
        name: 'string'
        url: 'string'
      }
    ]
    customProperties: any()
    description: 'string'
    externalDocumentation: [
      {
        description: 'string'
        title: 'string'
        url: 'string'
      }
    ]
    kind: 'string'
    license: {
      identifier: 'string'
      name: 'string'
      url: 'string'
    }
    summary: 'string'
    termsOfService: {
      url: 'string'
    }
    title: 'string'
  }
}

Property values

services/workspaces/apis

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.
string (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: workspaces
properties API properties. ApiProperties

ApiProperties

Name Description Value
contacts Contact[]
customProperties The custom metadata defined for API catalog entities. For Bicep, you can use the any() function.
description Description of the API. string

Constraints:
Max length = 1000
externalDocumentation ExternalDocumentation[]

Constraints:
Max length = 20
kind Kind of API. For example, REST or GraphQL. 'graphql'
'grpc'
'rest'
'soap'
'webhook'
'websocket' (required)
license The license information for the API. License
summary Short description of the API. string

Constraints:
Max length = 200
termsOfService Terms of service for the API. TermsOfService
title API title. string (required)

Constraints:
Min length = 1
Max length = 50

Contact

Name Description Value
email Email address of the contact. string

Constraints:
Max length = 100
name Name of the contact. string

Constraints:
Max length = 100
url URL for the contact. string

Constraints:
Max length = 200

ExternalDocumentation

Name Description Value
description Description of the documentation. string

Constraints:
Max length = 500
title Title of the documentation. string

Constraints:
Max length = 50
url URL pointing to the documentation. string (required)

Constraints:
Max length = 200

License

Name Description Value
identifier SPDX license information for the API. The identifier field is mutually exclusive of the URL field. string

Constraints:
Max length = 50
name Name of the license. string

Constraints:
Max length = 100
url URL pointing to the license details. The URL field is mutually exclusive of the identifier field. string

Constraints:
Max length = 200

TermsOfService

Name Description Value
url URL pointing to the terms of service. string (required)

Constraints:
Max length = 200

ARM template resource definition

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

{
  "type": "Microsoft.ApiCenter/services/workspaces/apis",
  "apiVersion": "2024-03-01",
  "name": "string",
  "properties": {
    "contacts": [
      {
        "email": "string",
        "name": "string",
        "url": "string"
      }
    ],
    "customProperties": {},
    "description": "string",
    "externalDocumentation": [
      {
        "description": "string",
        "title": "string",
        "url": "string"
      }
    ],
    "kind": "string",
    "license": {
      "identifier": "string",
      "name": "string",
      "url": "string"
    },
    "summary": "string",
    "termsOfService": {
      "url": "string"
    },
    "title": "string"
  }
}

Property values

services/workspaces/apis

Name Description Value
type The resource type 'Microsoft.ApiCenter/services/workspaces/apis'
apiVersion The resource api version '2024-03-01'
name The resource name

See how to set names and types for child resources in JSON ARM templates.
string (required)
properties API properties. ApiProperties

ApiProperties

Name Description Value
contacts Contact[]
customProperties The custom metadata defined for API catalog entities.
description Description of the API. string

Constraints:
Max length = 1000
externalDocumentation ExternalDocumentation[]

Constraints:
Max length = 20
kind Kind of API. For example, REST or GraphQL. 'graphql'
'grpc'
'rest'
'soap'
'webhook'
'websocket' (required)
license The license information for the API. License
summary Short description of the API. string

Constraints:
Max length = 200
termsOfService Terms of service for the API. TermsOfService
title API title. string (required)

Constraints:
Min length = 1
Max length = 50

Contact

Name Description Value
email Email address of the contact. string

Constraints:
Max length = 100
name Name of the contact. string

Constraints:
Max length = 100
url URL for the contact. string

Constraints:
Max length = 200

ExternalDocumentation

Name Description Value
description Description of the documentation. string

Constraints:
Max length = 500
title Title of the documentation. string

Constraints:
Max length = 50
url URL pointing to the documentation. string (required)

Constraints:
Max length = 200

License

Name Description Value
identifier SPDX license information for the API. The identifier field is mutually exclusive of the URL field. string

Constraints:
Max length = 50
name Name of the license. string

Constraints:
Max length = 100
url URL pointing to the license details. The URL field is mutually exclusive of the identifier field. string

Constraints:
Max length = 200

TermsOfService

Name Description Value
url URL pointing to the terms of service. string (required)

Constraints:
Max length = 200

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiCenter/services/workspaces/apis@2024-03-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      contacts = [
        {
          email = "string"
          name = "string"
          url = "string"
        }
      ]
      description = "string"
      externalDocumentation = [
        {
          description = "string"
          title = "string"
          url = "string"
        }
      ]
      kind = "string"
      license = {
        identifier = "string"
        name = "string"
        url = "string"
      }
      summary = "string"
      termsOfService = {
        url = "string"
      }
      title = "string"
    }
  })
}

Property values

services/workspaces/apis

Name Description Value
type The resource type "Microsoft.ApiCenter/services/workspaces/apis@2024-03-01"
name The resource name string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: workspaces
properties API properties. ApiProperties

ApiProperties

Name Description Value
contacts Contact[]
customProperties The custom metadata defined for API catalog entities.
description Description of the API. string

Constraints:
Max length = 1000
externalDocumentation ExternalDocumentation[]

Constraints:
Max length = 20
kind Kind of API. For example, REST or GraphQL. "graphql"
"grpc"
"rest"
"soap"
"webhook"
"websocket" (required)
license The license information for the API. License
summary Short description of the API. string

Constraints:
Max length = 200
termsOfService Terms of service for the API. TermsOfService
title API title. string (required)

Constraints:
Min length = 1
Max length = 50

Contact

Name Description Value
email Email address of the contact. string

Constraints:
Max length = 100
name Name of the contact. string

Constraints:
Max length = 100
url URL for the contact. string

Constraints:
Max length = 200

ExternalDocumentation

Name Description Value
description Description of the documentation. string

Constraints:
Max length = 500
title Title of the documentation. string

Constraints:
Max length = 50
url URL pointing to the documentation. string (required)

Constraints:
Max length = 200

License

Name Description Value
identifier SPDX license information for the API. The identifier field is mutually exclusive of the URL field. string

Constraints:
Max length = 50
name Name of the license. string

Constraints:
Max length = 100
url URL pointing to the license details. The URL field is mutually exclusive of the identifier field. string

Constraints:
Max length = 200

TermsOfService

Name Description Value
url URL pointing to the terms of service. string (required)

Constraints:
Max length = 200