Obter operações
Nota
As APIs do Cloud Partner Portal estão integradas e continuarão a funcionar no Partner Center. A transição introduz pequenas alterações. Analise as alterações listadas na Referência da API do Cloud Partner Portal para garantir que seu código continue funcionando após a transição para o Partner Center. As APIs de CPP só devem ser usadas para produtos existentes que já estavam integrados antes da transição para o Partner Center; novos produtos devem usar APIs de envio do Partner Center.
Recupera todas as operações na oferta ou para obter uma operação específica para o operationId especificado. O cliente pode usar parâmetros de consulta para filtrar operações em execução.
GET https://cloudpartner.azure.com/api/publishers/<publisherId>/offers/<offerId>/operations/<operationId>?api-version=2017-10-31
Parâmetros de URI
| Name | Descrição | Tipo de dados |
|---|---|---|
| editorId | Identificador do editor, por exemplo Contoso |
String |
| offerId | Identificador da oferta | String |
| operationId | GUID que identifica exclusivamente a operação na oferta. O operationId pode ser recuperado usando essa API e também é retornado no cabeçalho HTTP da resposta para qualquer operação de longa execução, como a API de oferta de publicação. | GUID |
| api-version | Versão mais recente da API | Date |
Cabeçalho
| Nome | Valor |
|---|---|
| Tipo de Conteúdo | application/json |
| Autorização | Bearer YOUR_TOKEN |
Exemplo de corpo
Response
Operações GET
[
{
"id": "5a63deb5-925b-4ee0-938b-7c86fbf287c5",
"offerId": "56615b67-2185-49fe-80d2-c4ddf77bb2e8",
"offerVersion": 1,
"offerTypeId": "microsoft-azure-virtualmachines",
"publisherId": "contoso",
"submissionType": "publish",
"submissionState": "running",
"publishingVersion": 2,
"slot": "staging",
"version": 636576975611768314,
"definition": {
"metadata": {
"emails": "jdoe@contoso.com"
}
},
"changedTime": "2018-03-26T21:46:01.179948Z"
}
]
Operação GET
[
{
"status" : "running",
"messages" : [],
"publishingVersion" : 2,
"offerVersion" : 1,
"cancellationRequestState": "canCancel",
"steps": [
{
"estimatedTimeFrame": "< 15 min",
"id": "displaydummycertify",
"stepName": "Validate Pre-Requisites",
"description": "Offer settings provided are validated",
"status": "complete",
"messages":
[
{
"messageHtml": "Step completed.",
"level": "information",
"timestamp": "2017-03-28T19:50:36.500052Z"
}
],
"progressPercentage": 100
},
{
"estimatedTimeFrame": "< 5 day",
"id": "displaycertify",
"stepName": "Certification",
"description": "Your offer is analyzed by our certification systems for issues.",
"status": "blocked",
"messages":
[
{
"messageHtml": "No virtual machine image was found for the plan contoso.",
"level": "error",
"timestamp": "2017-03-28T19:50:39.5506018Z"
},
{
"messageHtml": "This step has not started yet.",
"level": "information",
"timestamp": "2017-03-28T19:50:39.5506018Z"
}
],
"progressPercentage": 0
},
{
"estimatedTimeFrame": "< 1 day",
"id": "displayprovision",
"stepName": "Provisioning",
"description": "Your virtual machine is being replicated in our production systems.",
"status": "notStarted",
"messages": [],
"progressPercentage": 0
},
{
"estimatedTimeFrame": "< 1 hour",
"id": "displaypackage",
"stepName": "Packaging and Lead Generation Registration",
"description": "Your virtual machine is packaged for being shown to your customers. Additionally, we hookup our lead generation systems to send leads for your offer.",
"status": "notStarted",
"messages": [],
"progressPercentage": 0
},
{
"id": "publisher-signoff",
"stepName": "Publisher signoff",
"description": "Offer is available to preview. Ensure that everything looks good before making your offer live.",
"status": "notStarted",
"messages": [],
"progressPercentage": 0
},
{
"estimatedTimeFrame": "~2-5 days",
"id": "live",
"stepName": "Live",
"description": "Offer is publicly visible and is available for purchase.",
"status": "notStarted",
"messages": [],
"progressPercentage": 0
}
],
"previewLinks": [],
"liveLinks": [],
}
}
]
Propriedades do corpo de resposta
| Name | Descrição |
|---|---|
| id | GUID que identifica exclusivamente a operação |
| submissãoTipo | Identifica o tipo de operação que está sendo relatada para a oferta, por exemplo Publish/GoLive |
| createdDateTime | Data/hora UTC quando a operação foi criada |
| lastActionDateTime | Data/hora UTC em que a última atualização foi feita na operação |
| estado | Status da operação, ou not startedfailed | completedrunning | | . Apenas uma operação pode ter status running de cada vez. |
| error | Mensagem de erro para operações com falha |
Propriedades da etapa de resposta
| Name | Descrição |
|---|---|
| TimeFrame estimado | A duração estimada desta operação |
| id | O identificador exclusivo para o processo de etapa |
| descrição | Descrição do passo |
| Nome do passo | O nome amigável para o passo |
| estado | O status da etapa, ou notStarted | running | failed | completed |
| mensagens | Quaisquer notificações ou avisos encontrados durante a etapa. Matriz de cadeias |
| progressPercentagem | Um número inteiro de 0 a 100 indicando a progressão do passo |
Códigos de status de resposta
| Código | Descrição |
|---|---|
| 200 | OK - O pedido foi processado com sucesso e a(s) operação(ões) solicitada(s) foi(foram) devolvida(s). |
| 400 | Bad/Malformed request - O corpo da resposta de erro pode conter mais informações. |
| 403 | Forbidden - O cliente não tem acesso ao namespace especificado. |
| 404 | Not found - A entidade especificada não existe. |
Comentários
Brevemente: Ao longo de 2024, vamos descontinuar progressivamente o GitHub Issues como mecanismo de feedback para conteúdos e substituí-lo por um novo sistema de feedback. Para obter mais informações, veja: https://aka.ms/ContentUserFeedback.
Submeter e ver comentários