Portal Revision - Create Or Update

Serviço:

API Management

Versão da API:

2024-05-01

Cria a revisão de um novo portal do desenvolvedor executando a publicação do portal. A propriedade isCurrent indica se a revisão é acessível publicamente.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/portalRevisions/{portalRevisionId}?api-version=2024-05-01

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
portalRevisionId	path	True	string minLength: 1 maxLength: 256	Identificador de revisão do portal. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	O nome do serviço de Gerenciamento de API.
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser um UUID.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Corpo do Pedido

Name	Tipo	Description
properties.description	string maxLength: 2000	Descrição da revisão do portal.
properties.isCurrent	boolean	Indica se a revisão do portal é pública.

Respostas

Name	Tipo	Description
201 Created	PortalRevisionContract	A revisão do portal do desenvolvedor foi criada com êxito. Cabeçalhos ETag: string location: string Azure-AsyncOperation: string
Other Status Codes	ErrorResponse	Resposta de erro descrevendo por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Ative Directory.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

ApiManagementCreatePortalRevision

Pedido de amostra

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalRevisions/20201112101010?api-version=2024-05-01

{
  "properties": {
    "description": "portal revision 1",
    "isCurrent": true
  }
}

Resposta da amostra

Código de estado:

201

location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalRevisions/20201112101010?api-version=2024-05-01&asyncId=5faf089b1d9a026694220e0c&asyncCode=201
Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5faf089b1d9a026694220e0c?api-version=2024-05-01

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalRevisions/20201112101010",
  "type": "Microsoft.ApiManagement/service/portalRevisions",
  "name": "20201112101010",
  "properties": {
    "description": "portal revision 1",
    "statusDetails": null,
    "status": "completed",
    "isCurrent": true,
    "createdDateTime": "2020-11-13T22:28:43.657Z",
    "updatedDateTime": "2020-11-13T22:29:22.68Z",
    "provisioningState": "InProgress"
  }
}

Definições

Name	Description
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
PortalRevisionContract	Detalhes do contrato da Revisão do Portal.
portalRevisionStatus	Situação da revisão do portal.

ErrorAdditionalInfo

Object

O erro de gerenciamento de recursos informações adicionais.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Object

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Object

Resposta de erro

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

PortalRevisionContract

Object

Detalhes do contrato da Revisão do Portal.

Name	Tipo	Description
id	string	ID de recurso totalmente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	O nome do recurso
properties.createdDateTime	string (date-time)	Data e hora de criação da revisão do portal.
properties.description	string maxLength: 2000	Descrição da revisão do portal.
properties.isCurrent	boolean	Indica se a revisão do portal é pública.
properties.provisioningState	string	O estado de provisionamento
properties.status	portalRevisionStatus	Situação da revisão do portal.
properties.statusDetails	string maxLength: 2000	Detalhes do status de publicação da revisão do portal.
properties.updatedDateTime	string (date-time)	Data e hora da última atualização.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

portalRevisionStatus

Enumeração

Situação da revisão do portal.

Valor	Description
completed	Publicação de revisão do portal concluída.
failed	Falha na publicação da revisão do portal.
pending	A revisão do portal foi enfileirada.
publishing	A revisão do portal está a ser publicada.