Providers - Get

Odwołanie

Usługa:: Resource Management

Wersja interfejsu API:: 2021-04-01

Pobiera określonego dostawcę zasobów.

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

Z parametrami opcjonalnymi:

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
resourceProviderNamespace	path	True	string	Przestrzeń nazw dostawcy zasobów.
subscriptionId	path	True	string	Identyfikator subskrypcji platformy Microsoft Azure.
api-version	query	True	string	Wersja interfejsu API do użycia dla tej operacji.
$expand	query		string	Parametr zapytania $expand. Aby na przykład uwzględnić aliasy właściwości w odpowiedzi, użyj $expand=resourceTypes/aliases.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	Provider	OK — zwraca informacje o dostawcy zasobów.
Other Status Codes	CloudError	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

Get provider.

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:: 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"
    }
  ]
}

Definicje

Nazwa	Opis
Alias	Typ aliasu.
AliasPath	Typ ścieżek dla aliasu.
AliasPathAttributes	Atrybuty tokenu, do którego odwołuje się ścieżka aliasu.
AliasPathMetadata
AliasPathTokenType	Typ tokenu, do którego odwołuje się ścieżka aliasu.
AliasPattern	Typ wzorca dla ścieżki aliasu.
AliasPatternType	Typ wzorca aliasu
AliasType	Typ aliasu.
ApiProfile
CloudError	Odpowiedź na błąd żądania zarządzania zasobami.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorResponse	Odpowiedź na błąd
Provider	Informacje o dostawcy zasobów.
ProviderAuthorizationConsentState	Stan zgody autoryzacji dostawcy.
ProviderExtendedLocation	Lokalizacja rozszerzona dostawcy.
ProviderResourceType	Typ zasobu zarządzany przez dostawcę zasobów.
ZoneMapping

Alias

Typ aliasu.

Nazwa	Typ	Opis
defaultMetadata	AliasPathMetadata	Domyślne metadane ścieżki aliasu. Dotyczy ścieżki domyślnej i do dowolnej ścieżki aliasu, która nie ma metadanych
defaultPath	string	Domyślna ścieżka aliasu.
defaultPattern	AliasPattern	Domyślny wzorzec aliasu.
name	string	Nazwa aliasu.
paths	AliasPath[]	Ścieżki aliasu.
type	AliasType	Typ aliasu.

AliasPath

Typ ścieżek dla aliasu.

Nazwa	Typ	Opis
apiVersions	string[]	Wersje interfejsu API.
metadata	AliasPathMetadata	Metadane ścieżki aliasu. Jeśli brakuje, wróć do domyślnych metadanych aliasu.
path	string	Ścieżka aliasu.
pattern	AliasPattern	Wzorzec ścieżki aliasu.

AliasPathAttributes

Atrybuty tokenu, do którego odwołuje się ścieżka aliasu.

Nazwa	Typ	Opis
Modifiable	string	Token, do którego odwołuje się ścieżka aliasu, można modyfikować przez zasady z efektem "modify".
None	string	Token, do którego odwołuje się ścieżka aliasu, nie ma atrybutów.

AliasPathMetadata

Nazwa	Typ	Opis
attributes	AliasPathAttributes	Atrybuty tokenu, do którego odwołuje się ścieżka aliasu.
type	AliasPathTokenType	Typ tokenu, do którego odwołuje się ścieżka aliasu.

AliasPathTokenType

Typ tokenu, do którego odwołuje się ścieżka aliasu.

Nazwa	Typ	Opis
Any	string	Typ tokenu może być dowolny.
Array	string	Typ tokenu to tablica.
Boolean	string	Typ tokenu to wartość logiczna.
Integer	string	Typ tokenu to liczba całkowita.
NotSpecified	string	Nie określono typu tokenu.
Number	string	Typ tokenu to liczba.
Object	string	Typ tokenu to obiekt.
String	string	Typ tokenu to ciąg.

AliasPattern

Typ wzorca dla ścieżki aliasu.

Nazwa	Typ	Opis
phrase	string	Fraza wzorca aliasu.
type	AliasPatternType	Typ wzorca aliasu
variable	string	Zmienna wzorca aliasu.

AliasPatternType

Typ wzorca aliasu

Nazwa	Typ	Opis
Extract	string	Wyodrębnianie jest jedyną dozwoloną wartością.
NotSpecified	string	Nieokreślone jest niedozwolone.

AliasType

Typ aliasu.

Nazwa	Typ	Opis
Mask	string	Wartość aliasu jest wpisem tajnym.
NotSpecified	string	Typ aliasu jest nieznany (taki sam jak typ aliasu).
PlainText	string	Wartość aliasu nie jest wpisem tajnym.

ApiProfile

Nazwa	Typ	Opis
apiVersion	string	Wersja interfejsu API.
profileVersion	string	Wersja profilu.

CloudError

Odpowiedź na błąd żądania zarządzania zasobami.

Nazwa	Typ	Opis
error	ErrorResponse	Odpowiedź na błąd Typowa odpowiedź na błędy dla wszystkich interfejsów API usługi Azure Resource Manager zwraca szczegóły błędu dla operacji, które zakończyły się niepowodzeniem. (Jest to również zgodne z formatem odpowiedzi na błąd OData).

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorResponse

Odpowiedź na błąd

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorResponse[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

Provider

Informacje o dostawcy zasobów.

Nazwa	Typ	Opis
id	string	Identyfikator dostawcy.
namespace	string	Przestrzeń nazw dostawcy zasobów.
providerAuthorizationConsentState	ProviderAuthorizationConsentState	Stan zgody autoryzacji dostawcy.
registrationPolicy	string	Zasady rejestracji dostawcy zasobów.
registrationState	string	Stan rejestracji dostawcy zasobów.
resourceTypes	ProviderResourceType[]	Kolekcja typów zasobów dostawcy.

ProviderAuthorizationConsentState

Stan zgody autoryzacji dostawcy.

Nazwa	Typ	Opis
Consented	string
NotRequired	string
NotSpecified	string
Required	string

ProviderExtendedLocation

Lokalizacja rozszerzona dostawcy.

Nazwa	Typ	Opis
extendedLocations	string[]	Lokalizacje rozszerzone dla lokalizacji platformy Azure.
location	string	Lokalizacja platformy Azure.
type	string	Typ lokalizacji rozszerzonej.

ProviderResourceType

Typ zasobu zarządzany przez dostawcę zasobów.

Nazwa	Typ	Opis
aliases	Alias[]	Aliasy obsługiwane przez ten typ zasobu.
apiProfiles	ApiProfile[]	Profile interfejsu API dla dostawcy zasobów.
apiVersions	string[]	Wersja interfejsu API.
capabilities	string	Dodatkowe możliwości oferowane przez ten typ zasobu.
defaultApiVersion	string	Domyślna wersja interfejsu API.
locationMappings	ProviderExtendedLocation[]	Mapowania lokalizacji obsługiwane przez ten typ zasobu.
locations	string[]	Kolekcja lokalizacji, w których można utworzyć ten typ zasobu.
properties	object	Właściwości.
resourceType	string	Typ zasobu.
zoneMappings	ZoneMapping[]

ZoneMapping

Nazwa	Typ	Opis
location	string	Lokalizacja mapowania strefy.
zones	string[]

Udostępnij za pośrednictwem