Workspace - Create Or Update

Служба:: API Management

Версия API:: 2024-05-01

Создает новую рабочую область или обновляет существующую.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}?api-version=2024-05-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Имя группы ресурсов. Имя не учитывает регистр.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Имя службы управления API.
subscriptionId	path	True	string (uuid)	Идентификатор целевой подписки. Значение должно быть UUID.
workspaceId	path	True	string minLength: 1 maxLength: 80 pattern: ^[^*#&+:<>?]+$	Идентификатор рабочей области. Должен быть уникальным в текущем экземпляре службы управления API.
api-version	query	True	string minLength: 1	Версия API, используемая для этой операции.

Заголовок запроса

Имя	Обязательно	Тип	Описание
If-Match		string	ETag сущности. Не требуется при создании сущности, но требуется при обновлении сущности.

Текст запроса

Имя	Обязательно	Тип	Описание
properties.displayName	True	string	Имя рабочей области.
properties.description		string	Описание рабочей области.

Ответы

Имя	Тип	Описание
200 OK	WorkspaceContract	Рабочая область успешно обновлена Заголовки ETag: string
201 Created	WorkspaceContract	Рабочая область успешно создана. Заголовки ETag: string
Other Status Codes	ErrorResponse	Ответ на ошибку, описывающий причину сбоя операции.

Имя

Тип

Описание

200 OK

WorkspaceContract

Рабочая область успешно обновлена

Заголовки

ETag: string

201 Created

WorkspaceContract

Рабочая область успешно создана.

Заголовки

ETag: string

Other Status Codes

ErrorResponse

Ответ на ошибку, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

ApiManagementCreateWorkspace

Образец запроса

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1?api-version=2024-05-01

{
  "properties": {
    "displayName": "my workspace",
    "description": "workspace 1"
  }
}

Пример ответа

Код состояния:: 201

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1",
  "type": "Microsoft.ApiManagement/service/workspaces",
  "name": "wks1",
  "properties": {
    "description": "workspace 1",
    "displayName": "my workspace"
  }
}

Код состояния:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1",
  "type": "Microsoft.ApiManagement/service/workspaces",
  "name": "wks1",
  "properties": {
    "description": "workspace 1",
    "displayName": "my workspace"
  }
}

Определения

Имя	Описание
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
WorkspaceContract	Сведения о рабочей области.

ErrorAdditionalInfo

Object

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

ErrorDetail

Object

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Object

Ответ на ошибку

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.

WorkspaceContract

Object

Сведения о рабочей области.

Имя	Тип	Описание
id	string	Полный идентификатор ресурса для ресурса. Пример - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Имя ресурса
properties.description	string	Описание рабочей области.
properties.displayName	string	Имя рабочей области.
type	string	Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"