Custom Resource Provider - List By Resource Group

Referência

Serviço:: Custom Providers

Versão da API:: 2018-09-01-preview

Obtém todos os provedores de recursos personalizados em um grupo de recursos.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders?api-version=2018-09-01-preview

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
resourceGroupName	path	True	string	O nome do grupo de recursos.
subscriptionId	path	True	string	A ID da assinatura do Azure. Esta é uma cadeia de caracteres formatada por GUID (por exemplo, 000000000-0000-0000-0000-000000000000000)
api-version	query	True	string	A versão da API a ser usada com a solicitação HTTP.

Respostas

Nome	Tipo	Description
200 OK	ListByCustomRPManifest	OK - Retorna uma matriz de provedores de recursos personalizados.
Other Status Codes	ErrorResponse	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

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

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

List all custom resource providers on the resourceGroup

Solicitação de exemplo

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.CustomProviders/resourceProviders?api-version=2018-09-01-preview

from azure.identity import DefaultAzureCredential
from azure.mgmt.customproviders import Customproviders

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-customproviders
# USAGE
    python list_all_custom_resource_providers_on_the_resource_group.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = Customproviders(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.custom_resource_provider.list_by_resource_group(
        resource_group_name="testRG",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/customproviders/resource-manager/Microsoft.CustomProviders/preview/2018-09-01-preview/examples/listCustomRPsByResourceGroup.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armcustomproviders_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/customproviders/armcustomproviders"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/customproviders/resource-manager/Microsoft.CustomProviders/preview/2018-09-01-preview/examples/listCustomRPsByResourceGroup.json
func ExampleCustomResourceProviderClient_NewListByResourceGroupPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcustomproviders.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewCustomResourceProviderClient().NewListByResourceGroupPager("testRG", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ListByCustomRPManifest = armcustomproviders.ListByCustomRPManifest{
		// 	Value: []*armcustomproviders.CustomRPManifest{
		// 		{
		// 			Name: to.Ptr("newrp1"),
		// 			Type: to.Ptr("Microsoft.CustomProviders/resourceProviders"),
		// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.CustomProviders/resourceProviders/newrp1"),
		// 			Location: to.Ptr("East US"),
		// 			Properties: &armcustomproviders.CustomRPManifestProperties{
		// 				Actions: []*armcustomproviders.CustomRPActionRouteDefinition{
		// 					{
		// 						Name: to.Ptr("TestAction"),
		// 						Endpoint: to.Ptr("https://mytestendpoint/"),
		// 						RoutingType: to.Ptr(armcustomproviders.ActionRoutingProxy),
		// 				}},
		// 				ProvisioningState: to.Ptr(armcustomproviders.ProvisioningStateSucceeded),
		// 				ResourceTypes: []*armcustomproviders.CustomRPResourceTypeRouteDefinition{
		// 					{
		// 						Name: to.Ptr("TestResource"),
		// 						Endpoint: to.Ptr("https://mytestendpoint2/"),
		// 						RoutingType: to.Ptr(armcustomproviders.ResourceTypeRoutingProxyCache),
		// 				}},
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("newrp2"),
		// 			Type: to.Ptr("Microsoft.CustomProviders/resourceProviders"),
		// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.CustomProviders/resourceProviders/newrp2"),
		// 			Location: to.Ptr("East US"),
		// 			Properties: &armcustomproviders.CustomRPManifestProperties{
		// 				Actions: []*armcustomproviders.CustomRPActionRouteDefinition{
		// 					{
		// 						Name: to.Ptr("TestAction"),
		// 						Endpoint: to.Ptr("https://mytestendpoint/"),
		// 						RoutingType: to.Ptr(armcustomproviders.ActionRoutingProxy),
		// 				}},
		// 				ProvisioningState: to.Ptr(armcustomproviders.ProvisioningStateSucceeded),
		// 				ResourceTypes: []*armcustomproviders.CustomRPResourceTypeRouteDefinition{
		// 					{
		// 						Name: to.Ptr("TestResource"),
		// 						Endpoint: to.Ptr("https://mytestendpoint2/"),
		// 						RoutingType: to.Ptr(armcustomproviders.ResourceTypeRoutingProxyCache),
		// 				}},
		// 			},
		// 	}},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Resposta de exemplo

Código de status:: 200

{
  "value": [
    {
      "name": "newrp1",
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.CustomProviders/resourceProviders/newrp1",
      "type": "Microsoft.CustomProviders/resourceProviders",
      "location": "East US",
      "properties": {
        "provisioningState": "Succeeded",
        "actions": [
          {
            "name": "TestAction",
            "routingType": "Proxy",
            "endpoint": "https://mytestendpoint/"
          }
        ],
        "resourceTypes": [
          {
            "name": "TestResource",
            "routingType": "Proxy,Cache",
            "endpoint": "https://mytestendpoint2/"
          }
        ]
      }
    },
    {
      "name": "newrp2",
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.CustomProviders/resourceProviders/newrp2",
      "type": "Microsoft.CustomProviders/resourceProviders",
      "location": "East US",
      "properties": {
        "provisioningState": "Succeeded",
        "actions": [
          {
            "name": "TestAction",
            "routingType": "Proxy",
            "endpoint": "https://mytestendpoint/"
          }
        ],
        "resourceTypes": [
          {
            "name": "TestResource",
            "routingType": "Proxy,Cache",
            "endpoint": "https://mytestendpoint2/"
          }
        ]
      }
    }
  ]
}

Definições

Nome	Description
ActionRouting	Os tipos de roteamento com suporte para solicitações de ação.
CustomRPActionRouteDefinition	A definição de rota para uma ação implementada pelo provedor de recursos personalizado.
CustomRPManifest	Um arquivo de manifesto que define os recursos personalizados do provedor de recursos.
CustomRPResourceTypeRouteDefinition	A definição de rota para um recurso implementado pelo provedor de recursos personalizado.
CustomRPValidations	Uma validação a ser aplicada em solicitações personalizadas do provedor de recursos.
ErrorDefinition	Definição de erro.
ErrorResponse	Resposta de erro.
ListByCustomRPManifest	Lista de provedores de recursos personalizados.
ProvisioningState	O estado de provisionamento do provedor de recursos.
ResourceTypeRouting	Os tipos de roteamento com suporte para solicitações de recursos.
ValidationType	O tipo de validação a ser executado em uma solicitação correspondente.

ActionRouting

Enumeração

Os tipos de roteamento com suporte para solicitações de ação.

Valor	Description
Proxy

CustomRPActionRouteDefinition

Objeto

A definição de rota para uma ação implementada pelo provedor de recursos personalizado.

Nome	Tipo	Description
endpoint	string pattern: ^https://.+	O URI do ponto de extremidade de definição de rota para o qual o provedor de recursos personalizado será solicitado por proxy. Isso pode estar na forma de um URI simples (por exemplo, 'https://testendpoint/') ou pode especificar para rotear por meio de um caminho (por exemplo, 'https://testendpoint/{requestPath}')
name	string	O nome da definição da rota. Isso se torna o nome da extensão do ARM (por exemplo, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/{name}')
routingType	ActionRouting	Os tipos de roteamento com suporte para solicitações de ação.

CustomRPManifest

Objeto

Um arquivo de manifesto que define os recursos personalizados do provedor de recursos.

Nome	Tipo	Description
id	string	ID do recurso
location	string	Local do recurso
name	string	Nome do recurso
properties.actions	CustomRPActionRouteDefinition[]	Uma lista de ações que o provedor de recursos personalizado implementa.
properties.provisioningState	ProvisioningState	O estado de provisionamento do provedor de recursos.
properties.resourceTypes	CustomRPResourceTypeRouteDefinition[]	Uma lista de tipos de recursos que o provedor de recursos personalizado implementa.
properties.validations	CustomRPValidations[]	Uma lista de validações a serem executadas nas solicitações do provedor de recursos personalizado.
tags	object	Etiquetas de recursos
type	string	Tipo de recurso

CustomRPResourceTypeRouteDefinition

Objeto

A definição de rota para um recurso implementado pelo provedor de recursos personalizado.

Nome	Tipo	Description
endpoint	string pattern: ^https://.+	O URI do ponto de extremidade de definição de rota para o qual o provedor de recursos personalizado será solicitado por proxy. Isso pode estar na forma de um URI simples (por exemplo, 'https://testendpoint/') ou pode especificar para rotear por meio de um caminho (por exemplo, 'https://testendpoint/{requestPath}')
name	string	O nome da definição da rota. Isso se torna o nome da extensão do ARM (por exemplo, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/{name}')
routingType	ResourceTypeRouting	Os tipos de roteamento com suporte para solicitações de recursos.

CustomRPValidations

Objeto

Uma validação a ser aplicada em solicitações personalizadas do provedor de recursos.

Nome	Tipo	Description
specification	string pattern: ^https://raw.githubusercontent.com/.+	Um link para a especificação de validação. A especificação deve ser hospedada no raw.githubusercontent.com.
validationType	ValidationType	O tipo de validação a ser executado em uma solicitação correspondente.

ErrorDefinition

Objeto

Definição de erro.

Nome	Tipo	Description
code	string	Código de erro específico do serviço que serve como substatus para o código de erro HTTP.
details	ErrorDefinition[]	Detalhes internos do erro.
message	string	Descrição do erro.

ErrorResponse

Objeto

Resposta de erro.

Nome	Tipo	Description
error	ErrorDefinition	Os detalhes do erro.

ListByCustomRPManifest

Objeto

Lista de provedores de recursos personalizados.

Nome	Tipo	Description
nextLink	string	A URL a ser usada para obter o próximo conjunto de resultados.
value	CustomRPManifest[]	A matriz de manifestos personalizados do provedor de recursos.

ProvisioningState

Enumeração

O estado de provisionamento do provedor de recursos.

Valor	Description
Accepted
Deleting
Failed
Running
Succeeded

ResourceTypeRouting

Enumeração

Os tipos de roteamento com suporte para solicitações de recursos.

Valor	Description
Proxy
Proxy,Cache

ValidationType

Enumeração

O tipo de validação a ser executado em uma solicitação correspondente.

Valor	Description
Swagger

Compartilhar via

Custom Resource Provider - List By Resource Group

Parâmetros de URI

Respostas

Segurança

azure_auth

Escopos

Exemplos

List all custom resource providers on the resourceGroup

Solicitação de exemplo

Resposta de exemplo

Definições

ActionRouting

CustomRPActionRouteDefinition

CustomRPManifest

CustomRPResourceTypeRouteDefinition

CustomRPValidations

ErrorDefinition

ErrorResponse

ListByCustomRPManifest

ProvisioningState

ResourceTypeRouting

ValidationType