你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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	正常 - 返回有关资源提供程序的信息。
Other Status Codes	CloudError	描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

类型: oauth2
流向: implicit
授权 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	别名路径引用的标记可由具有“修改”效果的策略修改。
None	string	别名路径所引用的标记没有属性。

AliasPathMetadata

名称	类型	说明
attributes	AliasPathAttributes	别名路径所引用的令牌的属性。
type	AliasPathTokenType	别名路径所引用的令牌的类型。

AliasPathTokenType

别名路径所引用的令牌的类型。

名称	类型	说明
Any	string	令牌类型可以是任何类型。
Array	string	令牌类型为 array。
Boolean	string	标记类型为布尔值。
Integer	string	标记类型为整数。
NotSpecified	string	未指定令牌类型。
Number	string	标记类型为 number。
Object	string	标记类型为对象。
String	string	标记类型为字符串。

AliasPattern

别名路径的模式的类型。

名称	类型	说明
phrase	string	别名模式短语。
type	AliasPatternType	别名模式的类型
variable	string	别名模式变量。

AliasPatternType

别名模式的类型

名称	类型	说明
Extract	string	提取是唯一允许的值。
NotSpecified	string	不允许使用 NotSpecified。

AliasType

别名的类型。

名称	类型	说明
Mask	string	别名值为机密。
NotSpecified	string	别名类型未知 (与不提供别名类型) 相同。
PlainText	string	别名值不是机密值。

ApiProfile

名称	类型	说明
apiVersion	string	API 版本。
profileVersion	string	配置文件版本。

CloudError

资源管理请求的错误响应。

名称	类型	说明
error	ErrorResponse	错误响应对所有 Azure 资源管理器 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[]

通过