Providers - Get

Referenz

Dienst:: Resource Management

API-Version:: 2021-04-01

Ruft den angegebenen Ressourcenanbieter ab.

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

Mit optionalen Parametern:

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
resourceProviderNamespace	path	True	string	Der Namespace des Ressourcenanbieters.
subscriptionId	path	True	string	Die Microsoft Azure-Abonnement-ID.
api-version	query	True	string	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.
$expand	query		string	Der abfrageparameter $expand. Verwenden Sie beispielsweise $expand=resourceTypes/aliases, um als Antwort Eigenschaftenaliasen einzuschließen.

Antworten

Name	Typ	Beschreibung
200 OK	Provider	OK: Gibt Informationen zum Ressourcenanbieter zurück.
Other Status Codes	CloudError	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

Get provider.

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name	Beschreibung
Alias	Der Aliastyp.
AliasPath	Der Typ der Pfade für den Alias.
AliasPathAttributes	Die Attribute des Tokens, auf das der Aliaspfad verweist.
AliasPathMetadata
AliasPathTokenType	Der Typ des Tokens, auf das sich der Aliaspfad bezieht.
AliasPattern	Der Typ des Musters für einen Aliaspfad.
AliasPatternType	Typ des Aliasmusters
AliasType	Der Typ de Alias.
ApiProfile
CloudError	Eine Fehlerantwort für eine Ressourcenverwaltungsanforderung.
ErrorAdditionalInfo	Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
ErrorResponse	Fehlerantwort
Provider	Informationen zum Ressourcenanbieter.
ProviderAuthorizationConsentState	Der Autorisierungsstatus des Anbieters.
ProviderExtendedLocation	Der erweiterte Standort des Anbieters.
ProviderResourceType	Durch den Ressourcenanbieter verwalteter Ressourcentyp.
ZoneMapping

Alias

Der Aliastyp.

Name	Typ	Beschreibung
defaultMetadata	AliasPathMetadata	Die Standard-Aliaspfadmetadaten. Gilt für den Standardpfad und für jeden Aliaspfad, der keine Metadaten enthält.
defaultPath	string	Der Standardpfad für einen Alias.
defaultPattern	AliasPattern	Das Standardmuster für einen Alias.
name	string	Der Aliasname.
paths	AliasPath[]	Die Pfade für einen Alias.
type	AliasType	Der Typ de Alias.

AliasPath

Der Typ der Pfade für den Alias.

Name	Typ	Beschreibung
apiVersions	string[]	Die API-Versionen.
metadata	AliasPathMetadata	Die Metadaten des Aliaspfads. Falls nicht vorhanden, greifen Sie auf die Standardmetadaten des Alias zurück.
path	string	Der Pfad eines Alias.
pattern	AliasPattern	Das Muster für einen Aliaspfad.

AliasPathAttributes

Die Attribute des Tokens, auf das der Aliaspfad verweist.

Name	Typ	Beschreibung
Modifiable	string	Das Token, auf das sich der Aliaspfad bezieht, kann durch Richtlinien mit dem Effekt "modify" geändert werden.
None	string	Das Token, auf das der Aliaspfad verweist, weist keine Attribute auf.

AliasPathMetadata

Name	Typ	Beschreibung
attributes	AliasPathAttributes	Die Attribute des Tokens, auf das der Aliaspfad verweist.
type	AliasPathTokenType	Der Typ des Tokens, auf das sich der Aliaspfad bezieht.

AliasPathTokenType

Der Typ des Tokens, auf das sich der Aliaspfad bezieht.

Name	Typ	Beschreibung
Any	string	Der Tokentyp kann beliebig sein.
Array	string	Der Tokentyp ist array.
Boolean	string	Der Tokentyp ist boolescher Wert.
Integer	string	Der Tokentyp ist integer.
NotSpecified	string	Der Tokentyp ist nicht angegeben.
Number	string	Der Tokentyp ist number.
Object	string	Der Tokentyp ist object.
String	string	Der Tokentyp ist Zeichenfolge.

AliasPattern

Der Typ des Musters für einen Aliaspfad.

Name	Typ	Beschreibung
phrase	string	Der Aliasmusterausdruck.
type	AliasPatternType	Typ des Aliasmusters
variable	string	Die Aliasmustervariable.

AliasPatternType

Typ des Aliasmusters

Name	Typ	Beschreibung
Extract	string	Extrahieren ist der einzige zulässige Wert.
NotSpecified	string	NotSpecified ist nicht zulässig.

AliasType

Der Typ de Alias.

Name	Typ	Beschreibung
Mask	string	Der Aliaswert ist geheimnis.
NotSpecified	string	Der Aliastyp ist unbekannt (identisch mit der Angabe des Aliastyps).
PlainText	string	Der Aliaswert ist kein Geheimnis.

ApiProfile

Name	Typ	Beschreibung
apiVersion	string	Die API-Version.
profileVersion	string	Die Profilversion.

CloudError

Eine Fehlerantwort für eine Ressourcenverwaltungsanforderung.

Name	Typ	Beschreibung
error	ErrorResponse	Fehlerantwort Allgemeine Fehlerantwort für alle Azure Resource Manager-APIs, zur Rückgabe von Fehlerdetails für fehlgeschlagene Vorgänge. (Dies folgt auch dem OData-Fehlerantwortformat.)

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

Name	Typ	Beschreibung
info	object	Zusätzliche Informationen.
type	string	Typ der zusätzlichen Informationen.

ErrorResponse

Fehlerantwort

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Fehlerinformationen.
code	string	Der Fehlercode.
details	ErrorResponse[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

Provider

Informationen zum Ressourcenanbieter.

Name	Typ	Beschreibung
id	string	Die Anbieter-ID.
namespace	string	Der Namespace des Ressourcenanbieters.
providerAuthorizationConsentState	ProviderAuthorizationConsentState	Der Autorisierungsstatus des Anbieters.
registrationPolicy	string	Die Registrierungsrichtlinie des Ressourcenanbieters.
registrationState	string	Der Registrierungsstatus des Ressourcenanbieters.
resourceTypes	ProviderResourceType[]	Die Auflistung von Anbieterressourcentypen.

ProviderAuthorizationConsentState

Der Autorisierungsstatus des Anbieters.

Name	Typ	Beschreibung
Consented	string
NotRequired	string
NotSpecified	string
Required	string

ProviderExtendedLocation

Der erweiterte Standort des Anbieters.

Name	Typ	Beschreibung
extendedLocations	string[]	Die erweiterten Speicherorte für den Azure-Standort.
location	string	Der Azure-Standort.
type	string	Der erweiterte Standorttyp.

ProviderResourceType

Durch den Ressourcenanbieter verwalteter Ressourcentyp.

Name	Typ	Beschreibung
aliases	Alias[]	Die Aliase, die von diesem Ressourcentyp unterstützt werden.
apiProfiles	ApiProfile[]	Die API-Profile für den Ressourcenanbieter.
apiVersions	string[]	Die API-Version.
capabilities	string	Die zusätzlichen Funktionen, die von diesem Ressourcentyp angeboten werden.
defaultApiVersion	string	Die Standard-API-Version.
locationMappings	ProviderExtendedLocation[]	Die Von diesem Ressourcentyp unterstützten Standortzuordnungen.
locations	string[]	Die Auflistung der Speicherorte, an denen dieser Ressourcentyp erstellt werden kann.
properties	object	Die Eigenschaften.
resourceType	string	Der Ressourcentyp.
zoneMappings	ZoneMapping[]

ZoneMapping

Name	Typ	Beschreibung
location	string	Der Speicherort der Zonenzuordnung.
zones	string[]

Freigeben über