Services - List Test Keys

List test keys for a Service.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/listTestKeys?api-version=2019-05-01-preview

URI Parameters

Name In Required Type Description
resourceGroupName
path True
  • string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serviceName
path True
  • string

The name of the Service resource.

subscriptionId
path True
  • string

Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

api-version
query True
  • string

Client Api Version.

Responses

Name Type Description
200 OK

Success. The response describes the test keys.

Other Status Codes

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

Services_ListTestKeys

Sample Request

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/listTestKeys?api-version=2019-05-01-preview

Sample Response

{
  "primaryKey": "<primaryKey>",
  "secondaryKey": "<secondaryKey>",
  "primaryTestEndpoint": "key1@TestEndpoint",
  "secondaryTestEndpoint": "key2@TestEndpoint",
  "enabled": true
}

Definitions

CloudError

An error response from the service.

CloudErrorBody

An error response from the service.

TestKeys

Test keys payload

CloudError

An error response from the service.

Name Type Description
error

An error response from the service.

CloudErrorBody

An error response from the service.

Name Type Description
code
  • string

An identifier for the error. Codes are invariant and are intended to be consumed programmatically.

details

A list of additional details about the error.

message
  • string

A message describing the error, intended to be suitable for display in a user interface.

target
  • string

The target of the particular error. For example, the name of the property in error.

TestKeys

Test keys payload

Name Type Description
enabled
  • boolean

Indicates whether the test endpoint feature enabled or not

primaryKey
  • string

Primary key

primaryTestEndpoint
  • string

Primary test endpoint

secondaryKey
  • string

Secondary key

secondaryTestEndpoint
  • string

Secondary test endpoint