Portal Settings - List By Service

Referencia

Szolgáltatás:: API Management

API-verzió:: 2024-05-01

Egy szolgáltatáspéldányon belül definiált portalsettingok gyűjteményét sorolja fel.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/portalsettings?api-version=2024-05-01

URI-paraméterek

Name	In	Kötelező	Típus	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Az API Management szolgáltatás neve.
subscriptionId	path	True	string (uuid)	A cél-előfizetés azonosítója. Az értéknek UUID-nek kell lennie.
api-version	query	True	string minLength: 1	A művelethez használni kívánt API-verzió.

Válaszok

Name	Típus	Description
200 OK	PortalSettingsCollection	A Portálbeállítások entitások gyűjteményét sorolja fel.
Other Status Codes	ErrorResponse	Hibaválasz, amely leírja, hogy miért nem sikerült a művelet.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow.

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

ApiManagementListPortalSettings

Mintakérelem

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalsettings?api-version=2024-05-01


/**
 * Samples for PortalSettings ListByService.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/
     * ApiManagementListPortalSettings.json
     */
    /**
     * Sample code: ApiManagementListPortalSettings.
     * 
     * @param manager Entry point to ApiManagementManager.
     */
    public static void
        apiManagementListPortalSettings(com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager.portalSettings().listByServiceWithResponse("rg1", "apimService1", com.azure.core.util.Context.NONE);
    }
}

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

from azure.identity import DefaultAzureCredential

from azure.mgmt.apimanagement import ApiManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-apimanagement
# USAGE
    python api_management_list_portal_settings.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 = ApiManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.portal_settings.list_by_service(
        resource_group_name="rg1",
        service_name="apimService1",
    )
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementListPortalSettings.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 armapimanagement_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/apimanagement/armapimanagement/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e436160e64c0f8d7fb20d662be2712f71f0a7ef5/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementListPortalSettings.json
func ExamplePortalSettingsClient_ListByService() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armapimanagement.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewPortalSettingsClient().ListByService(ctx, "rg1", "apimService1", 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.PortalSettingsCollection = armapimanagement.PortalSettingsCollection{
	// 	Count: to.Ptr[int64](3),
	// 	Value: []*armapimanagement.PortalSettingsContract{
	// 		{
	// 			Name: to.Ptr("delegation"),
	// 			Type: to.Ptr("Microsoft.ApiManagement/service/portalsettings"),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalsettings/delegation"),
	// 			Properties: &armapimanagement.PortalSettingsContractProperties{
	// 				Enabled: to.Ptr(false),
	// 				Subscriptions: &armapimanagement.SubscriptionsDelegationSettingsProperties{
	// 					Enabled: to.Ptr(false),
	// 				},
	// 				UserRegistration: &armapimanagement.RegistrationDelegationSettingsProperties{
	// 					Enabled: to.Ptr(false),
	// 				},
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("signin"),
	// 			Type: to.Ptr("Microsoft.ApiManagement/service/portalsettings"),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalsettings/signin"),
	// 			Properties: &armapimanagement.PortalSettingsContractProperties{
	// 				Enabled: to.Ptr(false),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("signup"),
	// 			Type: to.Ptr("Microsoft.ApiManagement/service/portalsettings"),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalsettings/signup"),
	// 			Properties: &armapimanagement.PortalSettingsContractProperties{
	// 				Enabled: to.Ptr(true),
	// 				TermsOfService: &armapimanagement.TermsOfServiceProperties{
	// 					ConsentRequired: to.Ptr(false),
	// 					Enabled: to.Ptr(false),
	// 					Text: to.Ptr("Terms of service"),
	// 				},
	// 			},
	// 	}},
	// }
}

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

const { ApiManagementClient } = require("@azure/arm-apimanagement");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Lists a collection of portalsettings defined within a service instance..
 *
 * @summary Lists a collection of portalsettings defined within a service instance..
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementListPortalSettings.json
 */
async function apiManagementListPortalSettings() {
  const subscriptionId =
    process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.portalSettings.listByService(resourceGroupName, serviceName);
  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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using System.Xml;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.ApiManagement.Models;
using Azure.ResourceManager.ApiManagement;

// Generated from example definition: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementListPortalSettings.json
// this example is just showing the usage of "PortalSettings_ListByService" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ApiManagementServiceResource created on azure
// for more information of creating ApiManagementServiceResource, please refer to the document of ApiManagementServiceResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "rg1";
string serviceName = "apimService1";
ResourceIdentifier apiManagementServiceResourceId = ApiManagementServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceName);
ApiManagementServiceResource apiManagementService = client.GetApiManagementServiceResource(apiManagementServiceResourceId);

// invoke the operation and iterate over the result
await foreach (PortalSettingsContractData item in apiManagementService.GetPortalSettingsAsync())
{
    Console.WriteLine($"Succeeded: {item}");
}

Console.WriteLine("Succeeded");

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

Mintaválasz

Állapotkód:: 200

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalsettings/delegation",
      "type": "Microsoft.ApiManagement/service/portalsettings",
      "name": "delegation",
      "properties": {
        "subscriptions": {
          "enabled": false
        },
        "userRegistration": {
          "enabled": false
        },
        "enabled": false
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalsettings/signin",
      "type": "Microsoft.ApiManagement/service/portalsettings",
      "name": "signin",
      "properties": {
        "enabled": false
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalsettings/signup",
      "type": "Microsoft.ApiManagement/service/portalsettings",
      "name": "signup",
      "properties": {
        "enabled": true,
        "termsOfService": {
          "text": "Terms of service",
          "enabled": false,
          "consentRequired": false
        }
      }
    }
  ],
  "count": 3
}

Definíciók

Name	Description
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
PortalSettingsCollection	Az API Management-szabályzatok leírása.
PortalSettingsContract	A fejlesztői portál portálbeállításai.
RegistrationDelegationSettingsProperties	A felhasználóregisztráció delegálási beállításainak tulajdonságai.
SubscriptionsDelegationSettingsProperties	Az előfizetések delegálási beállításainak tulajdonságai.
TermsOfServiceProperties	Szolgáltatási szerződés tulajdonságai.

ErrorAdditionalInfo

Objektum

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további információtípus.

ErrorDetail

Objektum

A hiba részletei.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hibacél.

ErrorResponse

Objektum

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

PortalSettingsCollection

Objektum

Az API Management-szabályzatok leírása.

Name	Típus	Description
count	integer (int64)	Rekordszám teljes száma.
value	PortalSettingsContract[]	Az API Management-szabályzatok leírása.

PortalSettingsContract

Objektum

A fejlesztői portál portálbeállításai.

Name	Típus	Description
id	string	Az erőforrás teljes erőforrás-azonosítója. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Az erőforrás neve
properties.enabled	boolean	Névtelen felhasználók átirányítása a Sign-In lapra.
properties.subscriptions	SubscriptionsDelegationSettingsProperties	Előfizetések delegálási beállításai.
properties.termsOfService	TermsOfServiceProperties	Szolgáltatási szerződés tulajdonságai.
properties.url	string	Delegálási URL-cím.
properties.userRegistration	RegistrationDelegationSettingsProperties	Felhasználóregisztrációs delegálási beállítások.
properties.validationKey	string	Egy base64 kódolású érvényesítési kulcs, amely ellenőrzi, hogy a kérés az Azure API Managementtől érkezik-e.
type	string	Az erőforrás típusa. Pl. "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

RegistrationDelegationSettingsProperties

Objektum

A felhasználóregisztráció delegálási beállításainak tulajdonságai.

Name	Típus	Description
enabled	boolean	Engedélyezze vagy tiltsa le a delegálást a felhasználói regisztrációhoz.

SubscriptionsDelegationSettingsProperties

Objektum

Az előfizetések delegálási beállításainak tulajdonságai.

Name	Típus	Description
enabled	boolean	Előfizetések delegálásának engedélyezése vagy letiltása.

TermsOfServiceProperties

Objektum

Szolgáltatási szerződés tulajdonságai.

Name	Típus	Description
consentRequired	boolean	Kérje meg a felhasználót, hogy járuljon hozzá a szolgáltatási feltételekhez.
enabled	boolean	Szolgáltatási feltételek megjelenítése a regisztrációs folyamat során.
text	string	A szolgáltatási feltételek szövege.