ProductWiki interface
Interface representing a ProductWiki.
Methods
create |
Creates a new Wiki for a Product or updates an existing one. |
delete(string, string, string, string, Product |
Deletes the specified Wiki from a Product. |
get(string, string, string, Product |
Gets the details of the Wiki for a Product specified by its identifier. |
get |
Gets the entity state (Etag) version of the Wiki for a Product specified by its identifier. |
update(string, string, string, string, Wiki |
Updates the details of the Wiki for a Product specified by its identifier. |
Method Details
createOrUpdate(string, string, string, WikiContract, ProductWikiCreateOrUpdateOptionalParams)
Creates a new Wiki for a Product or updates an existing one.
function createOrUpdate(resourceGroupName: string, serviceName: string, productId: string, parameters: WikiContract, options?: ProductWikiCreateOrUpdateOptionalParams): Promise<ProductWikiCreateOrUpdateResponse>
Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- productId
-
string
Product identifier. Must be unique in the current API Management service instance.
- parameters
- WikiContract
Create parameters.
The options parameters.
Returns
Promise<ProductWikiCreateOrUpdateResponse>
delete(string, string, string, string, ProductWikiDeleteOptionalParams)
Deletes the specified Wiki from a Product.
function delete(resourceGroupName: string, serviceName: string, productId: string, ifMatch: string, options?: ProductWikiDeleteOptionalParams): Promise<void>
Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- productId
-
string
Product 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.
- options
- ProductWikiDeleteOptionalParams
The options parameters.
Returns
Promise<void>
get(string, string, string, ProductWikiGetOptionalParams)
Gets the details of the Wiki for a Product specified by its identifier.
function get(resourceGroupName: string, serviceName: string, productId: string, options?: ProductWikiGetOptionalParams): Promise<ProductWikiGetResponse>
Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- productId
-
string
Product identifier. Must be unique in the current API Management service instance.
- options
- ProductWikiGetOptionalParams
The options parameters.
Returns
Promise<ProductWikiGetResponse>
getEntityTag(string, string, string, ProductWikiGetEntityTagOptionalParams)
Gets the entity state (Etag) version of the Wiki for a Product specified by its identifier.
function getEntityTag(resourceGroupName: string, serviceName: string, productId: string, options?: ProductWikiGetEntityTagOptionalParams): Promise<ProductWikiGetEntityTagHeaders>
Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- productId
-
string
Product identifier. Must be unique in the current API Management service instance.
The options parameters.
Returns
Promise<ProductWikiGetEntityTagHeaders>
update(string, string, string, string, WikiUpdateContract, ProductWikiUpdateOptionalParams)
Updates the details of the Wiki for a Product specified by its identifier.
function update(resourceGroupName: string, serviceName: string, productId: string, ifMatch: string, parameters: WikiUpdateContract, options?: ProductWikiUpdateOptionalParams): Promise<ProductWikiUpdateResponse>
Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- productId
-
string
Product 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
- WikiUpdateContract
Wiki Update parameters.
- options
- ProductWikiUpdateOptionalParams
The options parameters.
Returns
Promise<ProductWikiUpdateResponse>