Использование групп служб Azure для управления ресурсами

Вы можете группировать ресурсы между подписками, создавая группы служб Azure. Они предоставляют способ управления ресурсами с минимальными разрешениями, обеспечивая группирование и управление ресурсами без предоставления чрезмерного доступа. В этой статье вы узнаете, как управлять группами служб и ее членами.

Дополнительные сведения о группах служб см. в статье "Начало работы с группами служб".

Действия группы служб

В этом разделе показано, как управлять действиями группы служб, создавать, читать, обновлять и удалять их на портале Azure и использовать REST API Azure.

Создание группы служб

• Метод HTTP: PUT
• Поставщик ресурсов: Microsoft.Management
• Версия API: 2024-04-01-preview
• URL-адрес: https://management.azure.com/providers/Microsoft.Management/serviceGroups/[groupID]?api-version=2024-04-01-preview

Запрос текста.

{
    "kind":[kind],
    "properties": {
        "displayName": [displayName],
        "parent": {
            "resourceId": [resourceID]
        }
    } 
}

Ответ API:

{
	"id": "/providers/Microsoft.Management/serviceGroups/[groupID]",
	"type": "Microsoft.Management/serviceGroups",
	"name": [groupID],
	"kind": [kindValue],
	"properties": {
		"displayName": [displayNameValue],
		"parent": {
			"resourceId": "/providers/microsoft.management/servicegroups/[parentSGID]"
		},
		"provisioningState": "NotStarted"
	}
}

• GroupID: обязательное поле в URL-адресе, однозначно определяющем группу служб. Этот идентификатор неизменяем после создания
  • Группы служб должны иметь глобальное уникальное имя. Это означает, что он не привязывается к клиенту, в который создается, а распространяется на всех клиентов в этом облаке. Например: Общедоступное облако для всех клиентов.
• Тип: необязательное строковое свойство, используемое поставщиками ресурсов для сценариев. Значение параметра "тип" неизменяемо после создания.
• Отображаемое имя: необязательное строковое свойство для отображения другого имени, а не идентификатора группы
• Parent.ResourceID: обязательное свойство, которое должно иметь полный идентификатор Azure Resource Manager родительской группы служб.
  • Идентификатор группы корневой службы по умолчанию всегда является идентификатором клиента. providers/microsoft.management/servicegroups/[tenantID]
• идентификатор: идентификатор находится только в ответе и является идентификатором, созданным в URL-адресе запроса.
• provisioningState: действие HTTP PUT — это асинхронный вызов, в котором успешный вызов имеет ответ на принятое уведомление о успешном выполнении запроса API, и операция по-прежнему обрабатывается. Вызов GET по URL-адресу, возвращенному в заголовке azure-asyncoperation, может предоставить состояние операции. Посетите раздел Проверка состояния операции группы служб для получения дополнительных сведений.

Обновление группы служб

Чтобы обновить группу служб, можно использовать метод PUT или PATCH API с тем же текстом запроса. Put выполняет полную замену всех свойств.

• Метод HTTP: PUT или PATCH
• Поставщик ресурсов: Microsoft.Management
• Версия API: 2024-04-01-preview
• URL-адрес: https://management.azure.com/providers/Microsoft.Management/serviceGroups/[groupID]?api-version=2024-04-01-preview

Запрос текста.

{
    "kind":[kind],
    "properties": {
        "displayName": [displayName],
        "parent": {
            "resourceId": [resourceID]
        }
    } 
}

Ответ API:

{
	"id": "/providers/Microsoft.Management/serviceGroups/[groupID]",
	"type": "Microsoft.Management/serviceGroups",
	"name": [groupID],
	"kind": [kindValue],
	"properties": {
		"displayName": [displayNameValue],
		"parent": {
			"resourceId": "/providers/microsoft.management/servicegroups/[parentSGID]"
		},
		"provisioningState": "NotStarted"
	}
}

Описание свойств см. в разделе "Создание группы служб".

Удаление группы служб

• Метод HTTP: DELETE
• Поставщик ресурсов: Microsoft.Management
• Версия API: 2024-04-01-preview
• URL-адрес: https://management.azure.com/providers/Microsoft.Management/serviceGroups/[groupID]?api-version=2024-04-01-preview
• Без текста запроса

Ответ API: ответ DELETE возвращает код состояния HTTP. Действие HTTP DELETE — это асинхронный вызов, в котором успешный вызов имеет ответ на принятое уведомление о успешном выполнении запроса API, и операция по-прежнему обрабатывается. Вызов GET по URL-адресу, возвращенному в заголовке azure-asyncoperation, может предоставить состояние операции. Посетите раздел Проверка состояния операции группы служб для получения дополнительных сведений.

Считывание группы служб

• Метод HTTP: GET
• Поставщик ресурсов: Microsoft.Management
• Версия API: 2024-04-01-preview
• URL-адрес: https://management.azure.com/providers/Microsoft.Management/serviceGroups/[groupID]?api-version=2024-04-01-preview
• Без текста запроса

Ответ API:

{
	"id": "/providers/Microsoft.Management/serviceGroups/[groupID]",
	"type": "Microsoft.Management/serviceGroups",
	"name": [groupID],
	"kind": [kindValue],
	"properties": {
		"displayName": [displayNameValue],
		"parent": {
			"resourceId": "/providers/microsoft.management/servicegroups/[parentSGID]"
		},
		"provisioningState": "NotStarted"
	}
}

Описание свойств см. в разделе "Создание группы служб".

Перечисление предков

Группы служб имеют API, который позволяет получить все родители группы служб и их родители до корневой группы служб.

• Метод HTTP: POST

• Поставщик ресурсов: Microsoft.Management

• Версия API: 2024-04-01-preview

• URL-адрес: https://management.azure.com/providers/Microsoft.Management/serviceGroups/[groupID]/listAncestors?api-version=2024-04-01-preview

• Без текста запроса

Ответ API:

{
    "value": [
        {
            "id": "/providers/Microsoft.Management/serviceGroups/[groupID]",
            "type": "Microsoft.Management/serviceGroups",
            "name": "[groupId]]",
            "properties": {
              "displayName": "ServiceGroup Ancestor1"
            }
        },
        {
            "id": "/providers/Microsoft.Management/serviceGroups/[groupID]]",
            "type": "Microsoft.Management/serviceGroups",
            "name": "[groupID]",
            "properties": {
              "displayName": "ServiceGroup Ancestor2"
            }
        }
    ],
     "nextLink": [url]
}

Каждый родительский объект возвращается, показывая всех предков на пути к корневой группе служб. Этот API разбиен на страницы, а следующая ссылка будет предоставлена в ответе.

Члены группы служб

Члены группы служб — это ресурсы, группы ресурсов или подписки, подключенные к группе служб с отношением члена к группе служб. Создание ресурса-члена группы служб отличается от идентификации родительской группы службы.

Сравнение

Создание члена группы служб

Ресурсы, группы ресурсов и подписки могут стать членами служебной группы. Связь "Член группы служб" создается как расширение от члена, подключенного к группе.

• Метод HTTP: PUT
• Поставщик ресурсов: Microsoft.Relationships
• Версия API: 2023-09-01-preview
• URL-адрес: https://management.azure.com/[scope]/providers/Microsoft.relationships/serviceGroupMember/[RelationshipID]?api-version=2023-09-01-preview

Основное содержание запроса

{
    "properties": {
        "targetId": "/providers/Microsoft.Management/serviceGroups/[groupID]"
    }
}

• Идентификатор связи: уникальный идентификатор, используемый для отслеживания связи.
• targetID: targetID — это группа служб, частью которой является этот ресурс.

ПОЛУЧЕНИЕ члена группы служб

Ресурсы, группы ресурсов и подписки все могут быть членами группы обслуживания. Связь члена группы услуг создается как добавление к члену, подключенному к группе.

• Метод HTTP: GET
• Поставщик ресурсов: Microsoft.Relationships
• Версия API: 2023-09-01-preview
• URL-адрес: https://management.azure.com/[scope]/providers/Microsoft.relationships/serviceGroupMember/[RelationshipID]?api-version=2023-09-01-preview
• Без текста запроса

Ответ API

{
	"properties": {
		"targetId": [targetId],
		"sourceId": [sourceId],
		"targetTenant": [tenantId],
		"metadata": {
			"sourceType": "Microsoft.Resources/subscriptions",
			"targetType": "Microsoft.Management/serviceGroups"
		},
		"originInformation": {
			"relationshipOriginType": "UserExplicitlyCreated"
		},
		"provisioningState": [state]
	},
	"id": [fullResourceID],
	"name": [RelationshipID],
	"type": "Microsoft.Relationships/serviceGroupMember"
}

• Идентификатор связи: уникальный идентификатор, используемый для отслеживания связи. Создано и используется в URL-адресе.
• Свойства
  • Целевой идентификатор: targetID — это идентификатор ресурса группы служб, в который входит ресурс.
  • Source ID: sourceID — это идентификатор ресурса области, который выполняет роль связи и расширения в направлении целевого объекта.
  • Целевой клиент: идентификатор клиента ресурса, который является целевым.
  • Метаданные * Тип источника: тип ресурса источника, из который подключается связь. * Целевой тип: тип целевого ресурса, к которому устанавливается связь.
  • Сведения о источнике * Тип источника связи: неизменяемое свойство клиента определяет, как была создана связь. Дополнительные сведения о свойстве сведений о источнике см. в разделе "Сведения о источнике".
  • Состояние подготовки: Создать члена группы служб через конечную точку API — это асинхронный вызов, то есть ответ на запрос создания сообщает только о его успешности, а не о состоянии операции. Вызов GET к самому ресурсу связи успешен, если создана связь между участниками группы служб. Дополнительные сведения о состоянии операции см. в разделе "Проверка состояния операции группы служб"
• Идентификатор: полный идентификатор ресурса-члена группы сервисов, включая ресурс области его охвата.
• Тип ресурса-члена группы служб.

Удаление члена группы служб

Ресурсы, группы ресурсов и подписки могут стать членами служебной группы. Связь с участником группы служб удаляется, чтобы разорвать соединение между участником и группой служб.

• Метод HTTP: DELETE
• Поставщик ресурсов: Microsoft.Relationships
• Версия API: 2023-09-01-preview
• URL-адрес: https://management.azure.com/[scope]/providers/Microsoft.relationships/serviceGroupMember/[RelationshipID]?api-version=2023-09-01-preview
• Текст запроса отсутствует

Ответ API: ответ DELETE возвращает код состояния HTTP. Действие HTTP DELETE — это асинхронный вызов, в котором принимается успешный ответ на вызовы. Этот ответ указывает, что запрос API был успешно выполнен, и операция по-прежнему происходит в серверной части. Вызов GET по URL-адресу, указанному в заголовке locations, предоставляет состояние операции. Дополнительные сведения о состоянии операции см. в разделе "Проверка состояния операции группы служб".

Проверка состояния операции группы служб

Все вызовы PUT, PATCH и DELETE API к группам служб и членам групп служб являются асинхронными http-вызовами, что означает, что вызов API, сделанный в Azure, получает ответ, если вызов выполнен успешно, а не ожидает завершения операции возврата состояния. Эта практика позволяет повысить производительность, так как вызывающая сторона и служба не должны оставаться подключенными постоянно.

Например, если клиент создал вызов REST API для создания группы служб. Запрос API поступает в Azure и к поставщику ресурсов для групп служб для обработки. Ответ клиента заключается в том, что запрос был получен или произошел сбой.

Чтобы получить состояние операции, чтобы узнать, была ли создана группа служб или нет, клиент выполняет отдельный вызов. Возвращается статус для всей операции.

Получение состояния операции

URL-адрес, используемый для получения состояния операции, возвращается в качестве заголовка ответа начального запроса.

Для создания или обновления групп служб и их участников возвращается заголовок Azure-AsyncOperation. Поместив вызов GET на этот URL-адрес, возвращает состояние.

Получить ответ на Azure-AsyncOperation

{
	"status": [status]
}

Для операций удаления групп сервисов или участников группы сервисов заголовок расположения возвращается вместе с URL-адресом. Поместите вызов GET на этот URL-адрес, чтобы получить состояние.

Важно отметить, что при проверке состояния с помощью заголовка расположения текст ответа отсутствует. Код состояния отражает общее состояние.

Использование функции "Get" для проверки состояния

Операция GET в группе служб или члене группы служб для проверки состояния может быть выполнена, но если объект еще не создан, возвращается ошибка. Первоначальный запрос запускает операцию, чтобы начать создание, обновление или удаление группы служб или члена группы служб. Хотя эта операция выполняется, все вызовы GET для этого объекта возвращают 403 Запрещено , 404 Not Found, 401 Not Authorized или текущую информацию до завершения операции.

Рекомендуется использовать URL-адрес, указанный в заголовках Azure-AsyncOperation или расположения для проверки состояния операций.

Сведения о источнике

Связи членов группы служб имеют набор свойств с именем Origin Information в ответе вызова GET. Информация, указанная в этой статье, определяет, как создается связь.

Допустимые значения:

• ServiceExplicitlyCreated: служба создала связь.
• UserExplicitlyCreated: пользователь создал связь.

Связанный контент

• Что такое группы служб Azure?
• Краткое руководство. Создание группы служб (предварительная версия) с помощью REST API
• Краткое руководство. Подключение ресурсов или контейнеров ресурсов к группам служб через взаимоотношения между членами групп служб
• Подключение членов группы служб с помощью REST API