Share via


Atribuição de uso do cliente Azure

A atribuição de uso do cliente associa o uso de recursos do Azure em assinaturas de cliente criadas durante a implantação de seu IP com você como um parceiro. Formar essas associações em sistemas internos da Microsoft traz maior visibilidade interna para a área de cobertura do Azure executando seu software. Para as ofertas de aplicativo Azure no mercado comercial, esse recurso de controle ajuda você a se alinhar com as equipes de vendas da Microsoft e obter o crédito dos 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 do marketplace precise fazer nas ofertas de máquina virtual para garantir que o consumo do Azure seja rastreado nas assinaturas do cliente final.

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

  1. Azure Resource Manager modelos (as bases comuns dos aplicativos do Azure, também referenciados no Marketplace comercial como "modelos de solução" ou "aplicativos gerenciados"): os parceiros criam modelos do Resource Manager para definir a infraestrutura e a configuração de 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 para 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 rastrear 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 destina-se a novas implantações e não dá suporte ao rastreamento de recursos existentes já implantados.

    • Nem todos os serviços do Azure são compatíveis com a atribuição de uso do cliente. Os AKS (serviços Kubernetess do Azure), os conjuntos de dimensionamento de VM e o lote do Azure têm problemas conhecidos que causam a geração de relatórios de uso.
    • Atribuição de uso do cliente Os dados de consumo do Azure não são compartilhados externamente com parceiros.

Aplicativos de marketplace comercial Azure

O controle do uso do Azure de aplicativos do Azure publicados no Marketplace comercial é amplamente automático. Ao carregar um modelo do Resource Manager como parte da configuração técnica do plano do aplicativo do Azure do Marketplace, o Partner Center adicionará uma ID de rastreamento legível por Azure Resource Manager.

Observação

Para garantir que o uso do 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 com uma variável, substitua a variável pela ID de rastreamento visível na Central de Parceiros, na página de Configuração Técnica do plano (consulte Adicionar um GUID a um modelo do Resource Manager abaixo).
  2. Se o modelo Resource Manager usar recursos do tipo Microsoft.Resources/deployments para fins que não sejam a atribuição de uso do cliente, a Microsoft não poderá adicionar uma ID de acompanhamento de atribuição de uso do cliente em seu nome. Adicione um novo tipo de recurso Microsoft.Resources/deployment e adicione também a ID de rastreamento na Central de Parceiros, na página de Configuração Técnica do plano (consulte abaixo Adicionar um GUID a um modelo do Resource Manager).

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

Observação

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

Ao atualizar suas ofertas, você não precisa mais adicionar o tipo de recurso Microsoft. Resources/Implantations em seu arquivo de modelo principal.

Outros casos de uso

Você pode usar a atribuição de uso do cliente para controlar o uso do Azure de soluções não disponíveis no mercado comercial. Essas soluções geralmente residem no repositório de Início Rápido, repositórios do GitHub privado ou provenientes de 1:1 compromissos do cliente que criam um IP durável (como um aplicativo implantável e escalonável).

Há várias etapas manuais necessárias:

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

Criar GUIDs

Ao contrário das IDs de rastreamento 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 rastreamento. Um GUID é um identificador de referência exclusivo que tem 32 dígitos hexadecimais. Para criar GUIDs para acompanhamento, você deve usar um gerador de GUID, por exemplo, por meio do PowerShell:

[guid]::NewGuid()

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

Registrar GUIDs

Os GUIDs devem ser registrados no Partner Center para que possam ser associados a você como um parceiro:

  1. Entre no Partner Center.

  2. Inscreva-se como um editor do Marketplace comercial.

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

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

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

  6. Para registrar mais de um GUID, selecione Adicionar GUID de Rastreamento novamente. Caixas adicionais aparecerão na página.

  7. Selecione Salvar.

Adicionar um GUID para um modelo do Azure Resource Manager

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

  1. Abra o modelo do Resource Manager.

  2. Adicionar um novo tipo de recurso Microsoft.Resources/implantações no arquivo modelo principal. O recurso precisa estar no arquivo mainTemplate.json ou azuredeploy.json, não em nenhum modelo aninhado ou vinculado.

  3. Insira o valor de GUID após o pid- prefixo 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 o modelo para os erros.

  2. Republique o modelo nos repositórios apropriados.

  3. Verificar o sucesso da GUID na implantação de modelo.

Dica

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 as implantações acompanhadas 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 Resource Manager. O script não se aplica a implantações da API do Resource Manager nem 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 chamada "deploymentName") e o nome resourceGroupName da implantação são parâmetros obrigató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
}

Notificar os 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 <PARCEIRO> com o nome da sua empresa. Os parceiros devem certificar-se de que a notificação esteja alinhada com suas políticas de privacidade e coleta de dados, incluindo opções para os clientes serem excluídos do rastreamento.

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

Quando você implanta esse modelo, a Microsoft pode identificar a instalação do <PARCEIRO> software 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 coletados e regidos pelas políticas de privacidade da Microsoft, encontradas em https://www.microsoft.com/trustcenter.

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

Quando você implanta o software <PARCEIRO>, a Microsoft pode identificar a instalação do software <PARCEIRO> 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 coletados e regidos pelas políticas de privacidade da Microsoft, encontradas em https://www.microsoft.com/trustcenter.

Utilize APIs do Resource Manager

Em alguns casos, você pode fazer chamadas diretamente nas APIs REST do Gerenciador de Recursos para implantar os serviços do Azure. 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 criar suas chamadas à API, inclua seu Id de rastreamento no cabeçalho do agente do usuário na solicitação. Formatar 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 Marketplace comercial, use a ID de rastreamento fornecida no Partner Center. NÃO use um GUID.

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

Exemplo: SDK do Python

Para o Python, use o config atributo. 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 ter certeza de que todos os clientes estão rastreando. Para obter mais informações, consulte este exemplo de fábrica do cliente no GitHub.

Exemplo: SDK do .NET

Para o .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 Partner Center .NET foi arquivada. Você pode baixar a versão do SDK no GitHub, juntamente com um arquivo leiame 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")

Observação

Recomendamos que você use o módulo Az PowerShell do Azure para interagir com o Azure. Confira Instalar o Azure PowerShell para começar. Para saber como migrar para o módulo Az PowerShell, confira Migrar o Azure PowerShell do AzureRM para o Az.

Exemplo: CLI do Azure

Quando você usa a CLI do Azure para anexar 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 da shell:

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

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

Usar o Terraform

Suporte para Terraform está disponível por meio do Provedor do Azure 1.21.0 versão: 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 a solução via Terraform e 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. Nele, você especifica o GUID de acompanhamento que você usa 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 Terraform de recursos com um aplicativo do Azure no Marketplace comercial, use a ID de rastreamento completa fornecida no Partner Center. NÃO use um GUID.

Obter suporte

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

Como enviar uma solicitação de consultoria técnica

  1. Visite Serviços Técnicos do Parceiro.
  2. Selecione Infraestrutura e gerenciamento de nuvem para visualizar o percurso técnico.
  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. Conclua/revise as informações de contato no formulário que é aberto. 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 Enviar.

Veja as instruções passo a passo com capturas de tela em Using Technical Presales and Deployment Services (Uso dos serviços técnicos de pré-vendas e implantação).

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

Perguntas frequentes

Depois de um id de rastreamento ser adicionado, ele pode ser alterada?

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

Posso acompanhar modelos implantados de um repositório não Microsoft como o GitHub?

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

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

A Microsoft compartilha dados de Atribuição de Uso do Cliente com parceiros?

Não. 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ão. Os clientes podem acompanhar seu uso de todos os recursos ou grupos de recursos no portal do Azure. Os clientes não veem o uso dividido 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 com o IP que é reproduzível e passível de ser implantado por um parceiro a associação no momento da implantação. DPOR e PAL destinam-se a associar um parceiro de consultoria (integrador de sistemas) ou de gerenciamento (provedor de serviços gerenciados) à superfície do Azure relevante de um cliente para o tempo enquanto o parceiro está envolvido no cliente.