Resources - Get By Id

Gets a resource by ID.

GET https://management.azure.com/{resourceId}?api-version=2020-06-01

URI Parameters

Name In Required Type Description
resourceId
path True
  • string

The fully qualified ID of the resource, including the resource name and resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}

api-version
query True
  • string

The API version to use for the operation.

Responses

Name Type Description
200 OK

OK - Returns information about the resource.

Other Status Codes

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Definitions

CloudError

An error response for a resource management request.

ErrorAdditionalInfo

The resource management error additional info.

ErrorResponse

Error Response

GenericResource

Resource information.

Identity

Identity for the resource.

Plan

Plan for the resource.

ResourceIdentityType

The identity type.

Sku

SKU for the resource.

UserAssignedIdentities

The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

CloudError

An error response for a resource management request.

Name Type Description
error

Error Response
Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.)

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info
  • object

The additional info.

type
  • string

The additional info type.

ErrorResponse

Error Response

Name Type Description
additionalInfo

The error additional info.

code
  • string

The error code.

details

The error details.

message
  • string

The error message.

target
  • string

The error target.

GenericResource

Resource information.

Name Type Description
id
  • string

Resource ID

identity

The identity of the resource.

kind
  • string

The kind of the resource.

location
  • string

Resource location

managedBy
  • string

ID of the resource that manages this resource.

name
  • string

Resource name

plan

The plan of the resource.

properties
  • object

The resource properties.

sku

The SKU of the resource.

tags
  • object

Resource tags

type
  • string

Resource type

Identity

Identity for the resource.

Name Type Description
principalId
  • string

The principal ID of resource identity.

tenantId
  • string

The tenant ID of resource.

type

The identity type.

userAssignedIdentities

The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

Plan

Plan for the resource.

Name Type Description
name
  • string

The plan ID.

product
  • string

The offer ID.

promotionCode
  • string

The promotion code.

publisher
  • string

The publisher ID.

version
  • string

The plan's version.

ResourceIdentityType

The identity type.

Name Type Description
None
  • string
SystemAssigned
  • string
SystemAssigned, UserAssigned
  • string
UserAssigned
  • string

Sku

SKU for the resource.

Name Type Description
capacity
  • integer

The SKU capacity.

family
  • string

The SKU family.

model
  • string

The SKU model.

name
  • string

The SKU name.

size
  • string

The SKU size.

tier
  • string

The SKU tier.

UserAssignedIdentities

The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

Name Type Description