Group interface

Paquete:

@azure/arm-apimanagement

Interfaz que representa un grupo.

Métodos

createOrUpdate(string, string, string, GroupCreateParameters, GroupCreateOrUpdateOptionalParams)	Crea o actualiza un grupo
delete(string, string, string, string, GroupDeleteOptionalParams)	Elimina el grupo especificado de la instancia del servicio API Management.
get(string, string, string, GroupGetOptionalParams)	Obtiene los detalles del grupo especificado por su identificador.
getEntityTag(string, string, string, GroupGetEntityTagOptionalParams)	Obtiene la versión del estado de entidad (Etag) del grupo especificado por su identificador.
listByService(string, string, GroupListByServiceOptionalParams)	Enumera una colección de grupos definidos en una instancia de servicio
update(string, string, string, string, GroupUpdateParameters, GroupUpdateOptionalParams)	Novedades los detalles del grupo especificado por su identificador.

Detalles del método

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

Crea o actualiza un grupo

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

groupId

string

Identificador de grupo. Debe ser único en la instancia de servicio de API Management actual.

parameters

GroupCreateParameters

Cree parámetros.

options

GroupCreateOrUpdateOptionalParams

Parámetros de opciones.

Devoluciones

Promise<GroupCreateOrUpdateResponse>

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

Elimina el grupo especificado de la instancia del servicio API Management.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

groupId

string

Identificador de grupo. Debe ser único en la instancia de servicio de API Management actual.

ifMatch

string

ETag de la entidad. ETag debe coincidir con el estado de entidad actual de la respuesta de encabezado de la solicitud GET o debe ser * para la actualización incondicional.

options

GroupDeleteOptionalParams

Parámetros de opciones.

Devoluciones

Promise<void>

get(string, string, string, GroupGetOptionalParams)

Obtiene los detalles del grupo especificado por su identificador.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

groupId

string

Identificador de grupo. Debe ser único en la instancia de servicio de API Management actual.

options

GroupGetOptionalParams

Parámetros de opciones.

Devoluciones

Promise<GroupGetResponse>

getEntityTag(string, string, string, GroupGetEntityTagOptionalParams)

Obtiene la versión del estado de entidad (Etag) del grupo especificado por su identificador.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

groupId

string

Identificador de grupo. Debe ser único en la instancia de servicio de API Management actual.

options

GroupGetEntityTagOptionalParams

Parámetros de opciones.

Devoluciones

Promise<GroupGetEntityTagHeaders>

listByService(string, string, GroupListByServiceOptionalParams)

Enumera una colección de grupos definidos en una instancia de servicio

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

options

GroupListByServiceOptionalParams

Parámetros de opciones.

Devoluciones

PagedAsyncIterableIterator<GroupContract, GroupContract[], PageSettings>

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

Novedades los detalles del grupo especificado por su identificador.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

groupId

string

Identificador de grupo. Debe ser único en la instancia de servicio de API Management actual.

ifMatch

string

ETag de la entidad. ETag debe coincidir con el estado de entidad actual de la respuesta de encabezado de la solicitud GET o debe ser * para la actualización incondicional.

parameters

GroupUpdateParameters

Actualice los parámetros.

options

GroupUpdateOptionalParams

Parámetros de opciones.

Devoluciones

Promise<GroupUpdateResponse>