ProductWiki interface
Интерфейс, представляющий ProductWiki.
Методы
| create |
Создает новую вики-страницу для продукта или обновляет существующий. |
| delete(string, string, string, string, Product |
Удаляет указанный вики-сайт из продукта. |
| get(string, string, string, Product |
Возвращает сведения о вики-сайте для продукта, указанного его идентификатором. |
| get |
Возвращает версию состояния сущности (Etag) вики-сайта для продукта, указанного его идентификатором. |
| update(string, string, string, string, Wiki |
Обновления сведения о вики-сайте для продукта, указанного его идентификатором. |
Сведения о методе
createOrUpdate(string, string, string, WikiContract, ProductWikiCreateOrUpdateOptionalParams)
Создает новую вики-страницу для продукта или обновляет существующий.
function createOrUpdate(resourceGroupName: string, serviceName: string, productId: string, parameters: WikiContract, options?: ProductWikiCreateOrUpdateOptionalParams): Promise<ProductWikiCreateOrUpdateResponse>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Регистр букв в имени не учитывается.
- serviceName
-
string
Имя службы Управление API.
- productId
-
string
Идентификатор продукта. Должен быть уникальным в текущем экземпляре службы Управление API.
- parameters
- WikiContract
Создание параметров.
Параметры параметров.
Возвращаемое значение
Promise<ProductWikiCreateOrUpdateResponse>
delete(string, string, string, string, ProductWikiDeleteOptionalParams)
Удаляет указанный вики-сайт из продукта.
function delete(resourceGroupName: string, serviceName: string, productId: string, ifMatch: string, options?: ProductWikiDeleteOptionalParams): Promise<void>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Регистр букв в имени не учитывается.
- serviceName
-
string
Имя службы Управление API.
- productId
-
string
Идентификатор продукта. Должен быть уникальным в текущем экземпляре службы Управление API.
- ifMatch
-
string
ETag сущности. ETag должен соответствовать текущему состоянию сущности из ответа заголовка запроса GET или иметь значение * для безусловного обновления.
- options
- ProductWikiDeleteOptionalParams
Параметры параметров.
Возвращаемое значение
Promise<void>
get(string, string, string, ProductWikiGetOptionalParams)
Возвращает сведения о вики-сайте для продукта, указанного его идентификатором.
function get(resourceGroupName: string, serviceName: string, productId: string, options?: ProductWikiGetOptionalParams): Promise<ProductWikiGetResponse>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Регистр букв в имени не учитывается.
- serviceName
-
string
Имя службы Управление API.
- productId
-
string
Идентификатор продукта. Должен быть уникальным в текущем экземпляре службы Управление API.
- options
- ProductWikiGetOptionalParams
Параметры параметров.
Возвращаемое значение
Promise<ProductWikiGetResponse>
getEntityTag(string, string, string, ProductWikiGetEntityTagOptionalParams)
Возвращает версию состояния сущности (Etag) вики-сайта для продукта, указанного его идентификатором.
function getEntityTag(resourceGroupName: string, serviceName: string, productId: string, options?: ProductWikiGetEntityTagOptionalParams): Promise<ProductWikiGetEntityTagHeaders>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Регистр букв в имени не учитывается.
- serviceName
-
string
Имя службы Управление API.
- productId
-
string
Идентификатор продукта. Должен быть уникальным в текущем экземпляре службы Управление API.
Параметры параметров.
Возвращаемое значение
Promise<ProductWikiGetEntityTagHeaders>
update(string, string, string, string, WikiUpdateContract, ProductWikiUpdateOptionalParams)
Обновления сведения о вики-сайте для продукта, указанного его идентификатором.
function update(resourceGroupName: string, serviceName: string, productId: string, ifMatch: string, parameters: WikiUpdateContract, options?: ProductWikiUpdateOptionalParams): Promise<ProductWikiUpdateResponse>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Регистр букв в имени не учитывается.
- serviceName
-
string
Имя службы Управление API.
- productId
-
string
Идентификатор продукта. Должен быть уникальным в текущем экземпляре службы Управление API.
- ifMatch
-
string
ETag сущности. ETag должен соответствовать текущему состоянию сущности из ответа заголовка запроса GET или иметь значение * для безусловного обновления.
- parameters
- WikiUpdateContract
Параметры вики-обновления.
- options
- ProductWikiUpdateOptionalParams
Параметры параметров.
Возвращаемое значение
Promise<ProductWikiUpdateResponse>