Microsoft.DependencyMap (preview:2025-01-31)

2025/06/23 • 1 updated methods

Maps_ExportDependencies (updated)
Description :  Export dependencies
Reference :  Link ¶

⚶ Changes

{
  "#id": "Maps_ExportDependencies",
  "$parameters": {
    "body": {
      "$properties": [
        {
          "#name": "focusedMachineId",
          "Required": {
            "new": false,
            "old": true
          }
        }
      ]
    }
  },
  "$responses": {
    "@added_880880de37444703b00ad84ea05c66e4": {
      "200": {
        "Description": "Model representing the result of the export dependencies asynchronous operation.",
        "Type": "object",
        "$properties": [
          {
            "#name": "id",
            "Description": "The status URL of export dependencies operation.",
            "Required": false,
            "Type": "string"
          },
          {
            "#name": "name",
            "Description": "The resource name of the operation status. It must match the last segment of 'id' field.",
            "Required": false,
            "Type": "string"
          },
          {
            "#name": "status",
            "Description": "The overall arm status of the operation. It has one of the terminal states - Succeeded/Failed/Canceled.",
            "Required": true,
            "Type": "string"
          },
          {
            "#name": "error",
            "Description": "Contains error details if status is Failed/Canceled.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "code",
                "Description": "The error code.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "message",
                "Description": "The error message.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              },
              {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            ]
          },
          {
            "#name": "startTime",
            "Description": "The start time of the operation.",
            "Format": "date-time",
            "Required": false,
            "Type": "string"
          },
          {
            "#name": "endTime",
            "Description": "The end time of the operation.",
            "Format": "date-time",
            "Required": false,
            "Type": "string"
          },
          {
            "#name": "properties",
            "Description": "Properties for export dependencies. These should only be set if the status is Succeeded.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "exportedDataSasUri",
                "Description": "The SAS URI of the blob containing the exported dependencies data.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "statusCode",
                "Description": "A status code returned by the service with additional context about the export dependencies operation.",
                "Enum": [
                  [
                    "NoMatch",
                    "Operation completed but no data was found for the requested time range"
                  ],
                  [
                    "CompleteMatch",
                    "Operation completed with data found for the entire requested time range"
                  ],
                  [
                    "PartialMatch",
                    "Operation completed with data found for a portion of the requested time range"
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "additionalInfo",
                "Description": "Additional information about the exported data.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "availableDaysCount",
                    "Description": "Number of days for which data was available in the exported results.",
                    "Format": "int32",
                    "Required": false,
                    "Type": "integer"
                  }
                ]
              }
            ]
          }
        ]
      }
    },
    "202": [
      {
        "@added_198e200d6ee248ac830682a4b62675d9": {
          "#name": "azure-asyncoperation",
          "Description": "A link to the status monitor",
          "Type": "string"
        }
      }
    ]
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DependencyMap/maps/{mapName}/exportDependencies
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
mapName:
{
Description: Maps resource name ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
{
focusedMachineId:
{
Description: Machine arm id ,
Required: False ,
}
string ,
filters:
{
Description: Filters for ExportDependencies ,
Required: False ,
}
{
dateTime:
{
Description: DateTime filter ,
Required: False ,
}
{
startDateTimeUtc:
{
Description: Start date time for dependency map visualization query ,
Format: date-time ,
Required: False ,
}
string ,
endDateTimeUtc:
{
Description: End date time for dependency map visualization query ,
Format: date-time ,
Required: False ,
}
string ,
}
,
processNameFilter:
{
Description: Process name filter ,
Required: False ,
}
{
operator:
{
Description: Operator for process name filter ,
Enum:
{
contains: Operator to include items in the result ,
notContains: Operator to exclude items in the result ,
}
,
Required: True ,
}
enum ,
processNames:
{
Description: List of process names on which the operator should be applied ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
}
,
}

⚐ Response (200)

{
id:
{
Description: The status URL of export dependencies operation. ,
Required: False ,
}
string ,
name:
{
Description: The resource name of the operation status. It must match the last segment of 'id' field. ,
Required: False ,
}
string ,
status:
{
Description: The overall arm status of the operation. It has one of the terminal states - Succeeded/Failed/Canceled. ,
Required: True ,
}
string ,
error:
{
Description: Contains error details if status is Failed/Canceled. ,
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 ,
}
,
]
,
}
,
startTime:
{
Description: The start time of the operation. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of the operation. ,
Format: date-time ,
Required: False ,
}
string ,
properties:
{
Description: Properties for export dependencies. These should only be set if the status is Succeeded. ,
Required: False ,
}
{
exportedDataSasUri:
{
Description: The SAS URI of the blob containing the exported dependencies data. ,
Required: False ,
}
string ,
statusCode:
{
Description: A status code returned by the service with additional context about the export dependencies operation. ,
Enum:
{
NoMatch: Operation completed but no data was found for the requested time range ,
CompleteMatch: Operation completed with data found for the entire requested time range ,
PartialMatch: Operation completed with data found for a portion of the requested time range ,
}
,
Required: False ,
}
enum ,
additionalInfo:
{
Description: Additional information about the exported data. ,
Required: False ,
}
{
availableDaysCount:
{
Description: Number of days for which data was available in the exported results. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ 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 ,
}
,
]
,
}
,
}