PortalConfig interface
Interface representing a PortalConfig.
Methods
| create |
Create or update the developer portal configuration. |
| get(string, string, string, Portal |
Get the developer portal configuration. |
| get |
Gets the entity state (Etag) version of the developer portal configuration. |
| list |
Lists the developer portal configurations. |
| update(string, string, string, string, Portal |
Update the developer portal configuration. |
Method Details
createOrUpdate(string, string, string, string, PortalConfigContract, PortalConfigCreateOrUpdateOptionalParams)
Create or update the developer portal configuration.
function createOrUpdate(resourceGroupName: string, serviceName: string, portalConfigId: string, ifMatch: string, parameters: PortalConfigContract, options?: PortalConfigCreateOrUpdateOptionalParams): Promise<PortalConfigContract>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- portalConfigId
-
string
Portal configuration identifier.
- 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
- PortalConfigContract
Update the developer portal configuration.
The options parameters.
Returns
Promise<PortalConfigContract>
get(string, string, string, PortalConfigGetOptionalParams)
Get the developer portal configuration.
function get(resourceGroupName: string, serviceName: string, portalConfigId: string, options?: PortalConfigGetOptionalParams): Promise<PortalConfigGetResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- portalConfigId
-
string
Portal configuration identifier.
- options
- PortalConfigGetOptionalParams
The options parameters.
Returns
Promise<PortalConfigGetResponse>
getEntityTag(string, string, string, PortalConfigGetEntityTagOptionalParams)
Gets the entity state (Etag) version of the developer portal configuration.
function getEntityTag(resourceGroupName: string, serviceName: string, portalConfigId: string, options?: PortalConfigGetEntityTagOptionalParams): Promise<PortalConfigGetEntityTagHeaders>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- portalConfigId
-
string
Portal configuration identifier.
The options parameters.
Returns
Promise<PortalConfigGetEntityTagHeaders>
listByService(string, string, PortalConfigListByServiceOptionalParams)
Lists the developer portal configurations.
function listByService(resourceGroupName: string, serviceName: string, options?: PortalConfigListByServiceOptionalParams): Promise<PortalConfigCollection>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.
Returns
Promise<PortalConfigCollection>
update(string, string, string, string, PortalConfigContract, PortalConfigUpdateOptionalParams)
Update the developer portal configuration.
function update(resourceGroupName: string, serviceName: string, portalConfigId: string, ifMatch: string, parameters: PortalConfigContract, options?: PortalConfigUpdateOptionalParams): Promise<PortalConfigContract>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- portalConfigId
-
string
Portal configuration identifier.
- 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
- PortalConfigContract
Update the developer portal configuration.
- options
- PortalConfigUpdateOptionalParams
The options parameters.
Returns
Promise<PortalConfigContract>