Providers - Get

Référence

Service:: Resource Management

Version d'API:: 2021-04-01

Obtient le fournisseur de ressources spécifié.

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

Avec des paramètres facultatifs:

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
resourceProviderNamespace	path	True	string	Espace de noms du fournisseur de ressources.
subscriptionId	path	True	string	ID d’abonnement Microsoft Azure.
api-version	query	True	string	Version de l’API à utiliser pour cette opération.
$expand	query		string	Paramètre de requête $expand. Par exemple, pour inclure des alias de propriété dans la réponse, utilisez $expand=resourceTypes/aliases.

Réponses

Nom	Type	Description
200 OK	Provider	OK : retourne des informations sur le fournisseur de ressources.
Other Status Codes	CloudError	Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

Get provider.

Exemple de requête

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

Exemple de réponse

Code d’état:: 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"
    }
  ]
}

Définitions

Nom	Description
Alias	Type d’alias.
AliasPath	Type des chemins d’accès pour alias.
AliasPathAttributes	Attributs du jeton auquel le chemin d’alias fait référence.
AliasPathMetadata
AliasPathTokenType	Type du jeton auquel le chemin d’alias fait référence.
AliasPattern	Type du modèle d’un chemin d’alias.
AliasPatternType	Type de modèle d’alias
AliasType	Type de l'alias.
ApiProfile
CloudError	Réponse d’erreur pour une demande de gestion des ressources.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorResponse	Réponse d’erreur
Provider	Informations sur le fournisseur de ressources.
ProviderAuthorizationConsentState	État du consentement d’autorisation du fournisseur.
ProviderExtendedLocation	Emplacement étendu du fournisseur.
ProviderResourceType	Type de ressource géré par le fournisseur de ressources.
ZoneMapping

Alias

Type d’alias.

Nom	Type	Description
defaultMetadata	AliasPathMetadata	Métadonnées de chemin d’alias par défaut. S’applique au chemin par défaut et à n’importe quel chemin d’alias qui n’a pas de métadonnées
defaultPath	string	Chemin par défaut d’un alias.
defaultPattern	AliasPattern	Modèle par défaut pour un alias.
name	string	Nom de l’alias.
paths	AliasPath[]	Chemins d’accès d’un alias.
type	AliasType	Type de l'alias.

AliasPath

Type des chemins d’accès pour alias.

Nom	Type	Description
apiVersions	string[]	Versions de l’API.
metadata	AliasPathMetadata	Métadonnées du chemin d’alias. En cas d’absence, revenez aux métadonnées par défaut de l’alias.
path	string	Chemin d’accès d’un alias.
pattern	AliasPattern	Modèle d’un chemin d’alias.

AliasPathAttributes

Attributs du jeton auquel le chemin d’alias fait référence.

Nom	Type	Description
Modifiable	string	Le jeton auquel le chemin d’alias fait référence est modifiable par les stratégies avec effet « modifier ».
None	string	Le jeton auquel le chemin d’alias fait référence n’a aucun attribut.

AliasPathMetadata

Nom	Type	Description
attributes	AliasPathAttributes	Attributs du jeton auquel le chemin d’alias fait référence.
type	AliasPathTokenType	Type du jeton auquel le chemin d’alias fait référence.

AliasPathTokenType

Type du jeton auquel le chemin d’alias fait référence.

Nom	Type	Description
Any	string	Le type de jeton peut être n’importe quoi.
Array	string	Le type de jeton est tableau.
Boolean	string	Le type de jeton est booléen.
Integer	string	Le type de jeton est entier.
NotSpecified	string	Le type de jeton n’est pas spécifié.
Number	string	Le type de jeton est number.
Object	string	Le type de jeton est objet.
String	string	Le type de jeton est string.

AliasPattern

Type du modèle d’un chemin d’alias.

Nom	Type	Description
phrase	string	Expression de modèle d’alias.
type	AliasPatternType	Type de modèle d’alias
variable	string	Variable de modèle d’alias.

AliasPatternType

Type de modèle d’alias

Nom	Type	Description
Extract	string	Extraire est la seule valeur autorisée.
NotSpecified	string	NotSpecified n’est pas autorisé.

AliasType

Type de l'alias.

Nom	Type	Description
Mask	string	La valeur de l’alias est secret.
NotSpecified	string	Le type d’alias est inconnu (identique à ne pas fournir de type d’alias).
PlainText	string	La valeur de l’alias n’est pas secrète.

ApiProfile

Nom	Type	Description
apiVersion	string	Version de l'API.
profileVersion	string	Version du profil.

CloudError

Réponse d’erreur pour une demande de gestion des ressources.

Nom	Type	Description
error	ErrorResponse	Réponse d’erreur Réponse d’erreur courante pour toutes les API Azure Resource Manager pour retourner les détails de l’erreur concernant les opérations ayant échoué. (Cela suit également le format de réponse d’erreur OData.)

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires
type	string	Type d’informations supplémentaires.

ErrorResponse

Réponse d’erreur

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d'erreur.
details	ErrorResponse[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

Provider

Informations sur le fournisseur de ressources.

Nom	Type	Description
id	string	ID du fournisseur.
namespace	string	Espace de noms du fournisseur de ressources.
providerAuthorizationConsentState	ProviderAuthorizationConsentState	État du consentement d’autorisation du fournisseur.
registrationPolicy	string	Stratégie d’inscription du fournisseur de ressources.
registrationState	string	État d’inscription du fournisseur de ressources.
resourceTypes	ProviderResourceType[]	Collection de types de ressources de fournisseur.

ProviderAuthorizationConsentState

État du consentement d’autorisation du fournisseur.

Nom	Type	Description
Consented	string
NotRequired	string
NotSpecified	string
Required	string

ProviderExtendedLocation

Emplacement étendu du fournisseur.

Nom	Type	Description
extendedLocations	string[]	Emplacements étendus pour l’emplacement Azure.
location	string	Emplacement Azure.
type	string	Type d’emplacement étendu.

ProviderResourceType

Type de ressource géré par le fournisseur de ressources.

Nom	Type	Description
aliases	Alias[]	Alias pris en charge par ce type de ressource.
apiProfiles	ApiProfile[]	Profils d’API pour le fournisseur de ressources.
apiVersions	string[]	Version de l'API.
capabilities	string	Fonctionnalités supplémentaires offertes par ce type de ressource.
defaultApiVersion	string	Version de l’API par défaut.
locationMappings	ProviderExtendedLocation[]	Mappages d’emplacements pris en charge par ce type de ressource.
locations	string[]	Collection d’emplacements où ce type de ressource peut être créé.
properties	object	Propriétés.
resourceType	string	Type de ressource.
zoneMappings	ZoneMapping[]

ZoneMapping

Nom	Type	Description
location	string	Emplacement du mappage de zone.
zones	string[]

Partager via