Recupera le chiavi del gateway.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/listKeys?api-version=2022-08-01
Parametri dell'URI
Nome |
In |
Necessario |
Tipo |
Descrizione |
gatewayId
|
path |
True
|
string
|
Identificatore di entità del gateway. Deve essere univoco nell'istanza corrente del servizio di Gestione API. Non deve avere il valore 'managed'
|
resourceGroupName
|
path |
True
|
string
|
Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.
|
serviceName
|
path |
True
|
string
|
Nome del servizio di Gestione API.
Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
|
subscriptionId
|
path |
True
|
string
|
ID della sottoscrizione di destinazione.
|
api-version
|
query |
True
|
string
|
Versione dell'API da usare per questa operazione.
|
Risposte
Nome |
Tipo |
Descrizione |
200 OK
|
GatewayKeysContract
|
Il corpo della risposta contiene le chiavi del gateway specificate.
Headers
ETag: string
|
Other Status Codes
|
ErrorResponse
|
Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.
|
Sicurezza
azure_auth
Flusso OAuth2 di Azure Active Directory.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nome |
Descrizione |
user_impersonation
|
rappresentare l'account utente
|
Esempio
ApiManagementGatewayListKeys
Sample Request
POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/listKeys?api-version=2022-08-01
/** Samples for Gateway ListKeys. */
public final class Main {
/*
* x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementGatewayListKeys.json
*/
/**
* Sample code: ApiManagementGatewayListKeys.
*
* @param manager Entry point to ApiManagementManager.
*/
public static void apiManagementGatewayListKeys(
com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
manager.gateways().listKeysWithResponse("rg1", "apimService1", "gw1", 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_gateway_list_keys.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.gateway.list_keys(
resource_group_name="rg1",
service_name="apimService1",
gateway_id="gw1",
)
print(response)
# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementGatewayListKeys.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/ApiManagementGatewayListKeys.json
func ExampleGatewayClient_ListKeys() {
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.NewGatewayClient().ListKeys(ctx, "rg1", "apimService1", "gw1", 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.GatewayKeysContract = armapimanagement.GatewayKeysContract{
// Primary: to.Ptr("primary_key_value"),
// Secondary: to.Ptr("secondary_key_value"),
// }
}
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 Retrieves gateway keys.
*
* @summary Retrieves gateway keys.
* x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementGatewayListKeys.json
*/
async function apiManagementGatewayListKeys() {
const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
const serviceName = "apimService1";
const gatewayId = "gw1";
const credential = new DefaultAzureCredential();
const client = new ApiManagementClient(credential, subscriptionId);
const result = await client.gateway.listKeys(resourceGroupName, serviceName, gatewayId);
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
{
"primary": "primary_key_value",
"secondary": "secondary_key_value"
}
Definizioni
ErrorFieldContract
Contratto campo di errore.
Nome |
Tipo |
Descrizione |
code
|
string
|
Codice di errore a livello di proprietà.
|
message
|
string
|
Rappresentazione leggibile dell'errore a livello di proprietà.
|
target
|
string
|
Nome della proprietà.
|
ErrorResponse
Risposta errore.
Nome |
Tipo |
Descrizione |
error.code
|
string
|
Codice di errore definito dal servizio. Questo codice svolge la funzione di stato secondario per il codice di errore HTTP specificato nella risposta.
|
error.details
|
ErrorFieldContract[]
|
Elenco di campi non validi inviati nella richiesta, in caso di errore di convalida.
|
error.message
|
string
|
Rappresentazione leggibile dell'errore.
|
GatewayKeysContract
Chiavi di autenticazione del gateway.
Nome |
Tipo |
Descrizione |
primary
|
string
|
Chiave del gateway primario.
|
secondary
|
string
|
Chiave del gateway secondario.
|