Providers - Get

Riferimento

Servizio:: Resource Management

Versione API:: 2021-04-01

Ottiene il provider di risorse specificato.

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

Con parametri facoltativi:

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
resourceProviderNamespace	path	True	string	Spazio dei nomi del provider di risorse.
subscriptionId	path	True	string	ID sottoscrizione di Microsoft Azure.
api-version	query	True	string	Versione dell'API da usare per questa operazione.
$expand	query		string	Parametro di query $expand. Ad esempio, per includere gli alias delle proprietà in risposta, usare $expand=resourceTypes/aliases.

Risposte

Nome	Tipo	Descrizione
200 OK	Provider	OK: restituisce informazioni sul provider di risorse.
Other Status Codes	CloudError	Risposta di errore che descrive perché l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

Get provider.

Esempio di richiesta

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

Risposta di esempio

Codice di stato:: 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"
    }
  ]
}

Definizioni

Nome	Descrizione
Alias	Tipo di alias.
AliasPath	Tipo dei percorsi per alias.
AliasPathAttributes	Attributi del token a cui fa riferimento il percorso alias.
AliasPathMetadata
AliasPathTokenType	Tipo del token a cui fa riferimento il percorso alias.
AliasPattern	Tipo del modello per un percorso alias.
AliasPatternType	Tipo di modello alias
AliasType	Tipo dell'alias.
ApiProfile
CloudError	Risposta di errore per una richiesta di gestione delle risorse.
ErrorAdditionalInfo	Informazioni aggiuntive sulla gestione delle risorse.
ErrorResponse	Risposta di errore
Provider	Informazioni sul provider di risorse.
ProviderAuthorizationConsentState	Stato di consenso dell'autorizzazione del provider.
ProviderExtendedLocation	Percorso esteso del provider.
ProviderResourceType	Tipo di risorsa gestito dal provider di risorse.
ZoneMapping

Alias

Tipo di alias.

Nome	Tipo	Descrizione
defaultMetadata	AliasPathMetadata	Metadati predefiniti del percorso alias. Si applica al percorso predefinito e a qualsiasi percorso alias che non dispone di metadati
defaultPath	string	Percorso predefinito per un alias.
defaultPattern	AliasPattern	Modello predefinito per un alias.
name	string	Nome alias.
paths	AliasPath[]	Percorsi per un alias.
type	AliasType	Tipo dell'alias.

AliasPath

Tipo dei percorsi per alias.

Nome	Tipo	Descrizione
apiVersions	string[]	Versioni dell'API.
metadata	AliasPathMetadata	Metadati del percorso alias. Se mancante, tornare ai metadati predefiniti dell'alias.
path	string	Percorso di un alias.
pattern	AliasPattern	Modello per un percorso alias.

AliasPathAttributes

Attributi del token a cui fa riferimento il percorso alias.

Nome	Tipo	Descrizione
Modifiable	string	Il token a cui fa riferimento il percorso alias è modificabile dai criteri con effetto "modifica".
None	string	Il token a cui fa riferimento il percorso alias non ha attributi.

AliasPathMetadata

Nome	Tipo	Descrizione
attributes	AliasPathAttributes	Attributi del token a cui fa riferimento il percorso alias.
type	AliasPathTokenType	Tipo del token a cui fa riferimento il percorso alias.

AliasPathTokenType

Tipo del token a cui fa riferimento il percorso alias.

Nome	Tipo	Descrizione
Any	string	Il tipo di token può essere qualsiasi elemento.
Array	string	Il tipo di token è matrice.
Boolean	string	Il tipo di token è booleano.
Integer	string	Il tipo di token è integer.
NotSpecified	string	Il tipo di token non è specificato.
Number	string	Il tipo di token è numero.
Object	string	Il tipo di token è oggetto.
String	string	Il tipo di token è stringa.

AliasPattern

Tipo del modello per un percorso alias.

Nome	Tipo	Descrizione
phrase	string	Frase del modello alias.
type	AliasPatternType	Tipo di modello alias
variable	string	Variabile del modello alias.

AliasPatternType

Tipo di modello alias

Nome	Tipo	Descrizione
Extract	string	L'estrazione è l'unico valore consentito.
NotSpecified	string	NotSpecified non è consentito.

AliasType

Tipo dell'alias.

Nome	Tipo	Descrizione
Mask	string	Il valore dell'alias è segreto.
NotSpecified	string	Il tipo di alias è sconosciuto (come non specificare il tipo di alias).
PlainText	string	Il valore dell'alias non è segreto.

ApiProfile

Nome	Tipo	Descrizione
apiVersion	string	La versione delle API.
profileVersion	string	Versione del profilo.

CloudError

Risposta di errore per una richiesta di gestione delle risorse.

Nome	Tipo	Descrizione
error	ErrorResponse	Risposta di errore Risposta di errore comune per tutte le API di Resource Manager di Azure per restituire i dettagli degli errori per le operazioni non riuscite. Questo segue anche il formato di risposta di errore OData.

ErrorAdditionalInfo

Informazioni aggiuntive sulla gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorResponse

Risposta di errore

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorResponse[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

Provider

Informazioni sul provider di risorse.

Nome	Tipo	Descrizione
id	string	ID del provider.
namespace	string	Spazio dei nomi del provider di risorse.
providerAuthorizationConsentState	ProviderAuthorizationConsentState	Stato di consenso dell'autorizzazione del provider.
registrationPolicy	string	Criterio di registrazione del provider di risorse.
registrationState	string	Stato di registrazione del provider di risorse.
resourceTypes	ProviderResourceType[]	Raccolta di tipi di risorse del provider.

ProviderAuthorizationConsentState

Stato di consenso dell'autorizzazione del provider.

Nome	Tipo	Descrizione
Consented	string
NotRequired	string
NotSpecified	string
Required	string

ProviderExtendedLocation

Percorso esteso del provider.

Nome	Tipo	Descrizione
extendedLocations	string[]	Posizioni estese per la posizione di Azure.
location	string	Posizione di Azure.
type	string	Tipo di percorso esteso.

ProviderResourceType

Tipo di risorsa gestito dal provider di risorse.

Nome	Tipo	Descrizione
aliases	Alias[]	Alias supportati da questo tipo di risorsa.
apiProfiles	ApiProfile[]	Profili API per il provider di risorse.
apiVersions	string[]	La versione delle API.
capabilities	string	Le funzionalità aggiuntive offerte da questo tipo di risorsa.
defaultApiVersion	string	Versione dell'API predefinita.
locationMappings	ProviderExtendedLocation[]	Mapping dei percorsi supportati da questo tipo di risorsa.
locations	string[]	Raccolta di posizioni in cui è possibile creare questo tipo di risorsa.
properties	object	Proprietà.
resourceType	string	Tipo di risorsa.
zoneMappings	ZoneMapping[]

ZoneMapping

Nome	Tipo	Descrizione
location	string	Posizione del mapping della zona.
zones	string[]

Condividi tramite