Custom Resource Provider - Get

Služba:

Custom Providers

Verze rozhraní API:

2018-09-01-preview

Získá vlastní manifest poskytovatele prostředků.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
resourceGroupName	path	True	string	Název skupiny prostředků.
resourceProviderName	path	True	string	Název poskytovatele prostředků.
subscriptionId	path	True	string	ID předplatného Azure. Jedná se o řetězec ve formátu GUID (např. 00000000-0000-0000-0000-000000000000000).
api-version	query	True	string	Verze rozhraní API, která se má použít s požadavkem HTTP.

Odpovědi

Name	Typ	Description
200 OK	CustomRPManifest	Definice odpovědi OK s existujícím prostředkem.
Other Status Codes	ErrorResponse	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

Get a custom resource provider

Ukázkový požadavek

HTTP

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

Python

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

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-customproviders
# USAGE
    python get_a_custom_resource_provider.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.get(
        resource_group_name="testRG",
        resource_provider_name="newrp",
    )
    print(response)


# x-ms-original-file: specification/customproviders/resource-manager/Microsoft.CustomProviders/preview/2018-09-01-preview/examples/getCustomRP.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

Go

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/getCustomRP.json
func ExampleCustomResourceProviderClient_Get() {
	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)
	}
	res, err := clientFactory.NewCustomResourceProviderClient().Get(ctx, "testRG", "newrp", 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.CustomRPManifest = armcustomproviders.CustomRPManifest{
	// 	Name: to.Ptr("newrp"),
	// 	Type: to.Ptr("Microsoft.CustomProviders/resourceProviders"),
	// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.CustomProviders/resourceProviders/newrp"),
	// 	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

Ukázková odpověď

Stavový kód:

200

{
  "name": "newrp",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.CustomProviders/resourceProviders/newrp",
  "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/"
      }
    ]
  }
}

Definice

Name	Description
ActionRouting	Typy směrování podporované pro žádosti o akci.
CustomRPActionRouteDefinition	Definice trasy pro akci implementovanou vlastním poskytovatelem prostředků.
CustomRPManifest	Soubor manifestu, který definuje vlastní prostředky poskytovatele prostředků.
CustomRPResourceTypeRouteDefinition	Definice trasy pro prostředek implementovaný vlastním poskytovatelem prostředků.
CustomRPValidations	Ověření, které se použije u vlastních požadavků poskytovatele prostředků.
ErrorDefinition	Definice chyby.
ErrorResponse	Chybová odpověď.
ProvisioningState	Stav zřizování poskytovatele prostředků.
ResourceTypeRouting	Typy směrování podporované pro požadavky na prostředky.
ValidationType	Typ ověření, které se má spustit na odpovídající požadavek.

ActionRouting

Typy směrování podporované pro žádosti o akci.

Name	Typ	Description
Proxy	string

CustomRPActionRouteDefinition

Definice trasy pro akci implementovanou vlastním poskytovatelem prostředků.

Name	Typ	Description
endpoint	string	Identifikátor URI koncového bodu definice trasy, na který bude poskytovatel vlastních prostředků zprostředkovat požadavky. Může to být ve formě plochého identifikátoru URI (např. 'https://testendpoint/') nebo může zadat směrování přes cestu (např. 'https://testendpoint/{requestPath}').
name	string	Název definice trasy. Tento název se stane názvem rozšíření ARM (např. /subscriptions/{id_předplatného}/resourceGroups/{název_skupiny_prostředků}/providers/Microsoft.CustomProviders/resourceProviders/{název_poskytovatele}/{název}).
routingType	ActionRouting	Typy směrování podporované pro žádosti o akci.

CustomRPManifest

Soubor manifestu, který definuje vlastní prostředky poskytovatele prostředků.

Name	Typ	Description
id	string	ID prostředku
location	string	Umístění prostředku
name	string	Název prostředku
properties.actions	CustomRPActionRouteDefinition[]	Seznam akcí, které vlastní poskytovatel prostředků implementuje.
properties.provisioningState	ProvisioningState	Stav zřizování poskytovatele prostředků.
properties.resourceTypes	CustomRPResourceTypeRouteDefinition[]	Seznam typů prostředků, které vlastní poskytovatel prostředků implementuje.
properties.validations	CustomRPValidations[]	Seznam ověření, která se mají spustit u požadavků vlastního poskytovatele prostředků.
tags	object	Značky prostředků
type	string	Typ prostředku

CustomRPResourceTypeRouteDefinition

Definice trasy pro prostředek implementovaný vlastním poskytovatelem prostředků.

Name	Typ	Description
endpoint	string	Identifikátor URI koncového bodu definice trasy, na který bude poskytovatel vlastních prostředků zprostředkovat požadavky. Může to být ve formě plochého identifikátoru URI (např. 'https://testendpoint/') nebo může zadat směrování přes cestu (např. 'https://testendpoint/{requestPath}').
name	string	Název definice trasy. Tento název se stane názvem rozšíření ARM (např. /subscriptions/{id_předplatného}/resourceGroups/{název_skupiny_prostředků}/providers/Microsoft.CustomProviders/resourceProviders/{název_poskytovatele}/{název}).
routingType	ResourceTypeRouting	Typy směrování podporované pro požadavky na prostředky.

CustomRPValidations

Ověření, které se použije u vlastních požadavků poskytovatele prostředků.

Name	Typ	Description
specification	string	Odkaz na specifikaci ověření. Specifikace musí být hostovaná na raw.githubusercontent.com.
validationType	ValidationType	Typ ověření, které se má spustit na odpovídající požadavek.

ErrorDefinition

Definice chyby.

Name	Typ	Description
code	string	Kód chyby specifický pro službu, který slouží jako dílčí stav pro kód chyby HTTP.
details	ErrorDefinition[]	Podrobnosti o vnitřní chybě.
message	string	Popis chyby

ErrorResponse

Chybová odpověď.

Name	Typ	Description
error	ErrorDefinition	Podrobnosti o chybě.

ProvisioningState

Stav zřizování poskytovatele prostředků.

Name	Typ	Description
Accepted	string
Deleting	string
Failed	string
Running	string
Succeeded	string

ResourceTypeRouting

Typy směrování podporované pro požadavky na prostředky.

Name	Typ	Description
Proxy	string
Proxy,Cache	string

ValidationType

Typ ověření, které se má spustit na odpovídající požadavek.

Name	Typ	Description
Swagger	string