Microsoft.ManagedIdentity (stable:2024-11-30)

2025/09/05 • 9 updated methods

SystemAssignedIdentities_GetByScope (updated)
Description Gets the systemAssignedIdentity available under the specified RP scope.
Reference Link ¶

⚶ Changes

{
  "#id": "SystemAssignedIdentities_GetByScope",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Version of API to invoke."
      }
    },
    {
      "#name": "scope",
      "Description": {
        "new": "The fully qualified Azure Resource manager identifier of the resource.",
        "old": "The resource provider scope of the resource. Parent resource being extended by Managed Identities."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "clientSecretUrl",
            "Description": {
              "new": "The ManagedServiceIdentity DataPlane URL that can be queried to obtain the identity credentials.",
              "old": " The ManagedServiceIdentity DataPlane URL that can be queried to obtain the identity credentials."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /{scope}/providers/Microsoft.ManagedIdentity/identities/default
{
api-version: string ,
scope: string ,
}

⚐ Response (200)

{
properties:
{
tenantId: string ,
principalId: string ,
clientId: string ,
clientSecretUrl: string ,
}
,
location: string ,
tags: object ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
}
,
}
Operations_List (updated)
Description List the operations for the provider
Reference Link ¶

⚶ Changes

{
  "#id": "Operations_List",
  "Description": {
    "new": "List the operations for the provider",
    "old": "Lists available operations for the Microsoft.ManagedIdentity provider"
  },
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Version of API to invoke."
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results.",
        "old": "A list of operations supported by Microsoft.ManagedIdentity Resource Provider."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The Operation items on this page",
            "old": "A list of operations supported by Microsoft.ManagedIdentity Resource Provider."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "Description": {
              "new": "Details of a REST API operation, returned from the Resource Provider Operations API",
              "old": "Operation supported by the Microsoft.ManagedIdentity REST API."
            },
            "$properties": [
              {
                "#name": "name",
                "Description": {
                  "new": "The name of the operation, as per Resource-Based Access Control (RBAC). Examples: \"Microsoft.Compute/virtualMachines/write\", \"Microsoft.Compute/virtualMachines/capture/action\"",
                  "old": "The name of the REST Operation. This is of the format {provider}/{resource}/{operation}."
                }
              },
              {
                "#name": "display",
                "Description": {
                  "new": "Localized display information for this particular operation.",
                  "old": "The object that describes the operation."
                },
                "$properties": [
                  {
                    "#name": "provider",
                    "Description": {
                      "new": "The localized friendly form of the resource provider name, e.g. \"Microsoft Monitoring Insights\" or \"Microsoft Compute\".",
                      "old": "Friendly name of the resource provider."
                    }
                  },
                  {
                    "#name": "operation",
                    "Description": {
                      "new": "The concise, localized friendly name for the operation; suitable for dropdowns. E.g. \"Create or Update Virtual Machine\", \"Restart Virtual Machine\".",
                      "old": "The type of operation. For example: read, write, delete."
                    }
                  },
                  {
                    "#name": "resource",
                    "Description": {
                      "new": "The localized friendly name of the resource type related to this operation. E.g. \"Virtual Machines\" or \"Job Schedule Collections\".",
                      "old": "The resource type on which the operation is performed."
                    }
                  },
                  {
                    "#name": "description",
                    "Description": {
                      "new": "The short, localized friendly description of the operation; suitable for tool tips and detailed views.",
                      "old": "A description of the operation."
                    }
                  }
                ]
              }
            ]
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "The url to get the next page of results, if any."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /providers/Microsoft.ManagedIdentity/operations
{
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
name: string ,
display:
{
provider: string ,
operation: string ,
resource: string ,
description: string ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
}
,
}
UserAssignedIdentities_ListBySubscription (updated)
Description Lists all the userAssignedIdentities available under the specified subscription.
Reference Link ¶

⚶ Changes

{
  "#id": "UserAssignedIdentities_ListBySubscription",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Version of API to invoke."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "The Id of the Subscription to which the identity belongs."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The Identity items on this page",
            "old": "The collection of userAssignedIdentities returned by the listing operation."
          },
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "The url to get the next page of results, if any."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ManagedIdentity/userAssignedIdentities
{
api-version: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
tenantId: string ,
principalId: string ,
clientId: string ,
isolationScope: enum ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
}
,
}
UserAssignedIdentities_ListByResourceGroup (updated)
Description Lists all the userAssignedIdentities available under the specified ResourceGroup.
Reference Link ¶

⚶ Changes

{
  "#id": "UserAssignedIdentities_ListByResourceGroup",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Version of API to invoke."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "The Id of the Subscription to which the identity belongs."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the Resource Group to which the identity belongs."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The Identity items on this page",
            "old": "The collection of userAssignedIdentities returned by the listing operation."
          },
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "The url to get the next page of results, if any."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
tenantId: string ,
principalId: string ,
clientId: string ,
isolationScope: enum ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
}
,
}
UserAssignedIdentities_Get (updated)
Description Gets the identity.
Reference Link ¶

⚶ Changes

{
  "#id": "UserAssignedIdentities_Get",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Version of API to invoke."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "The Id of the Subscription to which the identity belongs."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the Resource Group to which the identity belongs."
      }
    }
  ]
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{resourceName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
resourceName: string ,
}

⚐ Response (200)

{
properties:
{
tenantId: string ,
principalId: string ,
clientId: string ,
isolationScope: enum ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
}
,
}
UserAssignedIdentities_CreateOrUpdate (updated)
Description Create or update an identity in the specified subscription and resource group.
Reference Link ¶

⚶ Changes

{
  "#id": "UserAssignedIdentities_CreateOrUpdate",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Version of API to invoke."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "The Id of the Subscription to which the identity belongs."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the Resource Group to which the identity belongs."
      }
    }
  ]
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{resourceName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
resourceName: string ,
parameters:
{
properties:
{
tenantId: string ,
principalId: string ,
clientId: string ,
isolationScope: enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
tenantId: string ,
principalId: string ,
clientId: string ,
isolationScope: enum ,
}
,
}

⚐ Response (201)

{
properties:
{
tenantId: string ,
principalId: string ,
clientId: string ,
isolationScope: enum ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
}
,
}
UserAssignedIdentities_Update (updated)
Description Update an identity in the specified subscription and resource group.
Reference Link ¶

⚶ Changes

{
  "#id": "UserAssignedIdentities_Update",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Version of API to invoke."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "The Id of the Subscription to which the identity belongs."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the Resource Group to which the identity belongs."
      }
    }
  ]
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{resourceName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
resourceName: string ,
parameters:
{
location: string ,
tags: object ,
properties:
{
tenantId: string ,
principalId: string ,
clientId: string ,
isolationScope: enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
tenantId: string ,
principalId: string ,
clientId: string ,
isolationScope: enum ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
}
,
}
UserAssignedIdentities_Delete (updated)
Description Deletes the identity.
Reference Link ¶

⚶ Changes

{
  "#id": "UserAssignedIdentities_Delete",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Version of API to invoke."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "The Id of the Subscription to which the identity belongs."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the Resource Group to which the identity belongs."
      }
    }
  ]
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{resourceName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
resourceName: string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
}
,
}
FederatedIdentityCredentials_List (updated)
Description Lists all the federated identity credentials under the specified user assigned identity.
Reference Link ¶

⚶ Changes

{
  "#id": "FederatedIdentityCredentials_List",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The FederatedIdentityCredential items on this page",
            "old": "The collection of federated identity credentials returned by the listing operation."
          },
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "The url to get the next page of results, if any."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{resourceName}/federatedIdentityCredentials
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
resourceName: string ,
$top: integer ,
$skiptoken: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
issuer: string ,
subject: string ,
audiences:
[
string ,
]
,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
}
,
}