Org Meter Usage Estimate - Get
Estimate the pushers that would be added to the customer's usage if Advanced Security was enabled for this organization.
GET https://advsec.dev.azure.com/{organization}/_apis/management/meterUsageEstimate/default?api-version=7.2-preview.3GET https://advsec.dev.azure.com/{organization}/_apis/management/meterUsageEstimate/default?plan={plan}&api-version=7.2-preview.3URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
|
organization
|
path | True |
string |
The name of the Azure DevOps organization. |
|
api-version
|
query | True |
string |
Version of the API to use. This should be set to '7.2-preview.3' to use this version of the api. |
|
plan
|
query |
The plan to query. |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK |
successful operation |
Security
oauth2
Type:
oauth2
Flow:
accessCode
Authorization URL:
https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL:
https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer
Scopes
| Name | Description |
|---|---|
| vso.advsec | Grants the ability to read alerts, result instances, analysis result instances |
Definitions
| Name | Description |
|---|---|
|
Billed |
Information related to billed committers using Advanced Security services |
|
Billed |
A list of billed committers |
|
Identity |
|
|
Meter |
Information related to meter usage estimate for Code Security plan and/or Secret Protection plan |
| Plan |
The plan to query. |
|
Reference |
The class to represent a collection of REST reference links. |
BilledCommitter
Information related to billed committers using Advanced Security services
| Name | Type | Description |
|---|---|---|
| cuid |
string (uuid) |
Cuid of the billed committer. CUID is unique across an Azure Subscription. |
| userIdentity |
Identity Reference object of the billed committer |
BilledCommittersList
A list of billed committers
| Name | Type | Description |
|---|---|---|
| billedUsers |
A list of BilledCommitter objects that contain the identityRef of committers. |
|
| uniqueCommitterCount |
integer (int32) |
Count of billed committers in BilledUsers |
IdentityRef
| Name | Type | Description |
|---|---|---|
| _links |
This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject. |
|
| descriptor |
string |
The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations. |
| directoryAlias |
string |
Deprecated - Can be retrieved by querying the Graph user referenced in the "self" entry of the IdentityRef "_links" dictionary |
| displayName |
string |
This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider. |
| id |
string |
|
| imageUrl |
string |
Deprecated - Available in the "avatar" entry of the IdentityRef "_links" dictionary |
| inactive |
boolean |
Deprecated - Can be retrieved by querying the Graph membership state referenced in the "membershipState" entry of the GraphUser "_links" dictionary |
| isAadIdentity |
boolean |
Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType) |
| isContainer |
boolean |
Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType) |
| isDeletedInOrigin |
boolean |
|
| profileUrl |
string |
Deprecated - not in use in most preexisting implementations of ToIdentityRef |
| uniqueName |
string |
Deprecated - use Domain+PrincipalName instead |
| url |
string |
This url is the full route to the source resource of this graph subject. |
MeterUsageEstimate
Information related to meter usage estimate for Code Security plan and/or Secret Protection plan
| Name | Type | Description |
|---|---|---|
| codeSecurityMeterUsageEstimate |
Meter usage estimate when enabling Code Security plan |
|
| secretProtectionMeterUsageEstimate |
Meter usage estimate when enabling Secret Protection plan |
Plan
The plan to query.
| Value | Description |
|---|---|
| codeSecurity |
The Code Security plan |
| secretProtection |
The Secret Protection plan |
| all |
Include all plans |
ReferenceLinks
The class to represent a collection of REST reference links.
| Name | Type | Description |
|---|---|---|
| links |
object |
The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only. |