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

Атрибуция использования Azure пользователями

  • Статья

Атрибуция использования клиентами связывает использование ресурсов Azure в подписках клиентов, созданных при развертывании вашего IP, с вами как с партнером. Формирование этих связей во внутренних системах Майкрософт обеспечивает большую внутреннюю видимость использования Azure, где работает ваше программное обеспечение. Для предложений приложений Azure в коммерческой платформеэта возможность отслеживания помогает вам согласовывать работу с командами по продажам Microsoft и получать признание в партнерских программах Microsoft. Атрибуция использования клиентами не применима к предложениям виртуальных машин Azure в коммерческом маркетплейсе. Издателю Marketplace не нужно ничего делать для предложений виртуальных машин, чтобы гарантировать, что использование их Azure отслеживается в подписках конечных клиентов.

Определение использования клиентами предусматривает три варианта развертывания:

  1. Шаблоны Azure Resource Manager (распространенные подкрепления приложений Azure, которые также называются в коммерческой платформе "шаблонами решений" или "управляемыми приложениями"), партнеры создают шаблоны Resource Manager для определения инфраструктуры и конфигурации своих решений Azure. Шаблон Resource Manager позволяет клиентам развертывать ресурсы решения в согласованном и повторяемом состоянии.
  2. API Azure Resource Manager: партнеры могут вызывать API Resource Manager для развертывания шаблона Resource Manager или непосредственной подготовки служб Azure.
  3. Terraform: партнеры могут использовать Terraform для развертывания шаблона Resource Manager или непосредственного развертывания служб Azure.

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

Важный

  • Указание использования клиентов не предназначено для отслеживания работы интеграторов систем, поставщиков управляемых служб или средств, предназначенных в основном для развертывания ресурсов Azure и управления ими.

  • Назначение использования клиентских данных относится только к новым развертываниям и не позволяет отслеживать ресурсы, которые были развернуты ранее.

    • Не все службы Azure совместимы с отслеживанием использования клиентами. Службы Azure Kubernetes (AKS), наборы масштабирования виртуальных машин и сервис пакетной обработки Azure имеют известные проблемы, которые вызывают неполное сообщение о потреблении.
    • Данные о привязке использования клиентами к потреблению Azure не разглашаются вовне партнёрам.

Приложения Azure для коммерческого рынка

Отслеживание использования Azure из приложений Azure, опубликованных на коммерческом маркетплейсе, в значительной степени является автоматическим. При загрузке шаблона Resource Manager в рамках технической конфигурации плана вашего приложения Azure MarketplaceЦентр партнеров добавит идентификатор отслеживания, который будет распознаваться Azure Resource Manager.

Заметка

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

  1. Если вы определяете идентификатор отслеживания в типе ресурса Microsoft.Resources/deployment с переменной, замените переменную идентификатором отслеживания, видимым в Центре партнеров на странице Технической Конфигурации для плана (см. Добавление GUID в шаблон Resource Manager ниже).
  2. Если ваш шаблон Resource Manager использует ресурсы типа Microsoft.Resources/deployments для целей, не связанных с атрибуцией использования клиентами, корпорация Майкрософт не сможет добавить идентификатор отслеживания использования клиентов от вашего имени. Добавьте новый ресурс типа Microsoft.Resources/deployments и добавьте идентификатор отслеживания, который отображается в Центре партнеров на странице технической конфигурации плана (см. "Добавление GUID в шаблон Resource Manager" позже).

Если вы используете API Azure Resource Manager, вам необходимо добавить идентификатор отслеживания в соответствии с приведенными ниже инструкциями , чтобы передать его в Azure Resource Manager при развертывании ресурсов вашего кода. Этот идентификатор отображается в Центре партнеров на странице технической конфигурации плана приложений Azure.

Заметка

Для существующих приложений Azure разовая миграция была начата в марте 2021 г. с целью обновления идентификаторов отслеживания в технической конфигурации каждого из планов. Отслеживание использования этих предложений из предыдущих развертываний будет осуществляться в системах Microsoft.

При обновлении предложений больше не нужно добавлять Microsoft.Resources/deployments тип ресурса в основной файл шаблона.

Другие варианты использования

Вы можете использовать атрибуцию использования клиентами для отслеживания использования решений Azure, недоступных на коммерческой торговой площадке. Эти решения обычно находятся в репозитории Quickstart, частных репозиториях GitHub или получены из индивидуальных взаимодействий с клиентами, которые создают устойчивую интеллектуальную собственность (например, развертываемое и масштабируемое приложение).

Требуется выполнить несколько действий вручную.

  1. Создайте один или несколько идентификаторов GUID, которые будут использоваться в качестве ваших идентификаторов для отслеживания.
  2. Зарегистрируйте эти идентификаторы GUID в Центре партнеров.
  3. Добавьте зарегистрированные идентификаторы GUID в ваше приложение в Azure и/или в строку агента пользователя.

Создайте GUIDы

В отличие от идентификаторов отслеживания, создаваемых Партнёрским центром от вашего имени для приложений Azure на коммерческой торговой платформе, другие способы атрибуции использования клиентом требуют создания GUID в качестве идентификатора отслеживания. GUID — это уникальный идентификатор ссылки, имеющий 32 шестнадцатеричные цифры. Чтобы создать идентификаторы GUID для отслеживания, следует использовать генератор GUID, например с помощью PowerShell:

[guid]::NewGuid()

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

Регистрация идентификаторов GUID

Идентификаторы GUID должны быть зарегистрированы в Центре партнеров, чтобы их можно было ассоциировать с вами как с партнером.

  1. Войдите в Центр партнеров.

  2. Зарегистрируйтесь в качестве издателя коммерческой платформы.

  3. Выберите параметры (значок шестеренки) в правом верхнем углу, а затем параметры учетной записи.

  4. Выберите профиль организации>идентификаторы>Добавить GUID для отслеживания.

  5. В поле GUID введите ваш GUID отслеживания. Введите только GUID без префикса pid-. В поле Описание введите имя или описание вашего решения.

  6. Чтобы зарегистрировать более одного GUID, снова выберите Добавить GUID отслеживания. На странице отображаются дополнительные поля.

  7. Выберите Сохранить.

Добавьте GUID в шаблон диспетчера ресурсов

Чтобы добавить зарегистрированный GUID в шаблон системы управления ресурсами (Resource Manager), внесите одно изменение в основной файл шаблона.

  1. Откройте шаблон Resource Manager.

  2. Добавьте новый ресурс типа Microsoft.Resources/deployments в основном файле шаблона. Ресурс должен находиться только в файле mainTemplate.json или azuredeploy.json, а не в вложенных или связанных шаблонах.

  3. Введите значение GUID после префикса pid- в качестве имени ресурса. Например, если guid имеет значение eb7927c8-dd66-43e1-b0cf-c346a422063, имя ресурса будет pid-eb7927c8-dd66-43e1-b0cf-c346a422063. Пример:

{ // add this resource to the resources section in the mainTemplate.json
    "apiVersion": "2020-06-01",
    "name": "pid-XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", // use your generated GUID here
    "type": "Microsoft.Resources/deployments",
    "properties": {
        "mode": "Incremental",
        "template": {
            "$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#",
            "contentVersion": "1.0.0.0",
            "resources": []
        }
    }
} // remove all comments from the file when complete

  1. Проверьте шаблон на наличие ошибок.

  2. Повторно опубликуете шаблон в соответствующих репозиториях.

  3. Проверьте успешное использование GUID при развертывании шаблона.

Совет

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

Проверка развертываний, отслеживаемых с помощью GUID

После изменения шаблона и запуска тестового развертывания используйте следующий сценарий PowerShell, чтобы получить развернутые и помеченные ресурсы.

Скрипт можно использовать для проверки успешности добавления GUID в шаблон Resource Manager. Скрипт не применяется к развертываниям API Resource Manager или Terraform.

Войдите в Azure. Выберите подписку с развертыванием, которое необходимо проверить перед запуском скрипта. Запустите скрипт в рамках контекста подписки для развертывания.

GUID (ниже "deploymentName") и resourceGroupName имя развертывания являются обязательными параметрами.

Вы можете получить исходный скрипт Verify-DeploymentGuid на GitHub.

Param(
    [string][Parameter(Mandatory=$true)]$deploymentName, # the full name of the deployment, e.g. pid-XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
    [string][Parameter(Mandatory=$true)]$resourceGroupName
)

# Get the correlationId of the named deployment
$correlationId = (Get-AzResourceGroupDeployment -ResourceGroupName $resourceGroupName -Name "$deploymentName").correlationId

# Find all deployments with that correlationId
$deployments = Get-AzResourceGroupDeployment -ResourceGroupName $resourceGroupName | Where-Object{$_.correlationId -eq $correlationId}

# Find all deploymentOperations in all deployments with that correlationId as PowerShell doesn't surface outputResources on the deployment or correlationId on the deploymentOperation

foreach ($deployment in $deployments){
    # Get deploymentOperations by deploymentName
    # then the resourceIds for each resource
    ($deployment | Get-AzResourceGroupDeploymentOperation | Where-Object{$_.targetResource -notlike "*Microsoft.Resources/deployments*"}).TargetResource
}

Уведомление клиентов

Партнеры должны информировать своих клиентов о развертываниях, использующих учет использования клиентами. В следующих примерах содержатся материалы, которые можно использовать для уведомления клиентов об этих развертываниях. В примерах замените <PARTNER> именем вашей компании. Партнеры должны убедиться, что уведомление соответствует их политикам конфиденциальности и сбора данных, включая варианты исключения клиентов из отслеживания.

Уведомление о развертывании шаблонов Resource Manager

При развертывании этого шаблона Майкрософт может определить установку программного обеспечения <PARTNER> с развернутыми ресурсами Azure. Корпорация Майкрософт может сопоставить эти ресурсы, используемые для поддержки программного обеспечения. Корпорация Майкрософт собирает эти сведения, чтобы обеспечить лучшие возможности работы с продуктами и работать с бизнесом. Данные собираются и управляются политиками конфиденциальности Майкрософт, расположенными в https://www.microsoft.com/trustcenter.

Уведомление о развертывании пакета SDK или API

При развертывании программного обеспечения <ПАРТНЕР> корпорация Майкрософт может определить установку программного обеспечения <ПАРТНЕР> с развернутыми ресурсами Azure. Корпорация Майкрософт может сопоставить эти ресурсы, используемые для поддержки программного обеспечения. Корпорация Майкрософт собирает эти сведения, чтобы обеспечить лучшие возможности работы с продуктами и работать с бизнесом. Данные собираются и управляются политиками конфиденциальности Майкрософт, расположенными в https://www.microsoft.com/trustcenter.

Используйте API диспетчера ресурсов

В некоторых случаях можно выполнять вызовы непосредственно к REST API Resource Manager для развертывания служб Azure. Azure поддерживает несколько пакетов SDK для выполнения этих вызовов. Вы можете использовать один из пакетов SDK или напрямую обращаться к интерфейсам REST API для развертывания ресурсов.

Чтобы обеспечить атрибуцию использования клиентами, включите идентификатор отслеживания в заголовок агента пользователя в запросе при разработке вызовов API. Отформатируйте строку с префиксом pid-. Примеры:

//Commercial Marketplace Azure app
pid-contoso-myoffer-partnercenter //copy the tracking ID exactly as it appears in Partner Center

//Other use cases
pid-b6addd8f-5ff4-4fc0-a2b5-0ec7861106c4 //enter your GUID after "pid-"

Важный

Если вы используете API Resource Manager с приложением Azure в коммерческой платформе, используйте идентификатор отслеживания, предоставленный в Центре партнеров. Категорически не используйте GUID.

Различные пакеты SDK взаимодействуют с API Resource Manager по-разному и требуют некоторых различий в коде. В примерах ниже показан подход к некоммерческой рыночной площадке с использованием GUID и охватывающих ряд более популярных SDK для Azure.

Пример: пакет SDK для Python

Для Python используйте атрибут конфигурации. Атрибут можно добавить только в UserAgent. Пример:

client = azure.mgmt.servicebus.ServiceBusManagementClient(**parameters)
client.config.add_user_agent("pid-b6addd8f-5ff4-4fc0-a2b5-0ec7861106c4")

Важный

Добавьте атрибут для каждого клиента. Глобальной статической конфигурации нет. Вы можете пометить клиентскую фабрику, чтобы убедиться, что каждый клиент отслеживается. Дополнительные сведения см. в примере фабрики клиентов на GitHub.

Пример: пакет SDK для .NET

Для .NET обязательно задайте агент пользователя. Используйте библиотеку Microsoft.Azure.Management.Fluent, чтобы задать агент пользователя со следующим кодом (например, в C#):

var azure = Microsoft.Azure.Management.Fluent.Azure
    .Configure()
    // Add your pid in the user agent header
    .WithUserAgent("pid-XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", String.Empty) 
    .Authenticate(/* Credentials created via Microsoft.Azure.Management.ResourceManager.Fluent.SdkContext.AzureCredentialsFactory */)
    .WithSubscription("<subscription ID>");

Важный

По состоянию на июнь 2023 г. последняя версия пакета SDK для .NET для Центра партнеров 3.4.0 теперь архивируется. Вы можете скачать выпуск пакета SDK из Гитхабвместе с файлом ReadMe, который содержит полезные сведения.

Партнерам рекомендуется продолжать использовать интерфейсы REST API центра партнеров.

Пример: Azure PowerShell

При развертывании ресурсов с использованием Azure PowerShell, добавьте свой GUID с помощью следующего метода:

[Microsoft.Azure.Common.Authentication.AzureSession]::ClientFactory.AddUserAgent("pid-eb7927c8-dd66-43e1-b0cf-c346a422063")

Заметка

Мы рекомендуем использовать модуль Azure Az PowerShell для взаимодействия с Azure. См. раздел Установка Azure PowerShell, чтобы начать работу. Сведения о миграции в модуль Az PowerShell см. в статье Миграция Azure PowerShell из AzureRM в Az.

Пример: Azure CLI

При использовании Azure CLI для добавления GUID задайте переменную среды AZURE_HTTP_USER_AGENT в пределах скрипта. Вы также можете задать переменную глобально для области оболочки:

export AZURE_HTTP_USER_AGENT='pid-eb7927c8-dd66-43e1-b0cf-c346a422063'

Дополнительные сведения см. в статье Пакет SDK Azure для Go.

Используйте Terraform

Поддержка Terraform доступна через выпуск 1.21.0 поставщика Azure: https://github.com/terraform-providers/terraform-provider-azurerm/blob/master/CHANGELOG.md#1210-january-11-2019. Это относится ко всем партнерам, которые развертывают свое решение с помощью Terraform и всех ресурсов, развернутых и измеряемых поставщиком Azure (версия 1.21.0 или более поздней версии).

Поставщик Azure для Terraform добавил новое необязательное поле с именем partner_id для указания GUID отслеживания, используемого для решения. Значение этого поля также можно получить из переменной среды ARM_PARTNER_ID.

provider "azurerm" {
          subscription_id = "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
          client_id = "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
          ……
          # new stuff for ISV attribution
          partner_id = "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"}

Важный

Если вы используете Terraform с приложением Azure на коммерческой платформе, используйте весь идентификатор отслеживания, предоставленный в Центре партнеров. Категорически не используйте GUID.

Получение поддержки

Узнайте о возможностях поддержки в коммерческом маркетплейсе на поддержке программы коммерческого маркетплейса в Центре партнеров.

Отправка технического запроса на консультации

  1. Посетите Технические службы партнеров .
  2. Выберите облачную инфраструктуру и управление, чтобы просмотреть технический процесс.
  3. Выберите Службы развертывания>Отправьте запрос.
  4. Войдите с помощью учетной записи MSA (учетная запись Microsoft AI Cloud Partner Program) или идентификатора Microsoft Entra (учетная запись панели мониторинга партнера).
  5. Заполните или просмотрите контактные данные в открываемой форме. Сведения о консультации могут быть предварительно заполнены или у вас могут быть варианты раскрывающегося списка.
  6. Введите заголовок и подробное описание проблемы.
  7. Выберите Отправить.

Просмотрите пошаговые инструкции с экранами в разделе Использование технических служб предпродажной подготовки и развертывания.

Вам будет звонить технический консультант партнера Microsoft, чтобы назначить звонок для обсуждения ваших потребностей.

Вопросы и ответы

После добавления идентификатора отслеживания его можно изменить?

Идентификаторы отслеживания приложений Azure на коммерческой платформе управляются автоматически Центром партнеров. Однако клиент может скачать шаблон и изменить или удалить идентификатор отслеживания. Партнеры должны заранее описать роль идентификатора отслеживания для своих клиентов, чтобы предотвратить удаление или изменение. Изменение идентификатора отслеживания влияет только на новые развертывания и ресурсы, а не существующие.

Можно ли отслеживать шаблоны, развернутые из репозитория, отличного от Майкрософт, например GitHub?

Да, если идентификатор отслеживания присутствует при развертывании шаблона, его использование отслеживается. Чтобы сохранить связь между вами в качестве издателя и шаблона, развернутого из репозитория, не относящегося к Майкрософт, сначала скачайте копию опубликованного шаблона (которая будет содержать идентификатор отслеживания) из коммерческого списка вашего предложения на портале Azure. Публикация этой версии в GitHub или другом репозитории, отличном от Майкрософт.

Если шаблон не указан в коммерческой платформе и содержит зарегистрированный GUID, убедитесь, что GUID присутствует в версии, которую вы публикуете в GitHub или другом репозитории, отличном от Майкрософт.

Делится ли Майкрософт данными об атрибуции использования клиентов с партнерами?

Нет. Корпорация Майкрософт не предоставляет партнерам доступ к данным о потреблении Azure, отслеживаемым через атрибуцию использования клиентов.

Получают ли клиенты отчеты об атрибуции использования клиентами?

Нет. Клиенты могут отслеживать использование всех ресурсов или групп ресурсов на портале Azure. Клиенты не видят разбивку использования по идентификатору отслеживания атрибуции использования клиентами.

Механизм атрибуции использования клиентами — это способ связывания использования Azure с воспроизводимой и развертываемой интеллектуальной собственностью (IP) партнера, формируя связь в момент развертывания. DPOR и PAL предназначены для ассоциации консалтингового партнера (системного интегратора) или управляющего партнера (поставщика управляемых услуг) с соответствующей Azure-инфраструктурой клиента на время, пока партнер взаимодействует с клиентом.