Class GroupEntitlementsApi

Hierarchy

GroupEntitlementsApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new GroupEntitlementsApi(basePath?: string): GroupEntitlementsApi

- Defined in api/api.ts:45814
Parameters
- Optional basePath: string
Returns GroupEntitlementsApi

Properties

Protected basePath

basePath: string = "https://dev.azure.com/"

defaultHeaders

defaultHeaders: any

Methods

addGroupEntitlement

addGroupEntitlement(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<GroupEntitlementOperationReference>

- Defined in api/api.ts:45830
Create a group entitlement with license rule, extension rule.

Parameters
- params: object
  - apiVersion: string
  - body: GroupEntitlement
  - organization: string
  - Optional ruleOption?: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<GroupEntitlementOperationReference>

deleteGroupEntitlement

deleteGroupEntitlement(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<GroupEntitlementOperationReference>

- Defined in api/api.ts:45890
Delete a group entitlement.

Parameters
- params: object
  - apiVersion: string
  - groupId: string
  - organization: string
  - Optional removeGroupMembership?: boolean
  - Optional ruleOption?: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<GroupEntitlementOperationReference>

getGroupEntitlement

getGroupEntitlement(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<GroupEntitlement>

- Defined in api/api.ts:45950
Get a group entitlement. If the group entitlement does not exist, returns null.

Parameters
- params: object
  - apiVersion: string
  - groupId: string
  - organization: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<GroupEntitlement>

getGroupEntitlements

getGroupEntitlements(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ArrayWrapper<GroupEntitlement>>

- Defined in api/api.ts:46001
Get the group entitlements for an account.

Parameters
- params: object
  - apiVersion: string
  - organization: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<ArrayWrapper<GroupEntitlement>>

updateGroupEntitlement

updateGroupEntitlement(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<GroupEntitlementOperationReference>

- Defined in api/api.ts:46050
Update entitlements (License Rule, Extensions Rule, Project memberships etc.) for a group.

Parameters
- params: object
  - apiVersion: string
  - body: JsonPatchDocument
  - groupId: string
  - organization: string
  - Optional ruleOption?: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<GroupEntitlementOperationReference>

Generated using TypeDoc