Custom Resource Provider - List By Resource Group

Başvuru

Hizmet:: Custom Providers

API Sürümü:: 2018-09-01-preview

Bir kaynak grubu içindeki tüm özel kaynak sağlayıcılarını alır.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
resourceGroupName	path	True	string	Kaynak grubunun adı.
subscriptionId	path	True	string	Azure abonelik kimliği. Bu GUID biçimli bir dizedir (ör. 000000000-0000-0000-0000-0000000000000)
api-version	query	True	string	HTTP isteğiyle kullanılacak API sürümü.

Yanıtlar

Name	Tür	Description
200 OK	ListByCustomRPManifest	Tamam - Özel kaynak sağlayıcıları dizisi döndürür.
Other Status Codes	ErrorResponse	İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Flow

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize

Kapsamlar

Name	Description
user_impersonation	kullanıcı hesabınızın kimliğine bürünme

Örnekler

List all custom resource providers on the resourceGroup

Örnek isteği

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

Örnek yanıt

Durum kodu:: 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/"
          }
        ]
      }
    }
  ]
}

Tanımlar

Name	Description
ActionRouting	Eylem istekleri için desteklenen yönlendirme türleri.
CustomRPActionRouteDefinition	Özel kaynak sağlayıcısı tarafından uygulanan bir eylemin yol tanımı.
CustomRPManifest	Özel kaynak sağlayıcısı kaynaklarını tanımlayan bir bildirim dosyası.
CustomRPResourceTypeRouteDefinition	Özel kaynak sağlayıcısı tarafından uygulanan bir kaynağın yol tanımı.
CustomRPValidations	Özel kaynak sağlayıcısı isteklerine uygulanacak doğrulama.
ErrorDefinition	Hata tanımı.
ErrorResponse	Hata yanıtı.
ListByCustomRPManifest	Özel kaynak sağlayıcılarının listesi.
ProvisioningState	Kaynak sağlayıcısının sağlama durumu.
ResourceTypeRouting	Kaynak istekleri için desteklenen yönlendirme türleri.
ValidationType	Eşleşen istekte çalıştırılacak doğrulama türü.

ActionRouting

Eylem istekleri için desteklenen yönlendirme türleri.

Name	Tür	Description
Proxy	string

CustomRPActionRouteDefinition

Özel kaynak sağlayıcısı tarafından uygulanan bir eylemin yol tanımı.

Name	Tür	Description
endpoint	string	Özel kaynak sağlayıcısının ara sunucu isteğinde bulunacağı yol tanımı uç nokta URI'si. Bu, düz bir URI biçiminde olabilir (ör. 'https://testendpoint/') veya bir yol üzerinden yönlendirilecek şekilde belirtilebilir (ör. 'https://testendpoint/{requestPath}')
name	string	Yol tanımının adı. Bu, ARM uzantısının adı olur (ör. '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/{name}')
routingType	ActionRouting	Eylem istekleri için desteklenen yönlendirme türleri.

CustomRPManifest

Özel kaynak sağlayıcısı kaynaklarını tanımlayan bir bildirim dosyası.

Name	Tür	Description
id	string	Kaynak Kimliği
location	string	Kaynak konumu
name	string	Kaynak adı
properties.actions	CustomRPActionRouteDefinition[]	Özel kaynak sağlayıcısının uyguladığı eylemlerin listesi.
properties.provisioningState	ProvisioningState	Kaynak sağlayıcısının sağlama durumu.
properties.resourceTypes	CustomRPResourceTypeRouteDefinition[]	Özel kaynak sağlayıcısının uyguladığı kaynak türlerinin listesi.
properties.validations	CustomRPValidations[]	Özel kaynak sağlayıcısının isteklerinde çalıştırılacak doğrulamaların listesi.
tags	object	Kaynak etiketleri
type	string	Kaynak türü

CustomRPResourceTypeRouteDefinition

Özel kaynak sağlayıcısı tarafından uygulanan bir kaynağın yol tanımı.

Name	Tür	Description
endpoint	string	Özel kaynak sağlayıcısının ara sunucu isteğinde bulunacağı yol tanımı uç nokta URI'si. Bu, düz bir URI biçiminde olabilir (ör. 'https://testendpoint/') veya bir yol üzerinden yönlendirilecek şekilde belirtilebilir (ör. 'https://testendpoint/{requestPath}')
name	string	Yol tanımının adı. Bu, ARM uzantısının adı olur (ör. '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/{name}')
routingType	ResourceTypeRouting	Kaynak istekleri için desteklenen yönlendirme türleri.

CustomRPValidations

Özel kaynak sağlayıcısı isteklerine uygulanacak doğrulama.

Name	Tür	Description
specification	string	Doğrulama belirtiminin bağlantısı. Belirtim raw.githubusercontent.com üzerinde barındırılmalıdır.
validationType	ValidationType	Eşleşen istekte çalıştırılacak doğrulama türü.

ErrorDefinition

Hata tanımı.

Name	Tür	Description
code	string	HTTP hata kodu için alt durum olarak hizmet veren hizmete özgü hata kodu.
details	ErrorDefinition[]	İç hata ayrıntıları.
message	string	Hatanın açıklaması.

ErrorResponse

Hata yanıtı.

Name	Tür	Description
error	ErrorDefinition	Hata ayrıntıları.

ListByCustomRPManifest

Özel kaynak sağlayıcılarının listesi.

Name	Tür	Description
nextLink	string	Sonraki sonuç kümesini almak için kullanılacak URL.
value	CustomRPManifest[]	Özel kaynak sağlayıcısı bildirimleri dizisi.

ProvisioningState

Kaynak sağlayıcısının sağlama durumu.

Name	Tür	Description
Accepted	string
Deleting	string
Failed	string
Running	string
Succeeded	string

ResourceTypeRouting

Kaynak istekleri için desteklenen yönlendirme türleri.

Name	Tür	Description
Proxy	string
Proxy,Cache	string

ValidationType

Eşleşen istekte çalıştırılacak doğrulama türü.

Name	Tür	Description
Swagger	string

Aracılığıyla paylaş