PortalRevision interface
Interface representing a PortalRevision.
Methods
Method Details
beginCreateOrUpdate(string, string, string, PortalRevisionContract, PortalRevisionCreateOrUpdateOptionalParams)
Creates a new developer portal's revision by running the portal's publishing. The isCurrent
property indicates if the revision is publicly accessible.
function beginCreateOrUpdate(resourceGroupName: string, serviceName: string, portalRevisionId: string, parameters: PortalRevisionContract, options?: PortalRevisionCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<PortalRevisionCreateOrUpdateResponse>, PortalRevisionCreateOrUpdateResponse>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- portalRevisionId
-
string
Portal revision identifier. Must be unique in the current API Management service instance.
- parameters
- PortalRevisionContract
Portal Revision's contract details.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<PortalRevisionCreateOrUpdateResponse>, PortalRevisionCreateOrUpdateResponse>>
beginCreateOrUpdateAndWait(string, string, string, PortalRevisionContract, PortalRevisionCreateOrUpdateOptionalParams)
Creates a new developer portal's revision by running the portal's publishing. The isCurrent
property indicates if the revision is publicly accessible.
function beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, portalRevisionId: string, parameters: PortalRevisionContract, options?: PortalRevisionCreateOrUpdateOptionalParams): Promise<PortalRevisionCreateOrUpdateResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- portalRevisionId
-
string
Portal revision identifier. Must be unique in the current API Management service instance.
- parameters
- PortalRevisionContract
Portal Revision's contract details.
The options parameters.
Returns
Promise<PortalRevisionCreateOrUpdateResponse>
beginUpdate(string, string, string, string, PortalRevisionContract, PortalRevisionUpdateOptionalParams)
Updates the description of specified portal revision or makes it current.
function beginUpdate(resourceGroupName: string, serviceName: string, portalRevisionId: string, ifMatch: string, parameters: PortalRevisionContract, options?: PortalRevisionUpdateOptionalParams): Promise<SimplePollerLike<OperationState<PortalRevisionUpdateResponse>, PortalRevisionUpdateResponse>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- portalRevisionId
-
string
Portal revision identifier. Must be unique in the current API Management service instance.
- ifMatch
-
string
ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
- parameters
- PortalRevisionContract
Portal Revision's contract details.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<PortalRevisionUpdateResponse>, PortalRevisionUpdateResponse>>
beginUpdateAndWait(string, string, string, string, PortalRevisionContract, PortalRevisionUpdateOptionalParams)
Updates the description of specified portal revision or makes it current.
function beginUpdateAndWait(resourceGroupName: string, serviceName: string, portalRevisionId: string, ifMatch: string, parameters: PortalRevisionContract, options?: PortalRevisionUpdateOptionalParams): Promise<PortalRevisionUpdateResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- portalRevisionId
-
string
Portal revision identifier. Must be unique in the current API Management service instance.
- ifMatch
-
string
ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
- parameters
- PortalRevisionContract
Portal Revision's contract details.
The options parameters.
Returns
Promise<PortalRevisionUpdateResponse>
get(string, string, string, PortalRevisionGetOptionalParams)
Gets the developer portal's revision specified by its identifier.
function get(resourceGroupName: string, serviceName: string, portalRevisionId: string, options?: PortalRevisionGetOptionalParams): Promise<PortalRevisionGetResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- portalRevisionId
-
string
Portal revision identifier. Must be unique in the current API Management service instance.
- options
- PortalRevisionGetOptionalParams
The options parameters.
Returns
Promise<PortalRevisionGetResponse>
getEntityTag(string, string, string, PortalRevisionGetEntityTagOptionalParams)
Gets the developer portal revision specified by its identifier.
function getEntityTag(resourceGroupName: string, serviceName: string, portalRevisionId: string, options?: PortalRevisionGetEntityTagOptionalParams): Promise<PortalRevisionGetEntityTagHeaders>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- portalRevisionId
-
string
Portal revision identifier. Must be unique in the current API Management service instance.
The options parameters.
Returns
Promise<PortalRevisionGetEntityTagHeaders>
listByService(string, string, PortalRevisionListByServiceOptionalParams)
Lists developer portal's revisions.
function listByService(resourceGroupName: string, serviceName: string, options?: PortalRevisionListByServiceOptionalParams): PagedAsyncIterableIterator<PortalRevisionContract, PortalRevisionContract[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
The options parameters.