Providers - Get

Gets the specified resource provider.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}?api-version=2020-10-01
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}?$expand={$expand}&api-version=2020-10-01

URI Parameters

Name In Required Type Description
resourceProviderNamespace
path True
  • string

The namespace of the resource provider.

subscriptionId
path True
  • string

The ID of the target subscription.

api-version
query True
  • string

The API version to use for this operation.

$expand
query
  • string

The $expand query parameter. For example, to include property aliases in response, use $expand=resourceTypes/aliases.

Responses

Name Type Description
200 OK

OK - Returns information about the resource provider.

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

Examples

Get provider.

Sample Request

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.TestRP1?api-version=2020-10-01

Sample Response

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.TestRP1",
  "namespace": "Microsoft.TestRP1",
  "registrationState": "Registering",
  "registrationPolicy": "RegistrationRequired",
  "resourceTypes": [
    {
      "resourceType": "TestResourceType",
      "locations": [
        "West US"
      ],
      "apiVersions": [
        "2018-01-01",
        "2015-05-01"
      ],
      "locationMappings": [
        {
          "location": "West US",
          "type": "EdgeZone",
          "extendedLocations": [
            "LosAngeles",
            "LosAngeles2"
          ]
        }
      ],
      "capabilities": "CrossResourceGroupResourceMove, CrossSubscriptionResourceMove, SupportsTags, SupportsLocation"
    },
    {
      "resourceType": "TestResourceTypeSibling",
      "locations": [
        "West US"
      ],
      "apiVersions": [
        "2018-01-01",
        "2015-05-01"
      ],
      "capabilities": "CrossResourceGroupResourceMove, CrossSubscriptionResourceMove, SupportsTags, SupportsLocation"
    }
  ]
}

Definitions

Alias

The alias type.

AliasPath

The type of the paths for alias.

AliasPathAttributes

The attributes of the token that the alias path is referring to.

AliasPathMetadata
AliasPathTokenType

The type of the token that the alias path is referring to.

AliasPattern

The type of the pattern for an alias path.

AliasPatternType

The type of alias pattern

AliasType

The type of the alias.

ApiProfile
CloudError

An error response for a resource management request.

ErrorAdditionalInfo

The resource management error additional info.

ErrorResponse

Error Response

Provider

Resource provider information.

ProviderExtendedLocation

The provider extended location.

ProviderResourceType

Resource type managed by the resource provider.

Alias

The alias type.

Name Type Description
defaultMetadata

The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata

defaultPath
  • string

The default path for an alias.

defaultPattern

The default pattern for an alias.

name
  • string

The alias name.

paths

The paths for an alias.

type

The type of the alias.

AliasPath

The type of the paths for alias.

Name Type Description
apiVersions
  • string[]

The API versions.

metadata

The metadata of the alias path. If missing, fall back to the default metadata of the alias.

path
  • string

The path of an alias.

pattern

The pattern for an alias path.

AliasPathAttributes

The attributes of the token that the alias path is referring to.

Name Type Description
Modifiable
  • string

The token that the alias path is referring to is modifiable by policies with 'modify' effect.

None
  • string

The token that the alias path is referring to has no attributes.

AliasPathMetadata

Name Type Description
attributes

The attributes of the token that the alias path is referring to.

type

The type of the token that the alias path is referring to.

AliasPathTokenType

The type of the token that the alias path is referring to.

Name Type Description
Any
  • string

The token type can be anything.

Array
  • string

The token type is array.

Boolean
  • string

The token type is boolean.

Integer
  • string

The token type is integer.

NotSpecified
  • string

The token type is not specified.

Number
  • string

The token type is number.

Object
  • string

The token type is object.

String
  • string

The token type is string.

AliasPattern

The type of the pattern for an alias path.

Name Type Description
phrase
  • string

The alias pattern phrase.

type

The type of alias pattern

variable
  • string

The alias pattern variable.

AliasPatternType

The type of alias pattern

Name Type Description
Extract
  • string

Extract is the only allowed value.

NotSpecified
  • string

NotSpecified is not allowed.

AliasType

The type of the alias.

Name Type Description
Mask
  • string

Alias value is secret.

NotSpecified
  • string

Alias type is unknown (same as not providing alias type).

PlainText
  • string

Alias value is not secret.

ApiProfile

Name Type Description
apiVersion
  • string

The API version.

profileVersion
  • string

The profile version.

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.

Provider

Resource provider information.

Name Type Description
id
  • string

The provider ID.

namespace
  • string

The namespace of the resource provider.

registrationPolicy
  • string

The registration policy of the resource provider.

registrationState
  • string

The registration state of the resource provider.

resourceTypes

The collection of provider resource types.

ProviderExtendedLocation

The provider extended location.

Name Type Description
extendedLocations
  • string[]

The extended locations for the azure location.

location
  • string

The azure location.

type
  • string

The extended location type.

ProviderResourceType

Resource type managed by the resource provider.

Name Type Description
aliases

The aliases that are supported by this resource type.

apiProfiles

The API profiles for the resource provider.

apiVersions
  • string[]

The API version.

capabilities
  • string

The additional capabilities offered by this resource type.

defaultApiVersion
  • string

The default API version.

locationMappings

The location mappings that are supported by this resource type.

locations
  • string[]

The collection of locations where this resource type can be created.

properties
  • object

The properties.

resourceType
  • string

The resource type.