Domains - Get Domain
Note
This API is in preview.
Returns the specified domain info.
The caller must be a Fabric administrator.
Tenant.Read.All or Tenant.ReadWrite.All.
Maximum 25 requests per one minute per principal.
This API supports the Microsoft identities listed in this section.
Identity | Support |
---|---|
User | Yes |
Service principal | Yes |
Managed identities | Yes |
GET https://api.fabric.microsoft.com/v1/admin/domains/{domainId}
Name | In | Required | Type | Description |
---|---|---|---|---|
domain
|
path | True |
string uuid |
The domain ID. |
Name | Type | Description |
---|---|---|
200 OK |
Request completed successfully. |
|
Other Status Codes |
Common error codes:
|
Sample request
GET https://api.fabric.microsoft.com/v1/admin/domains/f2f6a374-789e-4d1d-9cc7-6e0b934fc529
Sample response
{
"id": "f2f6a374-789e-4d1d-9cc7-6e0b934fc529",
"displayName": "Finance",
"description": "This domain is used for identifying financial data and reports.",
"parentDomainId": null,
"contributorsScope": "SpecificUsersAndGroups"
}
Name | Description |
---|---|
Contributors |
The contributor scope. Additional contributor scopes may be added over time. |
Domain |
Represents a domain or subdomain. |
Error |
The error related resource details object. |
Error |
The error response. |
Error |
The error response details. |
The contributor scope. Additional contributor scopes may be added over time.
Name | Type | Description |
---|---|---|
AdminsOnly |
string |
Tenant and domain admins only. |
AllTenant |
string |
All the tenant's users. |
SpecificUsersAndGroups |
string |
Specific users and groups. |
Represents a domain or subdomain.
Name | Type | Description |
---|---|---|
contributorsScope |
The domain contributors scope. |
|
description |
string |
The description of the domain. |
displayName |
string |
The name of the domain. |
id |
string |
The domain object ID. |
parentDomainId |
string |
The domain parent object ID. |
The error related resource details object.
Name | Type | Description |
---|---|---|
resourceId |
string |
The resource ID that's involved in the error. |
resourceType |
string |
The type of the resource that's involved in the error. |
The error response.
Name | Type | Description |
---|---|---|
errorCode |
string |
A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users. |
message |
string |
A human readable representation of the error. |
moreDetails |
List of additional error details. |
|
relatedResource |
The error related resource details. |
|
requestId |
string |
ID of the request associated with the error. |
The error response details.
Name | Type | Description |
---|---|---|
errorCode |
string |
A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users. |
message |
string |
A human readable representation of the error. |
relatedResource |
The error related resource details. |