PortalRevision | @azure/arm-apimanagement

Interface representing a PortalRevision.

Hierarchy

PortalRevision

Implemented by

PortalRevisionImpl

Index

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, serviceName: string, portalRevisionId: string, parameters: PortalRevisionContract, options?: PortalRevisionCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<PortalRevisionCreateOrUpdateResponse>, PortalRevisionCreateOrUpdateResponse>>

- Defined in operationsInterfaces/portalRevision.ts:76
Creates a new developer portal's revision by running the portal's publishing. The isCurrent property indicates if the revision is publicly accessible.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- 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.
- Optional options: PortalRevisionCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<PortalRevisionCreateOrUpdateResponse>, PortalRevisionCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, portalRevisionId: string, parameters: PortalRevisionContract, options?: PortalRevisionCreateOrUpdateOptionalParams): Promise<PortalRevisionCreateOrUpdateResponse>

- Defined in operationsInterfaces/portalRevision.ts:98
Creates a new developer portal's revision by running the portal's publishing. The isCurrent property indicates if the revision is publicly accessible.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- 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.
- Optional options: PortalRevisionCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<PortalRevisionCreateOrUpdateResponse>

beginUpdate

beginUpdate(resourceGroupName: string, serviceName: string, portalRevisionId: string, ifMatch: string, parameters: PortalRevisionContract, options?: PortalRevisionUpdateOptionalParams): Promise<PollerLike<PollOperationState<PortalRevisionUpdateResponse>, PortalRevisionUpdateResponse>>

- Defined in operationsInterfaces/portalRevision.ts:116
Updates the description of specified portal revision or makes it current.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- 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.
- Optional options: PortalRevisionUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<PortalRevisionUpdateResponse>, PortalRevisionUpdateResponse>>

beginUpdateAndWait

beginUpdateAndWait(resourceGroupName: string, serviceName: string, portalRevisionId: string, ifMatch: string, parameters: PortalRevisionContract, options?: PortalRevisionUpdateOptionalParams): Promise<PortalRevisionUpdateResponse>

- Defined in operationsInterfaces/portalRevision.ts:140
Updates the description of specified portal revision or makes it current.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- 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.
- Optional options: PortalRevisionUpdateOptionalParams
  
  The options parameters.
Returns Promise<PortalRevisionUpdateResponse>

get

get(resourceGroupName: string, serviceName: string, portalRevisionId: string, options?: PortalRevisionGetOptionalParams): Promise<PortalRevisionGetResponse>

- Defined in operationsInterfaces/portalRevision.ts:60
Gets the developer portal's revision specified by its identifier.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- portalRevisionId: string
  
  Portal revision identifier. Must be unique in the current API Management service instance.
- Optional options: PortalRevisionGetOptionalParams
  
  The options parameters.
Returns Promise<PortalRevisionGetResponse>

getEntityTag

getEntityTag(resourceGroupName: string, serviceName: string, portalRevisionId: string, options?: PortalRevisionGetEntityTagOptionalParams): Promise<PortalRevisionGetEntityTagResponse>

- Defined in operationsInterfaces/portalRevision.ts:46
Gets the developer portal revision specified by its identifier.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- portalRevisionId: string
  
  Portal revision identifier. Must be unique in the current API Management service instance.
- Optional options: PortalRevisionGetEntityTagOptionalParams
  
  The options parameters.
Returns Promise<PortalRevisionGetEntityTagResponse>

listByService

listByService(resourceGroupName: string, serviceName: string, options?: PortalRevisionListByServiceOptionalParams): PagedAsyncIterableIterator<PortalRevisionContract>

- Defined in operationsInterfaces/portalRevision.ts:33
Lists developer portal's revisions.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- Optional options: PortalRevisionListByServiceOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<PortalRevisionContract>

Hierarchy

Implemented by

Index

Methods

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

serviceName: string

portalRevisionId: string

parameters: PortalRevisionContract

Optional options: PortalRevisionCreateOrUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<PortalRevisionCreateOrUpdateResponse>, PortalRevisionCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

serviceName: string

portalRevisionId: string

parameters: PortalRevisionContract

Optional options: PortalRevisionCreateOrUpdateOptionalParams

Returns Promise<PortalRevisionCreateOrUpdateResponse>

beginUpdate

Parameters

resourceGroupName: string

serviceName: string

portalRevisionId: string

ifMatch: string

parameters: PortalRevisionContract

Optional options: PortalRevisionUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<PortalRevisionUpdateResponse>, PortalRevisionUpdateResponse>>

beginUpdateAndWait

Parameters

resourceGroupName: string

serviceName: string

portalRevisionId: string

ifMatch: string

parameters: PortalRevisionContract

Optional options: PortalRevisionUpdateOptionalParams

Returns Promise<PortalRevisionUpdateResponse>

get

Parameters

resourceGroupName: string

serviceName: string

portalRevisionId: string

Optional options: PortalRevisionGetOptionalParams

Returns Promise<PortalRevisionGetResponse>

getEntityTag

Parameters

resourceGroupName: string

serviceName: string

portalRevisionId: string

Optional options: PortalRevisionGetEntityTagOptionalParams

Returns Promise<PortalRevisionGetEntityTagResponse>

listByService

Parameters

resourceGroupName: string

serviceName: string

Optional options: PortalRevisionListByServiceOptionalParams

Returns PagedAsyncIterableIterator<PortalRevisionContract>