Portal Revision - Create Or Update

  • Reference
Service:
API Management
API Version:
2024-05-01

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=2024-05-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. The name is case insensitive.
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

uuid

The ID of the target subscription. The value must be an UUID.
api-version
 query True

string

The API version to use for this operation.

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
  • location: string
  • Azure-AsyncOperation: string
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/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
  }
}

Sample response

Status code:
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"
  }
}

Definitions

Name Description
ErrorAdditionalInfo

The resource management error additional info.
ErrorDetail

The error detail.
ErrorResponse

Error response
PortalRevisionContract

Portal Revision's contract details.
portalRevisionStatus

Status of the portal's revision.

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info

object

The additional info.
type

string

The additional info type.

ErrorDetail

The error detail.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.
code

string

The error code.
details

ErrorDetail[]

The error details.
message

string

The error message.
target

string

The error target.

ErrorResponse

Error response

Name Type Description
error

ErrorDetail

The error object.

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.provisioningState

string

The provisioning state
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.