CoreService

<back to all web services

GetResourceProvider

ResourceProvider - CRUD

Returns a single resourceprovider by its id

Requires Authentication
Required role:TenantReader
The following routes are available for this service:
GET/api/resourceproviders/{Id}Returns a resourceprovider
GET/resourceproviders/{Id}Returns a resourceprovider
GetResourceProvider Parameters:
NameParameterData TypeRequiredDescription
IdpathstringYesThe primary key of every config item
TenantNameheaderstringYes
IncludeDeletedquerybool?NoIf true, also soft deleted items will be returned
IncludeReferencedObjectsquerybool?No
ResourceProviderDto Parameters:
NameParameterData TypeRequiredDescription
TenantIdformGuidNo
DefaultEnvironmentformEnvironmentsNoIf environment cannot be detected while scanning, default environment will be used
AllowedEnvironmentsformIList<Environments>YesList off all allowed environments for this resource provider
TypeformResourceProviderTypesNoDefines the provider type (e.g. Azure, Aws)
ConfigformIList<ProviderConfigEntryDto>YesAdditional generic data which varies depending on ProviderType
IsDisabledformboolNoDisabled ResourceProviders cannot be selected for new deployments
IsReadyForDeploymentsformboolNoShows if a ResourceProvider has been initialized and can accept deployments (resources)
CostCurrentMonthformdecimalNoThe cost for the current month
CostLastMonthformdecimalNoThe cost for the last month
CostCurrencyformstringYesThe cost currency
ConfigItemDto Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
NameformstringYes
DisplayNameformstringYes
DescriptionformstringNo
ObjectTypeformObjectTypesNo
SelfLinkformstringYes
TagsformIList<TagDto>Yes
PathformIList<PathItemDto>Yes
CreatedformDateTimeNo
CreateUserformstringYes
CreateUserIdformstringYes
ModifiedformDateTimeNo
ModifyUserformstringYes
ModifyUserIdformstringYes
IsDeletedformboolNo
DeletedformDateTime?No
DeleteUserformstringNo
DeleteUserIdformstringNo
LinksformIList<LinkDto>Yes
ObjectTypes Enum:
None
ConfigItem
Tenant
Collection
Resource
ComputeNode
VirtualMachine
PhysicalMachine
Disk
Subnet
IPAddress
Job
JobEvent
FreezePeriod
ResourceGroup
Deployment
ResourceGroupTemplate
DeploymentTemplate
ResourceProvider
GenericResource
Role
Permission
User
PatchingWindow
Update
ReportDefinition
TimeSeries
DataPoint
Action
ActionAssignment
UserNote
TagDto Parameters:
NameParameterData TypeRequiredDescription
NameformstringYes
ValueformstringNo
IsProtectedformboolNo
PathItemDto Parameters:
NameParameterData TypeRequiredDescription
LabelformstringYes
LinkformstringYes
ObjectTypeformObjectTypesNo
ObjectIdformGuidNo
LinkDto Parameters:
NameParameterData TypeRequiredDescription
CaptionformstringYes
RelformstringYes
HRefformstringYes
MethodformstringYes
Environments Enum:
Lab
Poc
Dev
Test
Int
Uat
Prod
ResourceProviderTypes Enum:
Azure
AmazonWebServices
GoogleCloudPlatform
ActiveDirectoryServices
DomainNameSystem
SwisscomESC
AzureKeyVault
ProviderConfigEntryDto Parameters:
NameParameterData TypeRequiredDescription
NameformstringYes
ValueformstringYes
isSecureformboolNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /api/resourceproviders/{Id} HTTP/1.1 
Host: core.starburst.svc 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"tenantId":"00000000-0000-0000-0000-000000000000","defaultEnvironment":"Lab","allowedEnvironments":null,"type":"Azure","config":null,"isDisabled":false,"isReadyForDeployments":false,"costCurrentMonth":0,"costLastMonth":0,"costCurrency":"String","id":"00000000-0000-0000-0000-000000000000","name":"String","displayName":"String","description":"String","objectType":"None","selfLink":"String","tags":null,"path":null,"created":"0001-01-01T00:00:00.0000000Z","createUser":"String","createUserId":"String","modified":"0001-01-01T00:00:00.0000000Z","modifyUser":"String","modifyUserId":"String","isDeleted":false,"deleted":"0001-01-01T00:00:00.0000000Z","deleteUser":"String","deleteUserId":"String","links":null}