Získá prostředky privátního propojení.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/privateLinkResources?api-version=2022-08-01
Parametry identifikátoru URI
| Name |
V |
Vyžadováno |
Typ |
Description |
|
resourceGroupName
|
path |
True
|
string
|
Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.
|
|
serviceName
|
path |
True
|
string
|
Název služby API Management.
Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
|
|
subscriptionId
|
path |
True
|
string
|
ID cílového předplatného.
|
|
api-version
|
query |
True
|
string
|
Verze rozhraní API, která se má použít pro tuto operaci.
|
Odpovědi
Zabezpečení
azure_auth
Tok Azure Active Directory OAuth2.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
| Name |
Description |
|
user_impersonation
|
zosobnění uživatelského účtu
|
Příklady
ApiManagementListPrivateLinkGroupResources
Sample Request
GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateLinkResources?api-version=2022-08-01
/** Samples for PrivateEndpointConnection ListPrivateLinkResources. */
public final class Main {
/*
* x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListPrivateLinkGroupResources.json
*/
/**
* Sample code: ApiManagementListPrivateLinkGroupResources.
*
* @param manager Entry point to ApiManagementManager.
*/
public static void apiManagementListPrivateLinkGroupResources(
com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
manager
.privateEndpointConnections()
.listPrivateLinkResourcesWithResponse("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_private_link_group_resources.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="subid",
)
response = client.private_endpoint_connection.list_private_link_resources(
resource_group_name="rg1",
service_name="apimService1",
)
print(response)
# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListPrivateLinkGroupResources.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/v2"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4cd95123fb961c68740565a1efcaa5e43bd35802/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListPrivateLinkGroupResources.json
func ExamplePrivateEndpointConnectionClient_ListPrivateLinkResources() {
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.NewPrivateEndpointConnectionClient().ListPrivateLinkResources(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.PrivateLinkResourceListResult = armapimanagement.PrivateLinkResourceListResult{
// Value: []*armapimanagement.PrivateLinkResource{
// {
// Name: to.Ptr("Gateway"),
// Type: to.Ptr("Microsoft.ApiManagement/service/privateLinkResources"),
// ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateLinkResources/Gateway"),
// Properties: &armapimanagement.PrivateLinkResourceProperties{
// GroupID: to.Ptr("Gateway"),
// RequiredMembers: []*string{
// to.Ptr("Gateway")},
// RequiredZoneNames: []*string{
// to.Ptr("privateLink.azure-api.net")},
// },
// }},
// }
}
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");
/**
* This sample demonstrates how to Gets the private link resources
*
* @summary Gets the private link resources
* x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListPrivateLinkGroupResources.json
*/
async function apiManagementListPrivateLinkGroupResources() {
const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
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.privateEndpointConnectionOperations.listPrivateLinkResources(
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
Sample Response
{
"value": [
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateLinkResources/Gateway",
"name": "Gateway",
"type": "Microsoft.ApiManagement/service/privateLinkResources",
"properties": {
"groupId": "Gateway",
"requiredMembers": [
"Gateway"
],
"requiredZoneNames": [
"privateLink.azure-api.net"
]
}
}
]
}
Definice
ErrorFieldContract
Chybový kontrakt pole.
| Name |
Typ |
Description |
|
code
|
string
|
Kód chyby na úrovni vlastnosti.
|
|
message
|
string
|
Pro člověka čitelná reprezentace chyby na úrovni vlastností.
|
|
target
|
string
|
Název vlastnosti.
|
ErrorResponse
Odpověď na chybu.
| Name |
Typ |
Description |
|
error.code
|
string
|
Kód chyby definovaný službou. Tento kód slouží jako dílčí stav pro kód chyby HTTP zadaný v odpovědi.
|
|
error.details
|
ErrorFieldContract[]
|
Seznam neplatných polí se odešle v požadavku v případě chyby ověření.
|
|
error.message
|
string
|
Pro člověka čitelná reprezentace chyby.
|
PrivateLinkResource
Prostředek privátního propojení
| Name |
Typ |
Description |
|
id
|
string
|
Plně kvalifikované ID prostředku Příklad : /subscriptions/{id_předplatného}/resourceGroups/{název_skupiny_prostředků}/providers/{resourceProviderNamespace}/{typ_prostředku}/{název_prostředku}
|
|
name
|
string
|
Název prostředku
|
|
properties.groupId
|
string
|
ID skupiny prostředků privátního propojení
|
|
properties.requiredMembers
|
string[]
|
Prostředek privátního propojení vyžaduje názvy členů.
|
|
properties.requiredZoneNames
|
string[]
|
Název zóny DNS prostředku privátního propojení Private Link.
|
|
type
|
string
|
Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts
|
PrivateLinkResourceListResult
Seznam prostředků privátního propojení