Providers - Get

Referência

Serviço:: Resource Management

Versão da API:: 2021-04-01

Obtém o fornecedor de recursos especificado.

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

Com parâmetros opcionais:

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
resourceProviderNamespace	path	True	string	O espaço de nomes do fornecedor de recursos.
subscriptionId	path	True	string	O ID da subscrição do Microsoft Azure.
api-version	query	True	string	A versão da API a utilizar para esta operação.
$expand	query		string	O parâmetro de consulta $expand. Por exemplo, para incluir aliases de propriedade em resposta, utilize $expand=resourceTypes/aliases.

Respostas

Name	Tipo	Description
200 OK	Provider	OK - Devolve informações sobre o fornecedor de recursos.
Other Status Codes	CloudError	Resposta de erro que descreve o motivo pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

Get provider.

Pedido de amostra

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

Resposta da amostra

Código de estado:: 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"
    }
  ]
}

Definições

Name	Description
Alias	O tipo de alias.
AliasPath	O tipo de caminhos para alias.
AliasPathAttributes	Os atributos do token a que o caminho do alias se refere.
AliasPathMetadata
AliasPathTokenType	O tipo de token a que o caminho do alias se refere.
AliasPattern	O tipo do padrão para um caminho de alias.
AliasPatternType	O tipo de padrão de alias
AliasType	O tipo de alias.
ApiProfile
CloudError	Uma resposta de erro para um pedido de gestão de recursos.
ErrorAdditionalInfo	Informações adicionais sobre o erro de gestão de recursos.
ErrorResponse	Resposta a Erros
Provider	Informações do fornecedor de recursos.
ProviderAuthorizationConsentState	O estado de consentimento da autorização do fornecedor.
ProviderExtendedLocation	A localização expandida do fornecedor.
ProviderResourceType	Tipo de recurso gerido pelo fornecedor de recursos.
ZoneMapping

Alias

O tipo de alias.

Name	Tipo	Description
defaultMetadata	AliasPathMetadata	Os metadados do caminho do alias predefinido. Aplica-se ao caminho predefinido e a qualquer caminho de alias que não tenha metadados
defaultPath	string	O caminho predefinido para um alias.
defaultPattern	AliasPattern	O padrão predefinido para um alias.
name	string	O nome do alias.
paths	AliasPath[]	Os caminhos para um alias.
type	AliasType	O tipo de alias.

AliasPath

O tipo de caminhos para alias.

Name	Tipo	Description
apiVersions	string[]	As versões da API.
metadata	AliasPathMetadata	Os metadados do caminho do alias. Se estiver em falta, recue para os metadados predefinidos do alias.
path	string	O caminho de um alias.
pattern	AliasPattern	O padrão para um caminho de alias.

AliasPathAttributes

Os atributos do token a que o caminho do alias se refere.

Name	Tipo	Description
Modifiable	string	O token a que o caminho do alias se refere é modificável por políticas com efeito "modificar".
None	string	O token a que o caminho do alias se refere não tem atributos.

AliasPathMetadata

Name	Tipo	Description
attributes	AliasPathAttributes	Os atributos do token a que o caminho do alias se refere.
type	AliasPathTokenType	O tipo de token a que o caminho do alias se refere.

AliasPathTokenType

O tipo de token a que o caminho do alias se refere.

Name	Tipo	Description
Any	string	O tipo de token pode ser qualquer coisa.
Array	string	O tipo de token é matriz.
Boolean	string	O tipo de token é booleano.
Integer	string	O tipo de token é número inteiro.
NotSpecified	string	O tipo de token não está especificado.
Number	string	O tipo de token é número.
Object	string	O tipo de token é objeto.
String	string	O tipo de token é cadeia.

AliasPattern

O tipo do padrão para um caminho de alias.

Name	Tipo	Description
phrase	string	A expressão de padrão de alias.
type	AliasPatternType	O tipo de padrão de alias
variable	string	A variável de padrão de alias.

AliasPatternType

O tipo de padrão de alias

Name	Tipo	Description
Extract	string	Extrair é o único valor permitido.
NotSpecified	string	NotSpecified não é permitido.

AliasType

O tipo de alias.

Name	Tipo	Description
Mask	string	O valor do alias é secreto.
NotSpecified	string	O tipo de alias é desconhecido (o mesmo que não fornecer o tipo de alias).
PlainText	string	O valor do alias não é secreto.

ApiProfile

Name	Tipo	Description
apiVersion	string	A versão da API.
profileVersion	string	A versão do perfil.

CloudError

Uma resposta de erro para um pedido de gestão de recursos.

Name	Tipo	Description
error	ErrorResponse	Resposta a Erros Resposta de erro comum para todas as APIs do Azure Resource Manager para devolver detalhes do erro para operações com falhas. (Isto também segue o formato de resposta de erro OData.)

ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informações adicionais.

ErrorResponse

Resposta a Erros

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorResponse[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

Provider

Informações do fornecedor de recursos.

Name	Tipo	Description
id	string	O ID do fornecedor.
namespace	string	O espaço de nomes do fornecedor de recursos.
providerAuthorizationConsentState	ProviderAuthorizationConsentState	O estado de consentimento da autorização do fornecedor.
registrationPolicy	string	A política de registo do fornecedor de recursos.
registrationState	string	O estado de registo do fornecedor de recursos.
resourceTypes	ProviderResourceType[]	A coleção de tipos de recursos de fornecedor.

ProviderAuthorizationConsentState

O estado de consentimento da autorização do fornecedor.

Name	Tipo	Description
Consented	string
NotRequired	string
NotSpecified	string
Required	string

ProviderExtendedLocation

A localização expandida do fornecedor.

Name	Tipo	Description
extendedLocations	string[]	As localizações expandidas para a localização do Azure.
location	string	A localização do azure.
type	string	O tipo de localização expandida.

ProviderResourceType

Tipo de recurso gerido pelo fornecedor de recursos.

Name	Tipo	Description
aliases	Alias[]	Os aliases suportados por este tipo de recurso.
apiProfiles	ApiProfile[]	Os perfis de API do fornecedor de recursos.
apiVersions	string[]	A versão da API.
capabilities	string	As capacidades adicionais oferecidas por este tipo de recurso.
defaultApiVersion	string	A versão predefinida da API.
locationMappings	ProviderExtendedLocation[]	Os mapeamentos de localização suportados por este tipo de recurso.
locations	string[]	A coleção de localizações onde este tipo de recurso pode ser criado.
properties	object	As propriedades.
resourceType	string	O tipo de recurso.
zoneMappings	ZoneMapping[]

ZoneMapping

Name	Tipo	Description
location	string	A localização do mapeamento da zona.
zones	string[]

Partilhar via