Providers - Get

Service:

Resource Management

API Version:

2021-04-01

Возвращает указанный поставщик ресурсов.

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

Имя	В	Обязательно	Тип	Описание
resourceProviderNamespace	path	True	string	Пространство имен поставщика ресурсов.
subscriptionId	path	True	string	Идентификатор подписки Microsoft Azure.
api-version	query	True	string	Версия API, используемая для данной операции.
$expand	query		string	Параметр запроса $expand. Например, чтобы включить псевдонимы свойств в ответ, используйте $expand=resourceTypes/aliases.

Ответы

Имя	Тип	Описание
200 OK	Provider	ОК . Возвращает сведения о поставщике ресурсов.
Other Status Codes	CloudError	Ответ об ошибке, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

Get provider.

Sample Request

HTTP

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

Go

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

JavaScript

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"
    }
  ]
}

Определения

Имя	Описание
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	Тип токена — integer.
NotSpecified	string	Тип маркера не указан.
Number	string	Тип токена — число.
Object	string	Тип токена — object.
String	string	Тип токена — string.

AliasPattern

Тип шаблона для пути псевдонима.

Имя	Тип	Описание
phrase	string	Фраза шаблона псевдонима.
type	AliasPatternType	Тип шаблона псевдонима
variable	string	Переменная шаблона псевдонима.

AliasPatternType

Тип шаблона псевдонима

Имя	Тип	Описание
Extract	string	Извлечение является единственным допустимым значением.
NotSpecified	string	NotSpecified не допускается.

AliasType

Тип псевдонима.

Имя	Тип	Описание
Mask	string	Значение псевдонима — secret.
NotSpecified	string	Тип псевдонима неизвестен (то же самое, что тип псевдонима не указан).
PlainText	string	Значение псевдонима не является секретным.

ApiProfile

Имя	Тип	Описание
apiVersion	string	Версия API.
profileVersion	string	Версия профиля.

CloudError

Ответ об ошибке для запроса на управление ресурсами.

Имя	Тип	Описание
error	ErrorResponse	Сообщение об ошибке Общие ответы об ошибках для всех API-интерфейсов Azure Resource Manager возвращать сведения об ошибках для неудачных операций. (Это также соответствует формату ответа об ошибке OData.)

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Тип дополнительных сведений.

ErrorResponse

Сообщение об ошибке

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorResponse[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

Provider

Информация о поставщике ресурсов.

Имя	Тип	Описание
id	string	Идентификатор поставщика.
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[]