GroupImpl | @azure/arm-apimanagement

Class containing Group operations.

Hierarchy

GroupImpl

Implements

Group

Index

Constructors

constructor

Methods

Constructors

constructor

new GroupImpl(client: ApiManagementClientContext): GroupImpl

- Defined in operations/group.ts:37
Initialize a new instance of the class Group class.

Parameters
- client: ApiManagementClientContext
  
  Reference to the service client
Returns GroupImpl

Methods

createOrUpdate

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

Implementation of Group.createOrUpdate
- Defined in operations/group.ts:181
Creates or Updates a group.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- groupId: string
  
  Group identifier. Must be unique in the current API Management service instance.
- parameters: GroupCreateParameters
  
  Create parameters.
- Optional options: GroupCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<GroupCreateOrUpdateResponse>

delete

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

Implementation of Group.delete
- Defined in operations/group.ts:227
Deletes specific group of the API Management service instance.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- groupId: string
  
  Group 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.
- Optional options: GroupDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

get

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

Implementation of Group.get
- Defined in operations/group.ts:161
Gets the details of the group specified by its identifier.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- groupId: string
  
  Group identifier. Must be unique in the current API Management service instance.
- Optional options: GroupGetOptionalParams
  
  The options parameters.
Returns Promise<GroupGetResponse>

getEntityTag

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

Implementation of Group.getEntityTag
- Defined in operations/group.ts:142
Gets the entity state (Etag) version of the group specified by its identifier.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- groupId: string
  
  Group identifier. Must be unique in the current API Management service instance.
- Optional options: GroupGetEntityTagOptionalParams
  
  The options parameters.
Returns Promise<GroupGetEntityTagResponse>

listByService

listByService(resourceGroupName: string, serviceName: string, options?: GroupListByServiceOptionalParams): PagedAsyncIterableIterator<GroupContract>

Implementation of Group.listByService
- Defined in operations/group.ts:53
Lists a collection of groups defined within a service instance.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- Optional options: GroupListByServiceOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<GroupContract>

update

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

Implementation of Group.update
- Defined in operations/group.ts:204
Updates the details of the group specified by its identifier.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- groupId: string
  
  Group 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: GroupUpdateParameters
  
  Update parameters.
- Optional options: GroupUpdateOptionalParams
  
  The options parameters.
Returns Promise<GroupUpdateResponse>

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

client: ApiManagementClientContext

Returns GroupImpl

Methods

createOrUpdate

Parameters

resourceGroupName: string

serviceName: string

groupId: string

parameters: GroupCreateParameters

Optional options: GroupCreateOrUpdateOptionalParams

Returns Promise<GroupCreateOrUpdateResponse>

delete

Parameters

resourceGroupName: string

serviceName: string

groupId: string

ifMatch: string

Optional options: GroupDeleteOptionalParams

Returns Promise<void>

get

Parameters

resourceGroupName: string

serviceName: string

groupId: string

Optional options: GroupGetOptionalParams

Returns Promise<GroupGetResponse>

getEntityTag

Parameters

resourceGroupName: string

serviceName: string

groupId: string

Optional options: GroupGetEntityTagOptionalParams

Returns Promise<GroupGetEntityTagResponse>

listByService

Parameters

resourceGroupName: string

serviceName: string

Optional options: GroupListByServiceOptionalParams

Returns PagedAsyncIterableIterator<GroupContract>

update

Parameters

resourceGroupName: string

serviceName: string

groupId: string

ifMatch: string

parameters: GroupUpdateParameters

Optional options: GroupUpdateOptionalParams

Returns Promise<GroupUpdateResponse>