Group interface

Пакет:

@azure/arm-apimanagement

Интерфейс, представляющий группу.

Методы

createOrUpdate(string, string, string, GroupCreateParameters, GroupCreateOrUpdateOptionalParams)	Создает или изменяет группу.
delete(string, string, string, string, GroupDeleteOptionalParams)	Удаляет определенную группу экземпляра службы управления API.
get(string, string, string, GroupGetOptionalParams)	Возвращает сведения о группе, указанной ее идентификатором.
getEntityTag(string, string, string, GroupGetEntityTagOptionalParams)	Возвращает версию состояния сущности (Etag) группы, указанной ее идентификатором.
listByService(string, string, GroupListByServiceOptionalParams)	Возвращает коллекцию групп в указанном экземпляре службы.
update(string, string, string, string, GroupUpdateParameters, GroupUpdateOptionalParams)	Обновления сведения о группе, указанной ее идентификатором.

Сведения о методе

createOrUpdate(string, string, string, GroupCreateParameters, GroupCreateOrUpdateOptionalParams)

Создает или изменяет группу.

function createOrUpdate(resourceGroupName: string, serviceName: string, groupId: string, parameters: GroupCreateParameters, options?: GroupCreateOrUpdateOptionalParams): Promise<GroupCreateOrUpdateResponse>

Параметры

resourceGroupName

string

Имя группы ресурсов. Регистр букв в имени не учитывается.

serviceName

string

Имя службы Управление API.

groupId

string

Идентификатор группы. Должен быть уникальным в текущем экземпляре службы Управление API.

parameters

GroupCreateParameters

Создайте параметры.

options

GroupCreateOrUpdateOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<GroupCreateOrUpdateResponse>

delete(string, string, string, string, GroupDeleteOptionalParams)

Удаляет определенную группу экземпляра службы управления API.

function delete(resourceGroupName: string, serviceName: string, groupId: string, ifMatch: string, options?: GroupDeleteOptionalParams): Promise<void>

Параметры

resourceGroupName

string

Имя группы ресурсов. Регистр букв в имени не учитывается.

serviceName

string

Имя службы Управление API.

groupId

string

Идентификатор группы. Должен быть уникальным в текущем экземпляре службы Управление API.

ifMatch

string

ETag сущности. ETag должен соответствовать текущему состоянию сущности из ответа заголовка запроса GET или иметь значение * для безусловного обновления.

options

GroupDeleteOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<void>

get(string, string, string, GroupGetOptionalParams)

Возвращает сведения о группе, указанной ее идентификатором.

function get(resourceGroupName: string, serviceName: string, groupId: string, options?: GroupGetOptionalParams): Promise<GroupGetResponse>

Параметры

resourceGroupName

string

Имя группы ресурсов. Регистр букв в имени не учитывается.

serviceName

string

Имя службы Управление API.

groupId

string

Идентификатор группы. Должен быть уникальным в текущем экземпляре службы Управление API.

options

GroupGetOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<GroupGetResponse>

getEntityTag(string, string, string, GroupGetEntityTagOptionalParams)

Возвращает версию состояния сущности (Etag) группы, указанной ее идентификатором.

function getEntityTag(resourceGroupName: string, serviceName: string, groupId: string, options?: GroupGetEntityTagOptionalParams): Promise<GroupGetEntityTagHeaders>

Параметры

resourceGroupName

string

Имя группы ресурсов. Регистр букв в имени не учитывается.

serviceName

string

Имя службы Управление API.

groupId

string

Идентификатор группы. Должен быть уникальным в текущем экземпляре службы Управление API.

options

GroupGetEntityTagOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<GroupGetEntityTagHeaders>

listByService(string, string, GroupListByServiceOptionalParams)

Возвращает коллекцию групп в указанном экземпляре службы.

function listByService(resourceGroupName: string, serviceName: string, options?: GroupListByServiceOptionalParams): PagedAsyncIterableIterator<GroupContract, GroupContract[], PageSettings>

Параметры

resourceGroupName

string

Имя группы ресурсов. Регистр букв в имени не учитывается.

serviceName

string

Имя службы Управление API.

options

GroupListByServiceOptionalParams

Параметры параметров.

Возвращаемое значение

PagedAsyncIterableIterator<GroupContract, GroupContract[], PageSettings>

update(string, string, string, string, GroupUpdateParameters, GroupUpdateOptionalParams)

Обновления сведения о группе, указанной ее идентификатором.

function update(resourceGroupName: string, serviceName: string, groupId: string, ifMatch: string, parameters: GroupUpdateParameters, options?: GroupUpdateOptionalParams): Promise<GroupUpdateResponse>

Параметры

resourceGroupName

string

Имя группы ресурсов. Регистр букв в имени не учитывается.

serviceName

string

Имя службы Управление API.

groupId

string

Идентификатор группы. Должен быть уникальным в текущем экземпляре службы Управление API.

ifMatch

string

ETag сущности. ETag должен соответствовать текущему состоянию сущности из ответа заголовка запроса GET или иметь значение * для безусловного обновления.

parameters

GroupUpdateParameters

Обновление параметров.

options

GroupUpdateOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<GroupUpdateResponse>