Resources - Get

Service:

Resource Management

API Version:

2021-04-01

Gets a resource.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}?api-version=2021-04-01

URI Parameters

Name	In	Required	Type	Description
parentResourcePath	path	True	string	The parent resource identity.
resourceGroupName	path	True	string	The name of the resource group containing the resource to get. The name is case insensitive. Regex pattern: ^[-\w\._\(\)]+$
resourceName	path	True	string	The name of the resource to get.
resourceProviderNamespace	path	True	string	The namespace of the resource provider.
resourceType	path	True	string	The resource type of the resource.
subscriptionId	path	True	string	The Microsoft Azure subscription ID.
api-version	query	True	string	The API version to use for the operation.

Responses

Name	Type	Description
200 OK	GenericResource	OK - Returns information about the resource.
Other Status Codes	CloudError	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

Name	Description
CloudError	An error response for a resource management request.
ErrorAdditionalInfo	The resource management error additional info.
ErrorResponse	Error Response
ExtendedLocation	Resource extended location.
ExtendedLocationType	The extended location type.
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	ErrorResponse	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	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorResponse[]	The error details.
message	string	The error message.
target	string	The error target.

ExtendedLocation

Resource extended location.

Name	Type	Description
name	string	The extended location name.
type	ExtendedLocationType	The extended location type.

ExtendedLocationType

The extended location type.

Name	Type	Description
EdgeZone	string

GenericResource

Resource information.

Name	Type	Description
extendedLocation	ExtendedLocation	Resource extended location.
id	string	Resource ID
identity	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	Plan	The plan of the resource.
properties	object	The resource properties.
sku	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	ResourceIdentityType	The identity type.
userAssignedIdentities	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