Microsoft.Portal (preview:2025-04-01)

2025/03/07 • 12 new methods

Operations_List (new)
Description :  List the operations for the provider
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Portal/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" ,
Required: False ,
}
string ,
isDataAction:
{
Description: Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Localized display information for this particular operation. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". ,
Required: False ,
}
string ,
operation:
{
Description: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". ,
Required: False ,
}
string ,
description:
{
Description: The short, localized friendly description of the operation; suitable for tool tips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
actionType:
{
Description: Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. ,
Enum:
{
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results (if there are any). ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Dashboards_ListBySubscription (new)
Description :  Gets all the dashboards within a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Portal/dashboards
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Dashboard items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
lenses:
{
Description: The dashboard lenses. ,
Required: False ,
}
[
{
order:
{
Description: The lens order. ,
Format: int32 ,
Required: True ,
}
integer ,
parts:
{
Description: The dashboard parts. ,
Required: True ,
}
[
{
position:
{
Description: The dashboard's part position. ,
Required: True ,
}
{
x:
{
Description: The dashboard's part x coordinate. ,
Format: int32 ,
Required: True ,
}
integer ,
y:
{
Description: The dashboard's part y coordinate. ,
Format: int32 ,
Required: True ,
}
integer ,
rowSpan:
{
Description: The dashboard's part row span. ,
Format: int32 ,
Required: True ,
}
integer ,
colSpan:
{
Description: The dashboard's part column span. ,
Format: int32 ,
Required: True ,
}
integer ,
metadata:
{
Description: The dashboard part's metadata. ,
Required: False ,
}
object ,
}
,
metadata:
{
Description: The dashboard part's metadata. ,
Required: False ,
}
{
type:
{
Description: The dashboard part metadata type. ,
Enum:
{
Extension/HubsExtension/PartType/MarkdownPart: The markdown part type. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
metadata:
{
Description: The dashboard len's metadata. ,
Required: False ,
}
object ,
}
,
]
,
metadata:
{
Description: The dashboard metadata. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Dashboards_ListByResourceGroup (new)
Description :  Gets all the Dashboards within a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Portal/dashboards
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Dashboard items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
lenses:
{
Description: The dashboard lenses. ,
Required: False ,
}
[
{
order:
{
Description: The lens order. ,
Format: int32 ,
Required: True ,
}
integer ,
parts:
{
Description: The dashboard parts. ,
Required: True ,
}
[
{
position:
{
Description: The dashboard's part position. ,
Required: True ,
}
{
x:
{
Description: The dashboard's part x coordinate. ,
Format: int32 ,
Required: True ,
}
integer ,
y:
{
Description: The dashboard's part y coordinate. ,
Format: int32 ,
Required: True ,
}
integer ,
rowSpan:
{
Description: The dashboard's part row span. ,
Format: int32 ,
Required: True ,
}
integer ,
colSpan:
{
Description: The dashboard's part column span. ,
Format: int32 ,
Required: True ,
}
integer ,
metadata:
{
Description: The dashboard part's metadata. ,
Required: False ,
}
object ,
}
,
metadata:
{
Description: The dashboard part's metadata. ,
Required: False ,
}
{
type:
{
Description: The dashboard part metadata type. ,
Enum:
{
Extension/HubsExtension/PartType/MarkdownPart: The markdown part type. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
metadata:
{
Description: The dashboard len's metadata. ,
Required: False ,
}
object ,
}
,
]
,
metadata:
{
Description: The dashboard metadata. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Dashboards_Get (new)
Description :  Gets the Dashboard.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Portal/dashboards/{dashboardName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dashboardName:
{
Description: The name of the dashboard. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
lenses:
{
Description: The dashboard lenses. ,
Required: False ,
}
[
{
order:
{
Description: The lens order. ,
Format: int32 ,
Required: True ,
}
integer ,
parts:
{
Description: The dashboard parts. ,
Required: True ,
}
[
{
position:
{
Description: The dashboard's part position. ,
Required: True ,
}
{
x:
{
Description: The dashboard's part x coordinate. ,
Format: int32 ,
Required: True ,
}
integer ,
y:
{
Description: The dashboard's part y coordinate. ,
Format: int32 ,
Required: True ,
}
integer ,
rowSpan:
{
Description: The dashboard's part row span. ,
Format: int32 ,
Required: True ,
}
integer ,
colSpan:
{
Description: The dashboard's part column span. ,
Format: int32 ,
Required: True ,
}
integer ,
metadata:
{
Description: The dashboard part's metadata. ,
Required: False ,
}
object ,
}
,
metadata:
{
Description: The dashboard part's metadata. ,
Required: False ,
}
{
type:
{
Description: The dashboard part metadata type. ,
Enum:
{
Extension/HubsExtension/PartType/MarkdownPart: The markdown part type. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
metadata:
{
Description: The dashboard len's metadata. ,
Required: False ,
}
object ,
}
,
]
,
metadata:
{
Description: The dashboard metadata. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Dashboards_CreateOrUpdate (new)
Description :  Creates or updates a Dashboard.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Portal/dashboards/{dashboardName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dashboardName:
{
Description: The name of the dashboard. ,
Required: True ,
}
string ,
dashboard:
{
Description: The parameters required to create or update a dashboard. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
lenses:
{
Description: The dashboard lenses. ,
Required: False ,
}
[
{
order:
{
Description: The lens order. ,
Format: int32 ,
Required: True ,
}
integer ,
parts:
{
Description: The dashboard parts. ,
Required: True ,
}
[
{
position:
{
Description: The dashboard's part position. ,
Required: True ,
}
{
x:
{
Description: The dashboard's part x coordinate. ,
Format: int32 ,
Required: True ,
}
integer ,
y:
{
Description: The dashboard's part y coordinate. ,
Format: int32 ,
Required: True ,
}
integer ,
rowSpan:
{
Description: The dashboard's part row span. ,
Format: int32 ,
Required: True ,
}
integer ,
colSpan:
{
Description: The dashboard's part column span. ,
Format: int32 ,
Required: True ,
}
integer ,
metadata:
{
Description: The dashboard part's metadata. ,
Required: False ,
}
object ,
}
,
metadata:
{
Description: The dashboard part's metadata. ,
Required: False ,
}
{
type:
{
Description: The dashboard part metadata type. ,
Enum:
{
Extension/HubsExtension/PartType/MarkdownPart: The markdown part type. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
metadata:
{
Description: The dashboard len's metadata. ,
Required: False ,
}
object ,
}
,
]
,
metadata:
{
Description: The dashboard metadata. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
lenses:
{
Description: The dashboard lenses. ,
Required: False ,
}
[
{
order:
{
Description: The lens order. ,
Format: int32 ,
Required: True ,
}
integer ,
parts:
{
Description: The dashboard parts. ,
Required: True ,
}
[
{
position:
{
Description: The dashboard's part position. ,
Required: True ,
}
{
x:
{
Description: The dashboard's part x coordinate. ,
Format: int32 ,
Required: True ,
}
integer ,
y:
{
Description: The dashboard's part y coordinate. ,
Format: int32 ,
Required: True ,
}
integer ,
rowSpan:
{
Description: The dashboard's part row span. ,
Format: int32 ,
Required: True ,
}
integer ,
colSpan:
{
Description: The dashboard's part column span. ,
Format: int32 ,
Required: True ,
}
integer ,
metadata:
{
Description: The dashboard part's metadata. ,
Required: False ,
}
object ,
}
,
metadata:
{
Description: The dashboard part's metadata. ,
Required: False ,
}
{
type:
{
Description: The dashboard part metadata type. ,
Enum:
{
Extension/HubsExtension/PartType/MarkdownPart: The markdown part type. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
metadata:
{
Description: The dashboard len's metadata. ,
Required: False ,
}
object ,
}
,
]
,
metadata:
{
Description: The dashboard metadata. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
lenses:
{
Description: The dashboard lenses. ,
Required: False ,
}
[
{
order:
{
Description: The lens order. ,
Format: int32 ,
Required: True ,
}
integer ,
parts:
{
Description: The dashboard parts. ,
Required: True ,
}
[
{
position:
{
Description: The dashboard's part position. ,
Required: True ,
}
{
x:
{
Description: The dashboard's part x coordinate. ,
Format: int32 ,
Required: True ,
}
integer ,
y:
{
Description: The dashboard's part y coordinate. ,
Format: int32 ,
Required: True ,
}
integer ,
rowSpan:
{
Description: The dashboard's part row span. ,
Format: int32 ,
Required: True ,
}
integer ,
colSpan:
{
Description: The dashboard's part column span. ,
Format: int32 ,
Required: True ,
}
integer ,
metadata:
{
Description: The dashboard part's metadata. ,
Required: False ,
}
object ,
}
,
metadata:
{
Description: The dashboard part's metadata. ,
Required: False ,
}
{
type:
{
Description: The dashboard part metadata type. ,
Enum:
{
Extension/HubsExtension/PartType/MarkdownPart: The markdown part type. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
metadata:
{
Description: The dashboard len's metadata. ,
Required: False ,
}
object ,
}
,
]
,
metadata:
{
Description: The dashboard metadata. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Dashboards_Update (new)
Description :  Updates an existing Dashboard.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Portal/dashboards/{dashboardName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dashboardName:
{
Description: The name of the dashboard. ,
Required: True ,
}
string ,
dashboard:
{
Description: The updatable fields of a Dashboard. ,
Required: True ,
}
{
properties:
{
Description: The shared dashboard properties. ,
Required: False ,
}
{
lenses:
{
Description: The dashboard lenses. ,
Required: False ,
}
[
{
order:
{
Description: The lens order. ,
Format: int32 ,
Required: True ,
}
integer ,
parts:
{
Description: The dashboard parts. ,
Required: True ,
}
[
{
position:
{
Description: The dashboard's part position. ,
Required: True ,
}
{
x:
{
Description: The dashboard's part x coordinate. ,
Format: int32 ,
Required: True ,
}
integer ,
y:
{
Description: The dashboard's part y coordinate. ,
Format: int32 ,
Required: True ,
}
integer ,
rowSpan:
{
Description: The dashboard's part row span. ,
Format: int32 ,
Required: True ,
}
integer ,
colSpan:
{
Description: The dashboard's part column span. ,
Format: int32 ,
Required: True ,
}
integer ,
metadata:
{
Description: The dashboard part's metadata. ,
Required: False ,
}
object ,
}
,
metadata:
{
Description: The dashboard part's metadata. ,
Required: False ,
}
{
type:
{
Description: The dashboard part metadata type. ,
Enum:
{
Extension/HubsExtension/PartType/MarkdownPart: The markdown part type. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
metadata:
{
Description: The dashboard len's metadata. ,
Required: False ,
}
object ,
}
,
]
,
metadata:
{
Description: The dashboard metadata. ,
Required: False ,
}
object ,
}
,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
lenses:
{
Description: The dashboard lenses. ,
Required: False ,
}
[
{
order:
{
Description: The lens order. ,
Format: int32 ,
Required: True ,
}
integer ,
parts:
{
Description: The dashboard parts. ,
Required: True ,
}
[
{
position:
{
Description: The dashboard's part position. ,
Required: True ,
}
{
x:
{
Description: The dashboard's part x coordinate. ,
Format: int32 ,
Required: True ,
}
integer ,
y:
{
Description: The dashboard's part y coordinate. ,
Format: int32 ,
Required: True ,
}
integer ,
rowSpan:
{
Description: The dashboard's part row span. ,
Format: int32 ,
Required: True ,
}
integer ,
colSpan:
{
Description: The dashboard's part column span. ,
Format: int32 ,
Required: True ,
}
integer ,
metadata:
{
Description: The dashboard part's metadata. ,
Required: False ,
}
object ,
}
,
metadata:
{
Description: The dashboard part's metadata. ,
Required: False ,
}
{
type:
{
Description: The dashboard part metadata type. ,
Enum:
{
Extension/HubsExtension/PartType/MarkdownPart: The markdown part type. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
metadata:
{
Description: The dashboard len's metadata. ,
Required: False ,
}
object ,
}
,
]
,
metadata:
{
Description: The dashboard metadata. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Dashboards_Delete (new)
Description :  Deletes the Dashboard.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Portal/dashboards/{dashboardName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dashboardName:
{
Description: The name of the dashboard. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ListTenantConfigurationViolations_List (new)
Description :  Gets list of items that violate tenant's configuration.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Portal/listTenantConfigurationViolations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Violation items on this page ,
Required: True ,
}
[
{
id:
{
Description: Id of the item that violates tenant configuration. ,
Required: False ,
}
string ,
userId:
{
Description: Id of the user who owns violated item. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
TenantConfigurations_List (new)
Description :  Gets list of the tenant configurations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Portal/tenantConfigurations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Configuration items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
enforcePrivateMarkdownStorage:
{
Description: When flag is set to true Markdown tile will require external storage configuration (URI). The inline content configuration will be prohibited. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
TenantConfigurations_Get (new)
Description :  Gets the tenant configuration.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Portal/tenantConfigurations/{configurationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
configurationName:
{
Description: The name of the Configuration ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
enforcePrivateMarkdownStorage:
{
Description: When flag is set to true Markdown tile will require external storage configuration (URI). The inline content configuration will be prohibited. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
TenantConfigurations_Create (new)
Description :  Create the tenant configuration. If configuration already exists - update it. User has to be a Tenant Admin for this operation.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Portal/tenantConfigurations/{configurationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
configurationName:
{
Description: The name of the Configuration ,
Required: True ,
}
string ,
tenantConfiguration:
{
Description: The parameters required to create or update tenant configuration. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
enforcePrivateMarkdownStorage:
{
Description: When flag is set to true Markdown tile will require external storage configuration (URI). The inline content configuration will be prohibited. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
enforcePrivateMarkdownStorage:
{
Description: When flag is set to true Markdown tile will require external storage configuration (URI). The inline content configuration will be prohibited. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
enforcePrivateMarkdownStorage:
{
Description: When flag is set to true Markdown tile will require external storage configuration (URI). The inline content configuration will be prohibited. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
TenantConfigurations_Delete (new)
Description :  Delete the tenant configuration. User has to be a Tenant Admin for this operation.
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.Portal/tenantConfigurations/{configurationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
configurationName:
{
Description: The name of the Configuration ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}