Preparing search index...
The search index is not available
azure-devops-node-api
azure-devops-node-api
ManagementApi
IManagementApi
Interface IManagementApi
interface
IManagementApi
{
baseUrl
:
string
;
http
:
HttpClient
;
rest
:
RestClient
;
userAgent
:
string
;
vsoClient
:
VsoClient
;
createAcceptHeader
(
type
:
string
,
apiVersion
?:
string
)
:
string
;
createBillingSnapshot
(
meterUsage
:
MeterUsage
)
:
Promise
<
void
>
;
createRequestOptions
(
type
:
string
,
apiVersion
?:
string
)
:
IRequestOptions
;
deleteBillingInfo
(
organizationId
:
string
)
:
Promise
<
void
>
;
deleteMeterUsageHistory
(
organizationId
:
string
)
:
Promise
<
void
>
;
formatResponse
(
data
:
any
,
responseTypeMetadata
:
any
,
isCollection
:
boolean
,
)
:
any
;
getBillableCommitterDetails
(
billingDate
?:
Date
,
)
:
Promise
<
BillableCommitterDetails
[]
>
;
getBillingInfo
(
organizationId
:
string
)
:
Promise
<
BillingInfo
>
;
getEstimatedOrgBillablePushers
()
:
Promise
<
string
[]
>
;
getEstimatedProjectBillablePushers
(
project
:
string
)
:
Promise
<
string
[]
>
;
getEstimatedRepoBillableCommitters
(
project
:
string
,
repository
:
string
,
)
:
Promise
<
string
[]
>
;
getLastMeterUsage
()
:
Promise
<
MeterUsage
>
;
getMeterUsage
(
billingDate
?:
Date
)
:
Promise
<
MeterUsage
>
;
getOrgEnablementStatus
(
includeAllProperties
?:
boolean
,
)
:
Promise
<
AdvSecEnablementSettings
>
;
getProjectEnablementStatus
(
project
:
string
,
includeAllProperties
?:
boolean
,
)
:
Promise
<
AdvSecEnablementSettings
>
;
getRepoEnablementStatus
(
project
:
string
,
repository
:
string
,
includeAllProperties
?:
boolean
,
)
:
Promise
<
AdvSecEnablementStatus
>
;
saveBillingInfo
(
billingInfo
:
BillingInfo
,
organizationId
:
string
,
)
:
Promise
<
void
>
;
updateOrgEnablementStatus
(
savedAdvSecEnablementStatus
:
AdvSecEnablementSettingsUpdate
,
)
:
Promise
<
void
>
;
updateProjectEnablementStatus
(
savedAdvSecEnablementStatus
:
AdvSecEnablementSettingsUpdate
,
project
:
string
,
)
:
Promise
<
void
>
;
updateRepoAdvSecEnablementStatus
(
savedAdvSecEnablementStatus
:
AdvSecEnablementStatusUpdate
,
project
:
string
,
repository
:
string
,
)
:
Promise
<
void
>
;
}
Hierarchy (
View Summary
)
ClientApiBase
IManagementApi
Implemented by
ManagementApi
Index
Properties
base
Url
http
rest
user
Agent
vso
Client
Methods
create
Accept
Header
create
Billing
Snapshot
create
Request
Options
delete
Billing
Info
delete
Meter
Usage
History
format
Response
get
Billable
Committer
Details
get
Billing
Info
get
Estimated
Org
Billable
Pushers
get
Estimated
Project
Billable
Pushers
get
Estimated
Repo
Billable
Committers
get
Last
Meter
Usage
get
Meter
Usage
get
Org
Enablement
Status
get
Project
Enablement
Status
get
Repo
Enablement
Status
save
Billing
Info
update
Org
Enablement
Status
update
Project
Enablement
Status
update
Repo
Adv
Sec
Enablement
Status
Properties
base
Url
baseUrl
:
string
http
http
:
HttpClient
rest
rest
:
RestClient
user
Agent
userAgent
:
string
vso
Client
vsoClient
:
VsoClient
Methods
create
Accept
Header
createAcceptHeader
(
type
:
string
,
apiVersion
?:
string
)
:
string
Parameters
type
:
string
Optional
apiVersion
:
string
Returns
string
create
Billing
Snapshot
createBillingSnapshot
(
meterUsage
:
MeterUsage
)
:
Promise
<
void
>
Parameters
meterUsage
:
MeterUsage
Returns
Promise
<
void
>
create
Request
Options
createRequestOptions
(
type
:
string
,
apiVersion
?:
string
)
:
IRequestOptions
Parameters
type
:
string
Optional
apiVersion
:
string
Returns
IRequestOptions
delete
Billing
Info
deleteBillingInfo
(
organizationId
:
string
)
:
Promise
<
void
>
Parameters
organizationId
:
string
Returns
Promise
<
void
>
delete
Meter
Usage
History
deleteMeterUsageHistory
(
organizationId
:
string
)
:
Promise
<
void
>
Parameters
organizationId
:
string
Returns
Promise
<
void
>
format
Response
formatResponse
(
data
:
any
,
responseTypeMetadata
:
any
,
isCollection
:
boolean
)
:
any
Parameters
data
:
any
responseTypeMetadata
:
any
isCollection
:
boolean
Returns
any
get
Billable
Committer
Details
getBillableCommitterDetails
(
billingDate
?:
Date
,
)
:
Promise
<
BillableCommitterDetails
[]
>
Parameters
Optional
billingDate
:
Date
Returns
Promise
<
BillableCommitterDetails
[]
>
get
Billing
Info
getBillingInfo
(
organizationId
:
string
)
:
Promise
<
BillingInfo
>
Parameters
organizationId
:
string
Returns
Promise
<
BillingInfo
>
get
Estimated
Org
Billable
Pushers
getEstimatedOrgBillablePushers
()
:
Promise
<
string
[]
>
Returns
Promise
<
string
[]
>
get
Estimated
Project
Billable
Pushers
getEstimatedProjectBillablePushers
(
project
:
string
)
:
Promise
<
string
[]
>
Parameters
project
:
string
Returns
Promise
<
string
[]
>
get
Estimated
Repo
Billable
Committers
getEstimatedRepoBillableCommitters
(
project
:
string
,
repository
:
string
,
)
:
Promise
<
string
[]
>
Parameters
project
:
string
repository
:
string
Returns
Promise
<
string
[]
>
get
Last
Meter
Usage
getLastMeterUsage
()
:
Promise
<
MeterUsage
>
Returns
Promise
<
MeterUsage
>
get
Meter
Usage
getMeterUsage
(
billingDate
?:
Date
)
:
Promise
<
MeterUsage
>
Parameters
Optional
billingDate
:
Date
Returns
Promise
<
MeterUsage
>
get
Org
Enablement
Status
getOrgEnablementStatus
(
includeAllProperties
?:
boolean
,
)
:
Promise
<
AdvSecEnablementSettings
>
Parameters
Optional
includeAllProperties
:
boolean
Returns
Promise
<
AdvSecEnablementSettings
>
get
Project
Enablement
Status
getProjectEnablementStatus
(
project
:
string
,
includeAllProperties
?:
boolean
,
)
:
Promise
<
AdvSecEnablementSettings
>
Parameters
project
:
string
Optional
includeAllProperties
:
boolean
Returns
Promise
<
AdvSecEnablementSettings
>
get
Repo
Enablement
Status
getRepoEnablementStatus
(
project
:
string
,
repository
:
string
,
includeAllProperties
?:
boolean
,
)
:
Promise
<
AdvSecEnablementStatus
>
Parameters
project
:
string
repository
:
string
Optional
includeAllProperties
:
boolean
Returns
Promise
<
AdvSecEnablementStatus
>
save
Billing
Info
saveBillingInfo
(
billingInfo
:
BillingInfo
,
organizationId
:
string
)
:
Promise
<
void
>
Parameters
billingInfo
:
BillingInfo
organizationId
:
string
Returns
Promise
<
void
>
update
Org
Enablement
Status
updateOrgEnablementStatus
(
savedAdvSecEnablementStatus
:
AdvSecEnablementSettingsUpdate
,
)
:
Promise
<
void
>
Parameters
savedAdvSecEnablementStatus
:
AdvSecEnablementSettingsUpdate
Returns
Promise
<
void
>
update
Project
Enablement
Status
updateProjectEnablementStatus
(
savedAdvSecEnablementStatus
:
AdvSecEnablementSettingsUpdate
,
project
:
string
,
)
:
Promise
<
void
>
Parameters
savedAdvSecEnablementStatus
:
AdvSecEnablementSettingsUpdate
project
:
string
Returns
Promise
<
void
>
update
Repo
Adv
Sec
Enablement
Status
updateRepoAdvSecEnablementStatus
(
savedAdvSecEnablementStatus
:
AdvSecEnablementStatusUpdate
,
project
:
string
,
repository
:
string
,
)
:
Promise
<
void
>
Parameters
savedAdvSecEnablementStatus
:
AdvSecEnablementStatusUpdate
project
:
string
repository
:
string
Returns
Promise
<
void
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
base
Url
http
rest
user
Agent
vso
Client
Methods
create
Accept
Header
create
Billing
Snapshot
create
Request
Options
delete
Billing
Info
delete
Meter
Usage
History
format
Response
get
Billable
Committer
Details
get
Billing
Info
get
Estimated
Org
Billable
Pushers
get
Estimated
Project
Billable
Pushers
get
Estimated
Repo
Billable
Committers
get
Last
Meter
Usage
get
Meter
Usage
get
Org
Enablement
Status
get
Project
Enablement
Status
get
Repo
Enablement
Status
save
Billing
Info
update
Org
Enablement
Status
update
Project
Enablement
Status
update
Repo
Adv
Sec
Enablement
Status
azure-devops-node-api
Loading...