Portal Revision - Create Or Update

Creates a new developer portal's revision by running the portal's publishing. The isCurrent property indicates if the revision is publicly accessible.

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

URI Parameters

Name In Required Type Description
portalRevisionId
path True

string

Portal revision identifier. Must be unique in the current API Management service instance.

resourceGroupName
path True

string

The name of the resource group.

serviceName
path True

string

The name of the API Management service.

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

api-version
query True

string

Version of the API to be used with the client request.

Request Body

Name Type Description
properties.description

string

Portal revision description.

properties.isCurrent

boolean

Indicates if the portal's revision is public.

Responses

Name Type Description
201 Created

PortalRevisionContract

The developer portal revision was successfully created.

Headers

ETag: string

202 Accepted

Request to create a developer portal revision was accepted.

Other Status Codes

ErrorResponse

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

ApiManagementCreatePortalRevision

Sample request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalRevisions/20201112101010?api-version=2021-08-01

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

Sample response

location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalRevisions/20201112101010?api-version=2021-08-01&asyncId=5faf089b1d9a026694220e0c&asyncCode=201
{
  "id": "/subscriptions/subid/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"
  }
}

Definitions

Name Description
ErrorFieldContract

Error Field contract.

ErrorResponse

Error Response.

PortalRevisionContract

Portal Revision's contract details.

portalRevisionStatus

Status of the portal's revision.

ErrorFieldContract

Error Field contract.

Name Type Description
code

string

Property level error code.

message

string

Human-readable representation of property-level error.

target

string

Property name.

ErrorResponse

Error Response.

Name Type Description
error.code

string

Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.

error.details

ErrorFieldContract[]

The list of invalid fields send in request, in case of validation error.

error.message

string

Human-readable representation of the error.

PortalRevisionContract

Portal Revision's contract details.

Name Type Description
id

string

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

The name of the resource

properties.createdDateTime

string

Portal's revision creation date and time.

properties.description

string

Portal revision description.

properties.isCurrent

boolean

Indicates if the portal's revision is public.

properties.status

portalRevisionStatus

Status of the portal's revision.

properties.statusDetails

string

Portal revision publishing status details.

properties.updatedDateTime

string

Last updated date and time.

type

string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

portalRevisionStatus

Status of the portal's revision.

Name Type Description
completed

string

Portal's revision publishing completed.

failed

string

Portal's revision publishing failed.

pending

string

Portal's revision has been queued.

publishing

string

Portal's revision is being published.