Providers - Get

リファレンス

サービス:: Resource Management

API バージョン:: 2021-04-01

指定したリソースプロバイダーを取得します。

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

省略可能なパラメーターを含む:

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

URI パラメーター

名前	/	必須	型	説明
resourceProviderNamespace	path	True	string	リソースプロバイダーの名前空間。
subscriptionId	path	True	string	Microsoft Azure サブスクリプション ID。
api-version	query	True	string	この操作に使用する API バージョン。
$expand	query		string	$expand クエリパラメーター。たとえば、応答にプロパティエイリアスを含めるには、$expand=resourceTypes/aliases を使用します。

応答

名前	型	説明
200 OK	Provider	OK - リソースプロバイダーに関する情報を返します。
Other Status Codes	CloudError	操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザーアカウントの借用

例

Get provider.

要求のサンプル

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

応答のサンプル

状態コード:: 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"
    }
  ]
}

定義

名前	説明
Alias	別名の型。
AliasPath	エイリアスのパスの型。
AliasPathAttributes	エイリアスパスが参照しているトークンの属性。
AliasPathMetadata
AliasPathTokenType	別名パスが参照しているトークンの型。
AliasPattern	エイリアスパスのパターンの型。
AliasPatternType	エイリアスパターンの種類
AliasType	エイリアスの型。
ApiProfile
CloudError	リソース管理要求のエラー応答。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorResponse	エラー応答
Provider	リソースプロバイダーの情報です。
ProviderAuthorizationConsentState	プロバイダー承認の同意の状態。
ProviderExtendedLocation	プロバイダーの拡張場所。
ProviderResourceType	リソースプロバイダーによって管理されるリソースの種類です。
ZoneMapping

Alias

別名の型。

名前	型	説明
defaultMetadata	AliasPathMetadata	既定のエイリアスパスメタデータ。既定のパスと、メタデータを持たないエイリアスパスに適用されます
defaultPath	string	エイリアスの既定のパス。
defaultPattern	AliasPattern	エイリアスの既定のパターン。
name	string	エイリアス名。
paths	AliasPath[]	エイリアスのパス。
type	AliasType	エイリアスの型。

AliasPath

エイリアスのパスの型。

名前	型	説明
apiVersions	string[]	API のバージョン。
metadata	AliasPathMetadata	エイリアスパスのメタデータ。存在しない場合は、エイリアスの既定のメタデータにフォールバックします。
path	string	エイリアスのパス。
pattern	AliasPattern	エイリアスパスのパターン。

AliasPathAttributes

エイリアスパスが参照しているトークンの属性。

名前	型	説明
Modifiable	string	別名パスが参照しているトークンは、'modify' 効果を持つポリシーによって変更できます。
None	string	別名パスが参照しているトークンには属性がありません。

AliasPathMetadata

名前	型	説明
attributes	AliasPathAttributes	エイリアスパスが参照しているトークンの属性。
type	AliasPathTokenType	別名パスが参照しているトークンの型。

AliasPathTokenType

別名パスが参照しているトークンの型。

名前	型	説明
Any	string	トークンの種類は何でもかまいません。
Array	string	トークン型は配列です。
Boolean	string	トークンの種類はブール値です。
Integer	string	トークンの種類は整数です。
NotSpecified	string	トークンの種類が指定されていません。
Number	string	トークンの種類は number です。
Object	string	トークンの種類は object です。
String	string	トークンの種類は string です。

AliasPattern

エイリアスパスのパターンの型。

名前	型	説明
phrase	string	エイリアスパターンフレーズ。
type	AliasPatternType	エイリアスパターンの種類
variable	string	エイリアスパターン変数。

AliasPatternType

エイリアスパターンの種類

名前	型	説明
Extract	string	Extract は、許可される唯一の値です。
NotSpecified	string	NotSpecified は使用できません。

AliasType

エイリアスの型。

名前	型	説明
Mask	string	エイリアス値はシークレットです。
NotSpecified	string	エイリアスの種類が不明です (別名の種類を指定しない場合と同じです)。
PlainText	string	エイリアス値はシークレットではありません。

ApiProfile

名前	型	説明
apiVersion	string	API のバージョン。
profileVersion	string	プロファイルのバージョン。

CloudError

リソース管理要求のエラー応答。

名前	型	説明
error	ErrorResponse	エラー応答失敗した操作のエラーの詳細を返す、すべての Azure Resource Manager API に対する一般的なエラー応答 (これは OData エラー応答形式にも従います)。

ErrorAdditionalInfo

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorResponse

エラー応答

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorResponse[]	エラーの詳細です。
message	string	エラーメッセージ。
target	string	エラーのターゲット。

Provider

リソースプロバイダーの情報です。

名前	型	説明
id	string	プロバイダー ID。
namespace	string	リソースプロバイダーの名前空間。
providerAuthorizationConsentState	ProviderAuthorizationConsentState	プロバイダー承認の同意の状態。
registrationPolicy	string	リソースプロバイダーの登録ポリシー。
registrationState	string	リソースプロバイダーの登録状態。
resourceTypes	ProviderResourceType[]	プロバイダーリソースの種類のコレクション。

ProviderAuthorizationConsentState

プロバイダー承認の同意の状態。

名前	型	説明
Consented	string
NotRequired	string
NotSpecified	string
Required	string

ProviderExtendedLocation

プロバイダーの拡張場所。

名前	型	説明
extendedLocations	string[]	Azure の場所の拡張された場所。
location	string	Azure の場所。
type	string	拡張場所の種類。

ProviderResourceType

リソースプロバイダーによって管理されるリソースの種類です。

名前	型	説明
aliases	Alias[]	このリソースの種類でサポートされているエイリアス。
apiProfiles	ApiProfile[]	リソースプロバイダーの API プロファイル。
apiVersions	string[]	API のバージョン。
capabilities	string	このリソースの種類によって提供される追加の機能。
defaultApiVersion	string	既定の API バージョン。
locationMappings	ProviderExtendedLocation[]	このリソースの種類でサポートされている場所マッピング。
locations	string[]	このリソースの種類を作成できる場所のコレクション。
properties	object	プロパティ。
resourceType	string	リソースの種類。
zoneMappings	ZoneMapping[]

ZoneMapping

名前	型	説明
location	string	ゾーンマッピングの場所。
zones	string[]

次の方法で共有