API de Ingestão de Produto para contêineres

Artigo
07/16/2024

A API de ingestão de produtos é uma API modernizada que unifica todas as APIs de envio existentes em todos os produtos do marketplace comercial. Consulte API de assimilação de produtos para obter detalhes sobre como começar.

Este artigo fornece diretrizes sobre como usar as APIs especificamente para contêineres.

Recuperar configurações de recurso existentes

Recupere todos os recursos de um produto específico em uma única chamada de API.

GET resource-tree/<product-durableID>?$version=<schema-version>

Você pode recuperar todas as configurações de recursos em um produto específico usando o tipo de recurso "árvore de recursos" junto com a ID durável do produto. A versão do esquema fornecida é usada como a versão máxima suportada para cada um dos recursos aplicáveis do produto solicitado.

Observação

Se você não souber a ID durável do produto, poderá recuperar o recurso do produto primeiro usando a ID externa do produto e executando. Para saber mais, consulte API do produto: Método 1: árvore de recursos.

Exemplo de chamada GET:

OBTER https://graph.microsoft.com/rp/product-ingestion/resource-tree/product/12345678-abcd-efgh-1234-12345678901?targetType=" visualização"&$version=2022-03-01-preview5

Resposta de exemplo:

{
  "$schema": "https://schema.mp.microsoft.com/schema/resource-tree/2022-03-01-preview2",
  "root": "product/12345678-abcd-efgh-1234-12345678901",
  "target": {
    "targetType": "preview"
  },
  "resources": [
  { 
    "$schema": "https://schema.mp.microsoft.com/schema/product/2022-03-01-preview3",
    "id": "product/12345678-abcd-efgh-1234-12345678901",
    "identity": {
      "externalID": "product_external_id_example"
    },
    "type": "azureContainer",
    "alias": "product_example"
  },
  { 
    "$schema": "https://schema.mp.microsoft.com/schema/commercial-marketplace-setup/2022-03-01-preview2",
    "id": "commercial-marketplace-setup/12345678-abcd-efgh-1234-12345678901",
    "product": "product/12345678-abcd-efgh-1234-12345678901",
    "sellThroughMicrosoft": true
  },
  {
    "$schema": "https://schema.mp.microsoft.com/schema/plan/2022-03-01-preview2",
    "id": "plan/12345678-abcd-efgh-1234-12345678901/98756328-04e9-55ae-9403-52b6c971a956
  ...
  }, 
     // The response would include all existing resources within this product.
  {
     ...
  }]
}

Sincronizar públicos-alvo privados

Para um produto ao vivo, as atualizações para audiências privadas nos ambientes de rascunho, visualização e ao vivo podem ser executadas ao mesmo tempo sem a necessidade de uma publicação. Você pode sincronizar o público privado usando o recurso "price-and-availability-update-private-audiences" especificando quais públicos você deseja adicionar ou remover de um plano específico. Isso sincronizará os ambientes de rascunho, visualização e ao vivo para ter os mesmos valores de público privado. Você não precisa fornecer o recurso de envio ao sincronizar o público-alvo privado.

Para editar os públicos de rascunho, use o recurso "price-and-availability-plan" e a propriedade "privateAudiences". Isso precisará passar pelo fluxo de publicação regular para que os valores sejam definidos na versão prévia e ao vivo.

Importante

Se o produto oferecer suporte a mais de um tipo de identificador para configurar o público-alvo privado (por exemplo, IDs de locatário e IDs de assinatura), você deve executar uma publicação completa caso esteja fornecendo um novo tipo de identificador pela primeira vez. Não é possível sincronizar o público privado nesse caso.

Solicitação de exemplo para sincronizar a configuração de público-alvo privado: