Enumerar las claves de prueba de un servicio.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/listTestKeys?api-version=2023-12-01
Parámetros de identificador URI
| Nombre |
En |
Requerido |
Tipo |
Description |
|
resourceGroupName
|
path |
True
|
string
|
Nombre del grupo de recursos que contiene el recurso. Puede obtener este valor desde la API de Azure Resource Manager o el portal.
|
|
serviceName
|
path |
True
|
string
pattern: ^[a-z][a-z0-9-]*[a-z0-9]$
|
Nombre del recurso de servicio.
|
|
subscriptionId
|
path |
True
|
string
|
Obtiene el identificador de suscripción que identifica de forma única la suscripción de Microsoft Azure. El identificador de suscripción forma parte del URI de cada llamada de servicio.
|
|
api-version
|
query |
True
|
string
minLength: 1
|
Versión de la API que se va a usar para esta operación.
|
Respuestas
| Nombre |
Tipo |
Description |
|
200 OK
|
TestKeys
|
Éxito. La respuesta describe las claves de prueba.
|
|
Other Status Codes
|
CloudError
|
Respuesta de error que describe por qué se produjo un error en la operación.
|
Seguridad
azure_auth
Flujo de OAuth2 de Azure Active Directory
Tipo:
oauth2
Flujo:
implicit
Dirección URL de autorización:
https://login.microsoftonline.com/common/oauth2/authorize
Ámbitos
| Nombre |
Description |
|
user_impersonation
|
suplantar la cuenta de usuario
|
Ejemplos
Services_ListTestKeys
Solicitud de ejemplo
POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/listTestKeys?api-version=2023-12-01
/**
* Samples for Services ListTestKeys.
*/
public final class Main {
/*
* x-ms-original-file:
* specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Services_ListTestKeys
* .json
*/
/**
* Sample code: Services_ListTestKeys.
*
* @param azure The entry point for accessing resource management APIs in Azure.
*/
public static void servicesListTestKeys(com.azure.resourcemanager.AzureResourceManager azure) {
azure.springServices().manager().serviceClient().getServices().listTestKeysWithResponse("myResourceGroup",
"myservice", 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.appplatform import AppPlatformManagementClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-appplatform
# USAGE
python services_list_test_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 = AppPlatformManagementClient(
credential=DefaultAzureCredential(),
subscription_id="00000000-0000-0000-0000-000000000000",
)
response = client.services.list_test_keys(
resource_group_name="myResourceGroup",
service_name="myservice",
)
print(response)
# x-ms-original-file: specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Services_ListTestKeys.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 armappplatform_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform/v2"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Services_ListTestKeys.json
func ExampleServicesClient_ListTestKeys() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewServicesClient().ListTestKeys(ctx, "myResourceGroup", "myservice", 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.TestKeys = armappplatform.TestKeys{
// Enabled: to.Ptr(true),
// PrimaryKey: to.Ptr("<primaryKey>"),
// PrimaryTestEndpoint: to.Ptr("<primaryTestEndpoint>"),
// SecondaryKey: to.Ptr("<secondaryKey>"),
// SecondaryTestEndpoint: to.Ptr("<secondaryTestEndpoint>"),
// }
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { AppPlatformManagementClient } = require("@azure/arm-appplatform");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to List test keys for a Service.
*
* @summary List test keys for a Service.
* x-ms-original-file: specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Services_ListTestKeys.json
*/
async function servicesListTestKeys() {
const subscriptionId =
process.env["APPPLATFORM_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
const resourceGroupName = process.env["APPPLATFORM_RESOURCE_GROUP"] || "myResourceGroup";
const serviceName = "myservice";
const credential = new DefaultAzureCredential();
const client = new AppPlatformManagementClient(credential, subscriptionId);
const result = await client.services.listTestKeys(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
Respuesta de muestra
{
"primaryKey": "<primaryKey>",
"secondaryKey": "<secondaryKey>",
"primaryTestEndpoint": "<primaryTestEndpoint>",
"secondaryTestEndpoint": "<secondaryTestEndpoint>",
"enabled": true
}
Definiciones
CloudError
Object
Respuesta de error del servicio.
| Nombre |
Tipo |
Description |
|
error
|
CloudErrorBody
|
Respuesta de error del servicio.
|
CloudErrorBody
Object
Respuesta de error del servicio.
| Nombre |
Tipo |
Description |
|
code
|
string
|
Identificador del error. Los códigos son invariables y están diseñados para consumirse mediante programación.
|
|
details
|
CloudErrorBody[]
|
Lista de detalles adicionales sobre el error.
|
|
message
|
string
|
Mensaje que describe el error, diseñado para ser adecuado para mostrarse en una interfaz de usuario.
|
|
target
|
string
|
Destino del error concreto. Por ejemplo, el nombre de la propiedad en error.
|
TestKeys
Object
Carga de claves de prueba
| Nombre |
Tipo |
Description |
|
enabled
|
boolean
|
Indica si la característica de punto de conexión de prueba está habilitada o no.
|
|
primaryKey
|
string
|
Clave principal
|
|
primaryTestEndpoint
|
string
|
Punto de conexión de prueba principal
|
|
secondaryKey
|
string
|
Clave secundaria
|
|
secondaryTestEndpoint
|
string
|
Punto de conexión de prueba secundario
|