| Required role: | TenantReader |
| GET | /api/resourceproviders/{Id} | Returns a resourceprovider | |
|---|---|---|---|
| GET | /resourceproviders/{Id} | Returns a resourceprovider |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | path | string | Yes | The primary key of every config item |
| TenantName | header | string | Yes | |
| IncludeDeleted | query | bool? | No | If true, also soft deleted items will be returned |
| IncludeReferencedObjects | query | bool? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| TenantId | form | Guid | No | |
| DefaultEnvironment | form | Environments | No | If environment cannot be detected while scanning, default environment will be used |
| AllowedEnvironments | form | IList<Environments> | Yes | List off all allowed environments for this resource provider |
| Type | form | ResourceProviderTypes | No | Defines the provider type (e.g. Azure, Aws) |
| Config | form | IList<ProviderConfigEntryDto> | Yes | Additional generic data which varies depending on ProviderType |
| IsDisabled | form | bool | No | Disabled ResourceProviders cannot be selected for new deployments |
| IsReadyForDeployments | form | bool | No | Shows if a ResourceProvider has been initialized and can accept deployments (resources) |
| CostCurrentMonth | form | decimal | No | The cost for the current month |
| CostLastMonth | form | decimal | No | The cost for the last month |
| CostCurrency | form | string | Yes | The cost currency |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | Guid | No | |
| Name | form | string | Yes | |
| DisplayName | form | string | Yes | |
| Description | form | string | No | |
| ObjectType | form | ObjectTypes | No | |
| SelfLink | form | string | Yes | |
| Tags | form | IList<TagDto> | Yes | |
| Path | form | IList<PathItemDto> | Yes | |
| Created | form | DateTime | No | |
| CreateUser | form | string | Yes | |
| CreateUserId | form | string | Yes | |
| Modified | form | DateTime | No | |
| ModifyUser | form | string | Yes | |
| ModifyUserId | form | string | Yes | |
| IsDeleted | form | bool | No | |
| Deleted | form | DateTime? | No | |
| DeleteUser | form | string | No | |
| DeleteUserId | form | string | No | |
| Links | form | IList<LinkDto> | Yes |
| 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 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | Yes | |
| Value | form | string | No | |
| IsProtected | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Label | form | string | Yes | |
| Link | form | string | Yes | |
| ObjectType | form | ObjectTypes | No | |
| ObjectId | form | Guid | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Caption | form | string | Yes | |
| Rel | form | string | Yes | |
| HRef | form | string | Yes | |
| Method | form | string | Yes |
| Lab | |
| Poc | |
| Dev | |
| Test | |
| Int | |
| Uat | |
| Prod |
| Azure | |
| AmazonWebServices | |
| GoogleCloudPlatform | |
| ActiveDirectoryServices | |
| DomainNameSystem | |
| SwisscomESC | |
| AzureKeyVault |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | Yes | |
| Value | form | string | Yes | |
| isSecure | form | bool | No |
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
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}