Výpis testovacích klíčů pro službu
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/listTestKeys?api-version=2023-12-01
Parametry identifikátoru URI
| Name |
V |
Vyžadováno |
Typ |
Description |
|
resourceGroupName
|
path |
True
|
string
|
Název skupiny prostředků, která prostředek obsahuje. Tuto hodnotu můžete získat z rozhraní API Resource Manager Azure nebo z portálu.
|
|
serviceName
|
path |
True
|
string
|
Název prostředku služby.
Vzor regulárního výrazu: ^[a-z][a-z0-9-]*[a-z0-9]$
|
|
subscriptionId
|
path |
True
|
string
|
Získá ID předplatného, které jednoznačně identifikuje předplatné Microsoft Azure. ID předplatného je součástí identifikátoru URI pro každé volání služby.
|
|
api-version
|
query |
True
|
string
|
Verze rozhraní API, která se má použít pro tuto operaci.
|
Odpovědi
| Name |
Typ |
Description |
|
200 OK
|
TestKeys
|
Úspěch. Odpověď popisuje testovací klíče.
|
|
Other Status Codes
|
CloudError
|
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
Services_ListTestKeys
Ukázkový požadavek
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
Ukázková odpověď
{
"primaryKey": "<primaryKey>",
"secondaryKey": "<secondaryKey>",
"primaryTestEndpoint": "<primaryTestEndpoint>",
"secondaryTestEndpoint": "<secondaryTestEndpoint>",
"enabled": true
}
Definice
CloudError
Chybová odpověď ze služby.
CloudErrorBody
Chybová odpověď ze služby.
| Name |
Typ |
Description |
|
code
|
string
|
Identifikátor chyby. Kódy jsou neutrální a mají být využívány programově.
|
|
details
|
CloudErrorBody[]
|
Seznam dalších podrobností o chybě
|
|
message
|
string
|
Zpráva popisující chybu, která má být vhodná k zobrazení v uživatelském rozhraní.
|
|
target
|
string
|
Cíl konkrétní chyby. Například název vlastnosti v chybě.
|
TestKeys
Datová část testovacích klíčů
| Name |
Typ |
Description |
|
enabled
|
boolean
|
Označuje, jestli je funkce testovacího koncového bodu povolená, nebo ne.
|
|
primaryKey
|
string
|
Primární klíč
|
|
primaryTestEndpoint
|
string
|
Primární testovací koncový bod
|
|
secondaryKey
|
string
|
Sekundární klíč
|
|
secondaryTestEndpoint
|
string
|
Sekundární testovací koncový bod
|