Службы Microsoft.ApiCenter, рабочие области и api

Определение ресурсов Bicep

Тип ресурса services/workspaces/apis можно развернуть с помощью операций, предназначенных для следующих операций:

Список измененных свойств в каждой версии API см. в журнала изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.ApiCenter/services/workspaces/apis, добавьте следующий Bicep в шаблон.

resource symbolicname 'Microsoft.ApiCenter/services/workspaces/apis@2024-06-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  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'
  }
}

Значения свойств

Microsoft.ApiCenter/services/workspaces/api

Имя	Описание	Ценность
имя	Имя ресурса	струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 90 Pattern = `^[a-zA-Z0-9-]{3,90}$` (обязательно)
родитель	В Bicep можно указать родительский ресурс для дочернего ресурса. Это свойство необходимо добавить, только если дочерний ресурс объявлен за пределами родительского ресурса. Дополнительные сведения см. в разделе "Дочерний ресурс вне родительского ресурса".	Символьное имя ресурса типа: службы и рабочие области
свойства	Свойства, относящиеся к ресурсу, для этого ресурса.	ApiProperties

ApiProperties

Имя	Описание	Ценность
Контакты	Набор контактов	Контакт[]
ПользовательскиеСвойства	Пользовательские метаданные, определенные для сущностей каталога API.	любой
описание	Описание API.	струна Ограничения целостности: Максимальная длина = 1000
внешняя документация	Набор внешней документации	ВнешняяДокументация[]
добрый	Вид API. Например, REST или GraphQL.	Graphql 'GRPC' "rest" "soap" "веб-перехватчик" Websocket (обязательно)
лицензия	Сведения о лицензии для API.	Лицензия
сводка	Краткое описание API.	струна Ограничения целостности: Максимальная длина = 200
условия обслуживания	Условия обслуживания ДЛЯ API.	УсловияOfService
титул	Заголовок API.	струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 50 (обязательно)

Контакт

Имя	Описание	Ценность
Отправить по электронной почте	Адрес электронной почты контакта.	струна Ограничения целостности: Максимальная длина = 100
имя	Имя контакта.	струна Ограничения целостности: Максимальная длина = 100
URL-адрес	URL-адрес контакта.	струна Ограничения целостности: Максимальная длина = 200

ВнешняяДокументация

Имя	Описание	Ценность
описание	Описание документации.	струна Ограничения целостности: Максимальная длина = 500
титул	Заголовок документации.	струна Ограничения целостности: Максимальная длина = 50
URL-адрес	URL-адрес, указывающий на документацию.	струна Ограничения целостности: Максимальная длина = 200 (обязательно)

Лицензия

Имя	Описание	Ценность
идентификатор	Сведения о лицензии SPDX для API. Поле идентификатора взаимно исключаемого поля URL-адреса.	струна Ограничения целостности: Максимальная длина = 50
имя	Имя лицензии.	струна Ограничения целостности: Максимальная длина = 100
URL-адрес	URL-адрес, указывающий на сведения о лицензии. Поле URL-адреса является взаимоисключающим из поля поле идентификатора.	струна Ограничения целостности: Максимальная длина = 200

УсловияOfService

Имя	Описание	Ценность
URL-адрес	URL-адрес, указывающий на условия обслуживания.	струна Ограничения целостности: Максимальная длина = 200 (обязательно)

Примеры использования

Примеры быстрого запуска Azure

Следующие шаблоны быстрого запуска Azure содержат примеры Bicep для развертывания этого типа ресурса.

Bicep-файл	Описание
Создание экземпляра Центра API Azure с помощью шаблона	Этот шаблон создает центр API и регистрирует API в центре API.

Определение ресурса шаблона ARM

Тип ресурса services/workspaces/apis можно развернуть с помощью операций, предназначенных для следующих операций:

Список измененных свойств в каждой версии API см. в журнала изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.ApiCenter/services/workspaces/apis, добавьте следующий код JSON в шаблон.

{
  "type": "Microsoft.ApiCenter/services/workspaces/apis",
  "apiVersion": "2024-06-01-preview",
  "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"
  }
}

Значения свойств

Microsoft.ApiCenter/services/workspaces/api

Имя	Описание	Ценность
apiVersion	Версия API	«2024-06-01-превью»
имя	Имя ресурса	струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 90 Pattern = `^[a-zA-Z0-9-]{3,90}$` (обязательно)
свойства	Свойства, относящиеся к ресурсу, для этого ресурса.	ApiProperties
тип	Тип ресурса	"Microsoft.ApiCenter/services/workspaces/apis"

ApiProperties

Имя	Описание	Ценность
Контакты	Набор контактов	Контакт[]
ПользовательскиеСвойства	Пользовательские метаданные, определенные для сущностей каталога API.	любой
описание	Описание API.	струна Ограничения целостности: Максимальная длина = 1000
внешняя документация	Набор внешней документации	ВнешняяДокументация[]
добрый	Вид API. Например, REST или GraphQL.	Graphql 'GRPC' "rest" "soap" "веб-перехватчик" Websocket (обязательно)
лицензия	Сведения о лицензии для API.	Лицензия
сводка	Краткое описание API.	струна Ограничения целостности: Максимальная длина = 200
условия обслуживания	Условия обслуживания ДЛЯ API.	УсловияOfService
титул	Заголовок API.	струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 50 (обязательно)

Контакт

Имя	Описание	Ценность
Отправить по электронной почте	Адрес электронной почты контакта.	струна Ограничения целостности: Максимальная длина = 100
имя	Имя контакта.	струна Ограничения целостности: Максимальная длина = 100
URL-адрес	URL-адрес контакта.	струна Ограничения целостности: Максимальная длина = 200

ВнешняяДокументация

Имя	Описание	Ценность
описание	Описание документации.	струна Ограничения целостности: Максимальная длина = 500
титул	Заголовок документации.	струна Ограничения целостности: Максимальная длина = 50
URL-адрес	URL-адрес, указывающий на документацию.	струна Ограничения целостности: Максимальная длина = 200 (обязательно)

Лицензия

Имя	Описание	Ценность
идентификатор	Сведения о лицензии SPDX для API. Поле идентификатора взаимно исключаемого поля URL-адреса.	струна Ограничения целостности: Максимальная длина = 50
имя	Имя лицензии.	струна Ограничения целостности: Максимальная длина = 100
URL-адрес	URL-адрес, указывающий на сведения о лицензии. Поле URL-адреса является взаимоисключающим из поля поле идентификатора.	струна Ограничения целостности: Максимальная длина = 200

УсловияOfService

Имя	Описание	Ценность
URL-адрес	URL-адрес, указывающий на условия обслуживания.	струна Ограничения целостности: Максимальная длина = 200 (обязательно)

Примеры использования

Шаблоны быстрого запуска Azure

Следующие шаблоны быстрого запуска Azure развертывают этот тип ресурса.

Шаблон	Описание
Создание экземпляра Центра API Azure с помощью шаблона	Этот шаблон создает центр API и регистрирует API в центре API.

Определение ресурса Terraform (поставщик AzAPI)

Тип ресурса services/workspaces/apis можно развернуть с помощью операций, предназначенных для следующих операций:

Список измененных свойств в каждой версии API см. в журнала изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.ApiCenter/services/workspaces/apis, добавьте следующий объект Terraform в шаблон.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiCenter/services/workspaces/apis@2024-06-01-preview"
  name = "string"
  parent_id = "string"
  body = {
    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"
    }
  }
}

Значения свойств

Microsoft.ApiCenter/services/workspaces/api

Имя	Описание	Ценность
имя	Имя ресурса	струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 90 Pattern = `^[a-zA-Z0-9-]{3,90}$` (обязательно)
идентификатор_родителя	Идентификатор ресурса, который является родительским для этого ресурса.	Идентификатор ресурса типа: службы и рабочие области
свойства	Свойства, относящиеся к ресурсу, для этого ресурса.	ApiProperties
тип	Тип ресурса	"Microsoft.ApiCenter/services/workspaces/apis@2024-06-01-preview"

ApiProperties

Имя	Описание	Ценность
Контакты	Набор контактов	Контакт[]
ПользовательскиеСвойства	Пользовательские метаданные, определенные для сущностей каталога API.	любой
описание	Описание API.	струна Ограничения целостности: Максимальная длина = 1000
внешняя документация	Набор внешней документации	ВнешняяДокументация[]
добрый	Вид API. Например, REST или GraphQL.	Graphql 'GRPC' "rest" "soap" "веб-перехватчик" Websocket (обязательно)
лицензия	Сведения о лицензии для API.	Лицензия
сводка	Краткое описание API.	струна Ограничения целостности: Максимальная длина = 200
условия обслуживания	Условия обслуживания ДЛЯ API.	УсловияOfService
титул	Заголовок API.	струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 50 (обязательно)

Контакт

Имя	Описание	Ценность
Отправить по электронной почте	Адрес электронной почты контакта.	струна Ограничения целостности: Максимальная длина = 100
имя	Имя контакта.	струна Ограничения целостности: Максимальная длина = 100
URL-адрес	URL-адрес контакта.	струна Ограничения целостности: Максимальная длина = 200

ВнешняяДокументация

Имя	Описание	Ценность
описание	Описание документации.	струна Ограничения целостности: Максимальная длина = 500
титул	Заголовок документации.	струна Ограничения целостности: Максимальная длина = 50
URL-адрес	URL-адрес, указывающий на документацию.	струна Ограничения целостности: Максимальная длина = 200 (обязательно)

Лицензия

Имя	Описание	Ценность
идентификатор	Сведения о лицензии SPDX для API. Поле идентификатора взаимно исключаемого поля URL-адреса.	струна Ограничения целостности: Максимальная длина = 50
имя	Имя лицензии.	струна Ограничения целостности: Максимальная длина = 100
URL-адрес	URL-адрес, указывающий на сведения о лицензии. Поле URL-адреса является взаимоисключающим из поля поле идентификатора.	струна Ограничения целостности: Максимальная длина = 200

УсловияOfService

Имя	Описание	Ценность
URL-адрес	URL-адрес, указывающий на условия обслуживания.	струна Ограничения целостности: Максимальная длина = 200 (обязательно)

Обратная связь

Были ли сведения на этой странице полезными?

Last updated on 2025-04-30

Поделиться через

Службы Microsoft.ApiCenter, рабочие области и api

Определение ресурсов Bicep

Формат ресурса

Значения свойств

Microsoft.ApiCenter/services/workspaces/api

ApiProperties

Контакт

ВнешняяДокументация

Лицензия

УсловияOfService

Примеры использования

Примеры быстрого запуска Azure

Определение ресурса шаблона ARM

Формат ресурса

Значения свойств

Microsoft.ApiCenter/services/workspaces/api

ApiProperties

Контакт

ВнешняяДокументация

Лицензия

УсловияOfService

Примеры использования

Шаблоны быстрого запуска Azure

Определение ресурса Terraform (поставщик AzAPI)

Формат ресурса

Значения свойств

Microsoft.ApiCenter/services/workspaces/api

ApiProperties

Контакт

ВнешняяДокументация

Лицензия

УсловияOfService

Обратная связь

Дополнительные ресурсы