Providers - Get

Reference

Service:: Resource Management

API Version:: 2021-04-01

Gets the specified resource provider.

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

With optional parameters:

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

URI Parameters

Name	In	Required	Type	Description
resourceProviderNamespace	path	True	string	The namespace of the resource provider.
subscriptionId	path	True	string	The Microsoft Azure subscription ID.
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	Provider	OK - Returns information about the resource provider.
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

Examples

Get provider.

Sample request

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

package armresources_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/resources/armresources"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4fd842fb73656039ec94ce367bcedee25a57bd18/specification/resources/resource-manager/Microsoft.Resources/stable/2021-04-01/examples/GetProvider.json
func ExampleProvidersClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armresources.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewProvidersClient().Get(ctx, "Microsoft.TestRP1", &armresources.ProvidersClientGetOptions{Expand: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Provider = armresources.Provider{
	// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.TestRP1"),
	// 	Namespace: to.Ptr("Microsoft.TestRP1"),
	// 	RegistrationPolicy: to.Ptr("RegistrationRequired"),
	// 	RegistrationState: to.Ptr("Registering"),
	// 	ResourceTypes: []*armresources.ProviderResourceType{
	// 		{
	// 			APIVersions: []*string{
	// 				to.Ptr("2018-01-01"),
	// 				to.Ptr("2015-05-01")},
	// 				Capabilities: to.Ptr("CrossResourceGroupResourceMove, CrossSubscriptionResourceMove, SupportsTags, SupportsLocation"),
	// 				LocationMappings: []*armresources.ProviderExtendedLocation{
	// 					{
	// 						Type: to.Ptr("EdgeZone"),
	// 						ExtendedLocations: []*string{
	// 							to.Ptr("LosAngeles"),
	// 							to.Ptr("LosAngeles2")},
	// 							Location: to.Ptr("West US"),
	// 					}},
	// 					Locations: []*string{
	// 						to.Ptr("West US")},
	// 						ResourceType: to.Ptr("TestResourceType"),
	// 					},
	// 					{
	// 						APIVersions: []*string{
	// 							to.Ptr("2018-01-01"),
	// 							to.Ptr("2015-05-01")},
	// 							Capabilities: to.Ptr("CrossResourceGroupResourceMove, CrossSubscriptionResourceMove, SupportsTags, SupportsLocation"),
	// 							Locations: []*string{
	// 								to.Ptr("West US")},
	// 								ResourceType: to.Ptr("TestResourceTypeSibling"),
	// 						}},
	// 					}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { ResourceManagementClient } = require("@azure/arm-resources");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets the specified resource provider.
 *
 * @summary Gets the specified resource provider.
 * x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/stable/2021-04-01/examples/GetProvider.json
 */
async function getProvider() {
  const subscriptionId =
    process.env["RESOURCES_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceProviderNamespace = "Microsoft.TestRP1";
  const credential = new DefaultAzureCredential();
  const client = new ResourceManagementClient(credential, subscriptionId);
  const result = await client.providers.get(resourceProviderNamespace);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:: 200

{
  "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

Name	Description
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.
ProviderAuthorizationConsentState	The provider authorization consent state.
ProviderExtendedLocation	The provider extended location.
ProviderResourceType	Resource type managed by the resource provider.
ZoneMapping

Alias

The alias type.

Name	Type	Description
defaultMetadata	AliasPathMetadata	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	AliasPattern	The default pattern for an alias.
name	string	The alias name.
paths	AliasPath[]	The paths for an alias.
type	AliasType	The type of the alias.

AliasPath

The type of the paths for alias.

Name	Type	Description
apiVersions	string[]	The API versions.
metadata	AliasPathMetadata	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	AliasPattern	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	AliasPathAttributes	The attributes of the token that the alias path is referring to.
type	AliasPathTokenType	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	AliasPatternType	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	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.

Provider

Resource provider information.

Name	Type	Description
id	string	The provider ID.
namespace	string	The namespace of the resource provider.
providerAuthorizationConsentState	ProviderAuthorizationConsentState	The provider authorization consent state.
registrationPolicy	string	The registration policy of the resource provider.
registrationState	string	The registration state of the resource provider.
resourceTypes	ProviderResourceType[]	The collection of provider resource types.

ProviderAuthorizationConsentState

The provider authorization consent state.

Name	Type	Description
Consented	string
NotRequired	string
NotSpecified	string
Required	string

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	Alias[]	The aliases that are supported by this resource type.
apiProfiles	ApiProfile[]	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	ProviderExtendedLocation[]	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.
zoneMappings	ZoneMapping[]

ZoneMapping

Name	Type	Description
location	string	The location of the zone mapping.
zones	string[]

Share via