licensing

Documentation

Index

• Variables
• type AccessLevel
• type AccountEntitlement
• type AccountEntitlementUpdateModel
• type AccountLicense
• type AccountLicenseExtensionUsage
• type AccountLicenseType
• type AccountRights
• type AccountUserLicense
• type AssignmentSource
• type AutoLicense
• type ClientRightsContainer
• type ExtensionAssignment
• type ExtensionSource
• type License
• type LicensingOrigin
• type LicensingSettingsSelectProperty
• type LicensingSource
• type MsdnLicense
• type MsdnLicenseType
• type NoLicense
• type VisualStudioOnlineServiceLevel

Variables

var AccountLicenseTypeValues = accountLicenseTypeValuesType{
	None:         "none",
	EarlyAdopter: "earlyAdopter",
	Express:      "express",
	Professional: "professional",
	Advanced:     "advanced",
	Stakeholder:  "stakeholder",
}

var AssignmentSourceValues = assignmentSourceValuesType{
	None:      "none",
	Unknown:   "unknown",
	GroupRule: "groupRule",
}

var LicensingOriginValues = licensingOriginValuesType{
	None:                     "none",
	OnDemandPrivateProject:   "onDemandPrivateProject",
	OnDemandPublicProject:    "onDemandPublicProject",
	UserHubInvitation:        "userHubInvitation",
	PrivateProjectInvitation: "privateProjectInvitation",
	PublicProjectInvitation:  "publicProjectInvitation",
}

var LicensingSettingsSelectPropertyValues = licensingSettingsSelectPropertyValuesType{
	DefaultAccessLevel: "defaultAccessLevel",
	AccessLevelOptions: "accessLevelOptions",
	All:                "all",
}

var LicensingSourceValues = licensingSourceValuesType{
	None:    "none",
	Account: "account",
	Msdn:    "msdn",
	Profile: "profile",
	Auto:    "auto",
	Trial:   "trial",
}

var MsdnLicenseTypeValues = msdnLicenseTypeValuesType{
	None:             "none",
	Eligible:         "eligible",
	Professional:     "professional",
	Platforms:        "platforms",
	TestProfessional: "testProfessional",
	Premium:          "premium",
	Ultimate:         "ultimate",
	Enterprise:       "enterprise",
}

var VisualStudioOnlineServiceLevelValues = visualStudioOnlineServiceLevelValuesType{

	None: "none",

	Express: "express",

	Advanced: "advanced",

	AdvancedPlus: "advancedPlus",

	Stakeholder: "stakeholder",
}

Types

type AccessLevel

type AccessLevel struct {
	// Type of Account License (e.g. Express, Stakeholder etc.)
	AccountLicenseType *AccountLicenseType `json:"accountLicenseType,omitempty"`
	// Assignment Source of the License (e.g. Group, Unknown etc.
	AssignmentSource *AssignmentSource `json:"assignmentSource,omitempty"`
	// Display name of the License
	LicenseDisplayName *string `json:"licenseDisplayName,omitempty"`
	// Licensing Source (e.g. Account. MSDN etc.)
	LicensingSource *LicensingSource `json:"licensingSource,omitempty"`
	// Type of MSDN License (e.g. Visual Studio Professional, Visual Studio Enterprise etc.)
	MsdnLicenseType *MsdnLicenseType `json:"msdnLicenseType,omitempty"`
	// User status in the account
	Status *accounts.AccountUserStatus `json:"status,omitempty"`
	// Status message.
	StatusMessage *string `json:"statusMessage,omitempty"`
}

License assigned to a user

type AccountEntitlement

type AccountEntitlement struct {
	// Gets or sets the id of the account to which the license belongs
	AccountId *uuid.UUID `json:"accountId,omitempty"`
	// Gets or sets the date the license was assigned
	AssignmentDate *azuredevops.Time `json:"assignmentDate,omitempty"`
	// Assignment Source
	AssignmentSource *AssignmentSource `json:"assignmentSource,omitempty"`
	// Gets or sets the creation date of the user in this account
	DateCreated *azuredevops.Time `json:"dateCreated,omitempty"`
	// Gets or sets the date of the user last sign-in to this account
	LastAccessedDate *azuredevops.Time `json:"lastAccessedDate,omitempty"`
	License          *License          `json:"license,omitempty"`
	// Licensing origin
	Origin *LicensingOrigin `json:"origin,omitempty"`
	// The computed rights of this user in the account.
	Rights *AccountRights `json:"rights,omitempty"`
	// The status of the user in the account
	Status *accounts.AccountUserStatus `json:"status,omitempty"`
	// Identity information of the user to which the license belongs
	User *webapi.IdentityRef `json:"user,omitempty"`
	// Gets the id of the user to which the license belongs
	UserId *uuid.UUID `json:"userId,omitempty"`
}

Represents a license granted to a user in an account

type AccountEntitlementUpdateModel

type AccountEntitlementUpdateModel struct {
	// Gets or sets the license for the entitlement
	License *License `json:"license,omitempty"`
}

Model for updating an AccountEntitlement for a user, used for the Web API

type AccountLicense

type AccountLicense struct {
	// Gets the source of the license
	Source *LicensingSource `json:"source,omitempty"`
	// Gets the license type for the license
	License *AccountLicenseType `json:"license,omitempty"`
}

Represents an Account license

type AccountLicenseExtensionUsage

type AccountLicenseExtensionUsage struct {
	ExtensionId            *string                               `json:"extensionId,omitempty"`
	ExtensionName          *string                               `json:"extensionName,omitempty"`
	IncludedQuantity       *int                                  `json:"includedQuantity,omitempty"`
	IsTrial                *bool                                 `json:"isTrial,omitempty"`
	MinimumLicenseRequired *commerce.MinimumRequiredServiceLevel `json:"minimumLicenseRequired,omitempty"`
	MsdnUsedCount          *int                                  `json:"msdnUsedCount,omitempty"`
	ProvisionedCount       *int                                  `json:"provisionedCount,omitempty"`
	RemainingTrialDays     *int                                  `json:"remainingTrialDays,omitempty"`
	TrialExpiryDate        *azuredevops.Time                     `json:"trialExpiryDate,omitempty"`
	UsedCount              *int                                  `json:"usedCount,omitempty"`
}

type AccountLicenseType

type AccountLicenseType string

type AccountRights

type AccountRights struct {
	Level  *VisualStudioOnlineServiceLevel `json:"level,omitempty"`
	Reason *string                         `json:"reason,omitempty"`
}

type AccountUserLicense

type AccountUserLicense struct {
	License *int             `json:"license,omitempty"`
	Source  *LicensingSource `json:"source,omitempty"`
}

type AssignmentSource

type AssignmentSource string

type AutoLicense

type AutoLicense struct {
	// Gets the source of the license
	Source *LicensingSource `json:"source,omitempty"`
}

type ClientRightsContainer

type ClientRightsContainer struct {
	CertificateBytes *[]byte `json:"certificateBytes,omitempty"`
	Token            *string `json:"token,omitempty"`
}

type ExtensionAssignment

type ExtensionAssignment struct {
	// Gets or sets the extension ID to assign.
	ExtensionGalleryId *string `json:"extensionGalleryId,omitempty"`
	// Set to true if this a auto assignment scenario.
	IsAutoAssignment *bool `json:"isAutoAssignment,omitempty"`
	// Gets or sets the licensing source.
	LicensingSource *LicensingSource `json:"licensingSource,omitempty"`
	// Gets or sets the user IDs to assign the extension to.
	UserIds *[]uuid.UUID `json:"userIds,omitempty"`
}

Model for assigning an extension to users, used for the Web API

type ExtensionSource

type ExtensionSource struct {
	// Assignment Source
	AssignmentSource *AssignmentSource `json:"assignmentSource,omitempty"`
	// extension Identifier
	ExtensionGalleryId *string `json:"extensionGalleryId,omitempty"`
	// The licensing source of the extension. Account, Msdn, etc.
	LicensingSource *LicensingSource `json:"licensingSource,omitempty"`
}

Model for assigning an extension to users, used for the Web API

type License

type License struct {
	// Gets the source of the license
	Source *LicensingSource `json:"source,omitempty"`
}

The base class for a specific license source and license

type LicensingOrigin

type LicensingOrigin string

type LicensingSettingsSelectProperty

type LicensingSettingsSelectProperty string

[Flags]

type LicensingSource

type LicensingSource string

type MsdnLicense

type MsdnLicense struct {
	// Gets the source of the license
	Source *LicensingSource `json:"source,omitempty"`
	// Gets the license type for the license
	License *MsdnLicenseType `json:"license,omitempty"`
}

Represents an Msdn license

type MsdnLicenseType

type MsdnLicenseType string

type NoLicense

type NoLicense struct {
	// Gets the source of the license
	Source *LicensingSource `json:"source,omitempty"`
}

type VisualStudioOnlineServiceLevel

type VisualStudioOnlineServiceLevel string