Partilhar via

Atribuição de uso do cliente do Azure

  • Artigo

A atribuição de uso do cliente associa o uso dos recursos do Azure em assinaturas de cliente criadas durante a implantação de seu IP com você como parceiro. A formação dessas associações em sistemas internos da Microsoft traz maior visibilidade interna para a pegada do Azure executando seu software. Para ofertas de aplicativos do Azure no mercado comercial, esse recurso de rastreamento ajuda você a se alinhar com as equipes de vendas da Microsoft e obter crédito para programas de parceiros da Microsoft. A atribuição de uso do cliente não é aplicável às ofertas de máquina virtual do Azure no mercado comercial. Não há nada que um editor de mercado precise fazer para ofertas de máquina virtual para garantir que seu consumo do Azure seja rastreado em assinaturas de clientes finais.

A atribuição de uso do cliente oferece suporte a três opções de implantação:

  1. Modelos do Azure Resource Manager (os fundamentos comuns das aplicações do Azure, também referidos no mercado comercial como "modelos de solução" ou "aplicações geridas"): os parceiros criam modelos do Resource Manager para definir a infraestrutura e a configuração das suas soluções do Azure. Um modelo do Resource Manager permite que seus clientes implantem os recursos da solução em um estado consistente e repetível.
  2. APIs do Azure Resource Manager: os parceiros podem chamar as APIs do Resource Manager para implantar um modelo do Resource Manager ou provisionar diretamente os serviços do Azure.
  3. Terraform: os parceiros podem usar o Terraform para implantar um modelo do Resource Manager ou implantar diretamente os serviços do Azure.

Consulte Casos de uso secundários mais adiante neste artigo para atribuição de uso do cliente fora do mercado comercial.

Importante

  • A atribuição de uso do cliente não se destina a acompanhar o trabalho de integradores de sistemas, provedores de serviços gerenciados ou ferramentas projetadas principalmente para implantar e gerenciar recursos do Azure.

  • A atribuição de uso do cliente é para novas implantações e não oferece suporte a recursos de rastreamento que já foram implantados.

    • Nem todos os serviços do Azure são compatíveis com a atribuição de uso do cliente. Os Serviços Kubernetes do Azure (AKS), os Conjuntos de Escala de VM e o Lote do Azure têm problemas conhecidos que causam subnotificação de uso.
    • Atribuição de uso do cliente Os dados de consumo do Azure não são compartilhados externamente com parceiros.

Aplicativos do Azure do mercado comercial

O acompanhamento da utilização do Azure a partir de aplicações do Azure publicadas no mercado comercial é, em grande medida, automático. Quando você carrega um modelo do Gerenciador de Recursos como parte da configuração técnica do plano do seu aplicativo Azure do marketplace, o Partner Center adicionará uma ID de acompanhamento legível pelo Gerenciador de Recursos do Azure.

Nota

Para garantir que o uso do seu aplicativo seja atribuído com precisão em nossos sistemas:

  1. Se você definir a ID de acompanhamento no tipo de recurso Microsoft.Resources/deployment por uma variável, substitua a variável pela ID de acompanhamento visível no Partner Center na página Configuração Técnica do plano (consulte Adicionar um GUID a um modelo do Resource Manager abaixo).
  2. Se o seu modelo do Resource Manager usar recursos do tipo Microsoft.Resources/deployments para fins diferentes da atribuição de uso do cliente, a Microsoft não poderá adicionar um ID de acompanhamento de atribuição de uso do cliente em seu nome. Adicione um novo recurso do tipo Microsoft.Resources/deployments e adicione o ID de acompanhamento visível no Partner Center na página Configuração técnica do plano (consulte Adicionar um GUID a um modelo do Resource Manager abaixo).

Se você usar APIs do Azure Resource Manager, precisará adicionar sua ID de acompanhamento de acordo com as instruções abaixo para passá-la ao Azure Resource Manager à medida que seu código implanta recursos. Essa ID é visível no Partner Center na página Configuração Técnica do seu plano de Aplicativo do Azure.

Nota

Para aplicativos existentes do Azure, uma migração única começou em março de 2021 para atualizar as IDs de acompanhamento na configuração técnica de cada plano. O uso de implantações anteriores dessas ofertas permanecerá rastreado nos sistemas da Microsoft.

À medida que atualiza as suas ofertas, já não precisa de adicionar o tipo de recurso Microsoft.Resources/deployments no seu ficheiro de modelo principal.

Outros casos de uso

Você pode usar a atribuição de uso do cliente para acompanhar o uso do Azure de soluções não disponíveis no mercado comercial. Essas soluções geralmente residem no repositório Quickstart, repositórios privados do GitHub ou vêm de compromissos de cliente 1:1 que criam IP durável (como um aplicativo implantável e escalável).

São necessários vários passos manuais:

  1. Crie um ou mais GUIDs para usar como seus IDs de rastreamento.
  2. Registre esses GUIDs no Partner Center.
  3. Adicione seus GUIDs registrados ao seu aplicativo do Azure e/ou cadeias de caracteres do agente do usuário.

Criar GUIDs

Ao contrário das IDs de acompanhamento que o Partner Center cria em seu nome para aplicativos do Azure no mercado comercial, outros usos da Atribuição de Uso do Cliente exigem que você crie um GUID para usar como sua ID de acompanhamento. Um GUID é um identificador de referência exclusivo que tem 32 dígitos hexadecimais. Para criar GUIDs para rastreamento, você deve usar um gerador de GUID, por exemplo, via PowerShell:

[guid]::NewGuid()

Você deve criar um GUID exclusivo para cada produto e canal de distribuição. Você pode usar um único GUID para os vários canais de distribuição de um produto se não quiser que os relatórios sejam divididos. O relatório ocorre por PartnerID e GUID.

Registrar GUIDs

Em seguida, os GUIDs devem ser registrados no Partner Center para que possam ser associados a você como parceiro:

  1. Inicie sessão no Centro de Parceiros.

  2. Inscreva-se como um editor de mercado comercial.

  3. Selecione Configurações (ícone de engrenagem) no canto superior direito e, em seguida , Configurações da conta.

  4. Selecione Identificadores de perfil>da>organização Adicionar GUID de acompanhamento.

  5. Na caixa GUID, insira o GUID de acompanhamento. Digite apenas o GUID sem o prefixo pid- . Na caixa Descrição, insira o nome ou a descrição da solução.

  6. Para registrar mais de um GUID, selecione Adicionar GUID de acompanhamento novamente. Caixas adicionais aparecem na página.

  7. Selecione Guardar.

Adicionar um GUID a um modelo do Resource Manager

Para adicionar seu GUID registrado a um modelo do Gerenciador de Recursos, faça uma única modificação no arquivo de modelo principal:

  1. Abra o modelo do Resource Manager.

  2. Adicione um novo recurso do tipo Microsoft.Resources/deployments no arquivo de modelo principal. O recurso precisa estar apenas no arquivo mainTemplate.json ou azuredeploy.json , não em nenhum modelo aninhado ou vinculado.

  3. Insira o valor GUID após o prefixo pid- como o nome do recurso. Por exemplo, se o GUID for eb7927c8-dd66-43e1-b0cf-c346a422063, o nome do recurso será pid-eb7927c8-dd66-43e1-b0cf-c346a422063. Exemplo:

{ // 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. Verifique se há erros no modelo.

  2. Republique o modelo nos repositórios apropriados.

  3. Verifique o sucesso do GUID na implantação do modelo.

Gorjeta

Para obter mais informações sobre como criar e publicar modelos do Resource Manager, consulte: criar e implantar seu primeiro modelo do Resource Manager.

Verificar implantações rastreadas com um GUID

Depois de modificar seu modelo e executar uma implantação de teste, use o seguinte script do PowerShell para recuperar os recursos implantados e marcados.

Você pode usar o script para verificar se o GUID foi adicionado com êxito ao seu modelo do Gerenciador de Recursos. O script não se aplica à API do Resource Manager ou implantações do Terraform.

Inicie sessão no Azure. Selecione a assinatura com a implantação que você deseja verificar antes de executar o script. Execute o script dentro do contexto de assinatura da implantação.

O GUID (abaixo chamado "deploymentName") e o nome resourceGroupName da implantação são parâmetros necessários.

Você pode obter o script Verify-DeploymentGuid original no 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
}

Notifique os seus clientes

Os parceiros devem informar seus clientes sobre implantações que usam a atribuição de uso do cliente. Os exemplos a seguir incluem conteúdo que você pode usar para notificar seus clientes sobre essas implantações. Nos exemplos, substitua <PARTNER> pelo nome da sua empresa. Os parceiros devem garantir que a notificação está alinhada com as suas políticas de privacidade e recolha de dados, incluindo opções para os clientes serem excluídos do rastreio.

Notificação para implantações de modelo do Resource Manager

Quando você implanta esse modelo, a Microsoft pode identificar a instalação do <software PARTNER> com os recursos do Azure implantados. A Microsoft pode correlacionar esses recursos usados para dar suporte ao software. A Microsoft coleta essas informações para fornecer as melhores experiências com seus produtos e operar seus negócios. Os dados são recolhidos e regidos pelas políticas de privacidade da Microsoft, localizadas em https://www.microsoft.com/trustcenter.

Notificação para implantações de SDK ou API

Quando você implanta <o software PARTNER> , a Microsoft pode identificar a instalação do <software PARTNER> com os recursos implantados do Azure. A Microsoft pode correlacionar esses recursos usados para dar suporte ao software. A Microsoft coleta essas informações para fornecer as melhores experiências com seus produtos e operar seus negócios. Os dados são recolhidos e regidos pelas políticas de privacidade da Microsoft, localizadas em https://www.microsoft.com/trustcenter.

Usar APIs do Gerenciador de Recursos

Em alguns casos, você pode fazer chamadas diretamente nas APIs REST do Gerenciador de Recursos para implantar serviços do Azure. O Azure dá suporte a vários SDKs para habilitar essas chamadas. Você pode usar um dos SDKs ou chamar as APIs REST diretamente para implantar recursos.

Para habilitar a atribuição de uso do cliente, ao projetar suas chamadas de API, inclua seu ID de acompanhamento no cabeçalho do agente do usuário na solicitação. Formate a cadeia de caracteres com o prefixo pid- . Exemplos:

//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-"

Importante

Se você estiver usando APIs do Gerenciador de Recursos com um aplicativo do Azure no mercado comercial, use a ID de acompanhamento fornecida no Partner Center. NÃO use um GUID.

Vários SDKs interagem com as APIs do Resource Manager de forma diferente e exigirão algumas diferenças em seu código. Os exemplos abaixo apresentam a abordagem de mercado não comercial usando um GUID e abrangem uma variedade dos SDKs do Azure mais populares.

Exemplo: Python SDK

Para Python, use o atributo config . Você só pode adicionar o atributo a um UserAgent. Exemplo:

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

Importante

Adicione o atributo para cada cliente. Não há nenhuma configuração estática global. Você pode marcar uma fábrica de clientes para garantir que todos os clientes estejam rastreando. Para obter mais informações, consulte este exemplo de fábrica de cliente no GitHub.

Exemplo: SDK do .NET

Para .NET, certifique-se de definir o agente do usuário. Use a biblioteca Microsoft.Azure.Management.Fluent para definir o agente do usuário com o seguinte código (exemplo em 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>");

Importante

A partir de junho de 2023, a versão 3.4.0 mais recente do SDK do .NET do Partner Center foi arquivada. Você pode baixar a versão do SDK do GitHub, juntamente com um arquivo readme que contém informações úteis.

Os parceiros são incentivados a continuar a usar as APIs REST do Partner Center.

Exemplo: Azure PowerShell

Se você implantar recursos por meio do Azure PowerShell, acrescente seu GUID usando este método:

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

Nota

Recomendamos que utilize o módulo do Azure Az PowerShell para interagir com o Azure. Veja Instalar o Azure PowerShell para começar. Para saber como migrar para o módulo do Az PowerShell, veja Migrar o Azure PowerShell do AzureRM para o Az.

Exemplo: CLI do Azure

Quando você usa a CLI do Azure para acrescentar seu GUID, defina a variável de ambiente AZURE_HTTP_USER_AGENT dentro do escopo de um script. Você também pode definir a variável globalmente para o escopo do shell:

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

Para obter mais informações, consulte SDK do Azure para Go.

Use Terraform

O suporte para Terraform está disponível através da versão 1.21.0 do Azure Provider: https://github.com/terraform-providers/terraform-provider-azurerm/blob/master/CHANGELOG.md#1210-january-11-2019. Isso se aplica a todos os parceiros que implantam sua solução por meio do Terraform e a todos os recursos implantados e medidos pelo Provedor do Azure (versão 1.21.0 ou posterior).

O provedor do Azure para Terraform adicionou um novo campo opcional chamado partner_id para especificar o GUID de acompanhamento usado para sua solução. O valor desse campo também pode ser originado da variável de ambiente 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"}

Importante

Se você estiver usando o Terraform com um aplicativo do Azure no mercado comercial, use toda a ID de acompanhamento fornecida no Partner Center. NÃO use um GUID.

Obter suporte

Saiba mais sobre as opções de suporte no mercado comercial em Suporte para o programa de mercado comercial no Partner Center.

Como apresentar um pedido de consulta técnica

  1. Visite Serviços Técnicos de Parceiros.
  2. Selecione Infraestrutura e gerenciamento de nuvem para visualizar a jornada técnica.
  3. Selecione Serviços de>Implantação Enviar uma solicitação.
  4. Entre usando sua MSA (conta do Microsoft AI Cloud Partner Program) ou sua ID do Microsoft Entra (conta do Painel de Parceiros).
  5. Preencha/reveja as informações de contacto no formulário que abre. Os detalhes da consulta podem estar pré-preenchidos ou você pode ter opções suspensas.
  6. Insira um título e uma descrição detalhada do problema.
  7. Selecione Submeter.

Veja instruções passo a passo com capturas de tela em Usando serviços técnicos de pré-venda e implantação.

Você será contatado por um consultor técnico parceiro da Microsoft para configurar uma chamada para definir o escopo de suas necessidades.

FAQ

Depois que um ID de rastreamento é adicionado, ele pode ser alterado?

As IDs de acompanhamento para aplicativos do Azure no mercado comercial são gerenciadas automaticamente pelo Partner Center. Um cliente, no entanto, pode baixar um modelo e alterar ou remover o ID de rastreamento. Os parceiros devem descrever proativamente o papel do ID de rastreamento para seus clientes para evitar remoção ou edições. A alteração do ID de acompanhamento afeta apenas novas implantações e recursos, não os existentes.

Posso acompanhar modelos implantados a partir de um repositório que não seja da Microsoft, como o GitHub?

Sim, desde que o ID de acompanhamento esteja presente quando o modelo é implantado, o uso é rastreado. Para manter a associação entre você como editor e seu modelo implantado a partir de um repositório que não seja da Microsoft, primeiro baixe uma cópia do modelo publicado (que conterá a ID de acompanhamento) da listagem do mercado comercial da sua oferta no portal do Azure. Publique essa versão no GitHub ou em outro repositório que não seja da Microsoft.

Se seu modelo não estiver listado no mercado comercial e incluir um GUID registrado, verifique se o GUID está presente na versão que você publica no GitHub ou em outro repositório que não seja da Microsoft.

A Microsoft partilha dados de Atribuição de Utilização do Cliente com parceiros?

N.º A Microsoft não compartilha dados de consumo do Azure rastreados por meio da Atribuição de Uso do Cliente externamente com Parceiros.

Os clientes recebem relatórios de Atribuição de Uso do Cliente?

N.º Os clientes podem acompanhar o uso de todos os recursos ou grupos de recursos no portal do Azure. Os clientes não veem o uso discriminado pelo ID de rastreamento de Atribuição de Uso do Cliente.

A atribuição de uso do cliente é um mecanismo para associar o uso do Azure ao IP repetível e implantável de um parceiro - formando a associação no momento da implantação. O DPOR e o PAL destinam-se a associar um parceiro de consultoria (Integrador de Sistemas) ou de gestão (Managed Service Provider) à pegada relevante do Azure de um cliente durante o período em que o parceiro está envolvido com o cliente.