Resources - Get
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 |
---|---|---|---|---|
parent
|
path | True |
string |
The parent resource identity. |
resource
|
path | True |
string |
The name of the resource group containing the resource to get. The name is case insensitive. Regex pattern: |
resource
|
path | True |
string |
The name of the resource to get. |
resource
|
path | True |
string |
The namespace of the resource provider. |
resource
|
path | True |
string |
The resource type of the resource. |
subscription
|
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 |
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
Name | Description |
---|---|
Cloud |
An error response for a resource management request. |
Error |
The resource management error additional info. |
Error |
Error Response |
Extended |
Resource extended location. |
Extended |
The extended location type. |
Generic |
Resource information. |
Identity |
Identity for the resource. |
Plan |
Plan for the resource. |
Resource |
The identity type. |
Sku |
SKU for the resource. |
User |
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 |
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. |
ExtendedLocation
Resource extended location.
Name | Type | Description |
---|---|---|
name |
string |
The extended location name. |
type |
The extended location type. |
ExtendedLocationType
The extended location type.
Name | Type | Description |
---|---|---|
EdgeZone |
string |
GenericResource
Resource information.
Name | Type | Description |
---|---|---|
extendedLocation |
Resource extended location. |
|
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 |
---|---|---|
|