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

Job Agents - Get

  • Ссылка
Служба:
SQL Database
Версия API:
2023-08-01

Возвращает агент задания.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}?api-version=2023-08-01

Параметры URI

Имя В Обязательно Тип Описание
jobAgentName
 path True

string

Имя извлекаемого агента задания.
resourceGroupName
 path True

string

Имя группы ресурсов, содержащей ресурс. Это значение можно получить из API Azure Resource Manager или портала.
serverName
 path True

string

Имя сервера.
subscriptionId
 path True

string

Идентификатор подписки, идентифицирующий подписку Azure.
api-version
 query True

string

Версия API, используемая для запроса.

Ответы

Имя Тип Описание
200 OK

JobAgent

Успешно получен указанный агент задания.
Other Status Codes

ErrorResponse

Ответы на ошибки: ***

  • 400 ManagedInstanceStoppingOrStoppingOrStopped — конфликтующая операция, отправленная во время остановки или остановки экземпляра

  • 400 ManagedInstanceStarting — конфликтующая операция, отправленная во время запуска экземпляра

  • 404 ServerNotInSubscriptionResourceGroup — указанный сервер не существует в указанной группе ресурсов и подписке.

  • 404 SubscriptionDoesNotHaveServer — запрошенный сервер не найден

  • 404 JobAgentNotFound — указанный агент задания не существует на указанном логическом сервере.

  • 409 ServerDisabled — сервер отключен.

Примеры

Get a job agent

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

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1?api-version=2023-08-01

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

Код состояния:
200 
{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1",
  "name": "agent1",
  "type": "Microsoft.Sql/servers/jobAgents",
  "location": "southeastasia",
  "sku": {
    "name": "JA400",
    "capacity": 400
  },
  "properties": {
    "databaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/databases/db1"
  }
}

Определения

Имя Описание
ErrorAdditionalInfo

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

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

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

Агент задания SQL Azure.
JobAgentIdentity

Конфигурация удостоверений Azure Active Directory для ресурса.
JobAgentIdentityType

Тип удостоверения агента задания
JobAgentState

Состояние агента задания.
JobAgentUserAssignedIdentity

Конфигурация удостоверений Azure Active Directory для ресурса.
Sku

SKU ресурса ARM.

ErrorAdditionalInfo

Object

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

Имя Тип Описание
info

object

Дополнительные сведения.
type

string

Дополнительный тип сведений.

ErrorDetail

Object

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

Имя Тип Описание
additionalInfo

ErrorAdditionalInfo[]

Дополнительные сведения об ошибке.
code

string

Код ошибки.
details

ErrorDetail[]

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

string

Сообщение об ошибке.
target

string

Целевой объект ошибки.

ErrorResponse

Object

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

Имя Тип Описание
error

ErrorDetail

Объект ошибки.

JobAgent

Object

Агент задания SQL Azure.

Имя Тип Описание
id

string

Идентификатор ресурса.
identity

JobAgentIdentity

Удостоверение агента задания.
location

string

Расположение ресурса.
name

string

Имя ресурса.
properties.databaseId

string (arm-id)

Идентификатор ресурса базы данных для хранения метаданных задания.
properties.state

JobAgentState

Состояние агента задания.
sku

Sku

Имя и уровень номера SKU.
tags

object

Теги ресурсов.
type

string

Тип ресурса.

JobAgentIdentity

Object

Конфигурация удостоверений Azure Active Directory для ресурса.

Имя Тип Описание
tenantId

string (uuid)

Идентификатор клиента удостоверений агента задания
type

JobAgentIdentityType

Тип удостоверения агента задания
userAssignedIdentities

<string,  JobAgentUserAssignedIdentity>

Идентификаторы ресурса назначенных пользователем удостоверений для использования

JobAgentIdentityType

Перечисление

Тип удостоверения агента задания

Значение Описание
None
SystemAssigned
SystemAssignedUserAssigned
UserAssigned

JobAgentState

Перечисление

Состояние агента задания.

Значение Описание
Creating
Deleting
Disabled
Ready
Updating

JobAgentUserAssignedIdentity

Object

Конфигурация удостоверений Azure Active Directory для ресурса.

Имя Тип Описание
clientId

string (uuid)

Идентификатор клиента Azure Active Directory.
principalId

string (uuid)

Идентификатор субъекта Azure Active Directory.

Sku

Object

SKU ресурса ARM.

Имя Тип Описание
capacity

integer (int32)

Емкость конкретного номера SKU.
family

string

Если служба имеет разные поколения оборудования для одного номера SKU, это можно записать здесь.
name

string

Имя номера SKU, как правило, буква + код номера, например P3.
size

string

Размер конкретного номера SKU
tier

string

Уровень или выпуск конкретного номера SKU, например "Базовый", "Премиум".