Config Servers - Get
Get the config server and its properties.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/configServers/default?api-version=2023-12-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
resource
|
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. |
service
|
path | True |
string |
The name of the Service resource. Regex pattern: |
subscription
|
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 |
The API version to use for this operation. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
Success. The response describes the corresponding Config Server. |
|
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
ConfigServers_Get
Sample request
GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/configServers/default?api-version=2023-12-01
Sample response
{
"properties": {
"provisioningState": "Succeeded",
"configServer": {
"gitProperty": {
"uri": "https://github.com/fake-user/fake-repository.git",
"label": "master",
"searchPaths": [
"/"
]
}
}
},
"systemData": {
"createdBy": "sample-user",
"createdByType": "User",
"createdAt": "2021-08-11T03:16:03.944Z",
"lastModifiedBy": "sample-user",
"lastModifiedByType": "User",
"lastModifiedAt": "2021-08-11T03:17:03.944Z"
},
"type": "Microsoft.AppPlatform/Spring/configServers",
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/configServers/default",
"name": "default"
}
Definitions
Name | Description |
---|---|
Cloud |
An error response from the service. |
Cloud |
An error response from the service. |
Config |
Property of git. |
Config |
Config server git properties payload |
Config |
Config Server resource |
Config |
The settings of config server. |
Config |
State of the config server. |
created |
The type of identity that created the resource. |
Error |
The error code compose of code and message. |
Git |
Git repository property payload for config server |
last |
The type of identity that last modified the resource. |
System |
Metadata pertaining to creation and last modification of the resource. |
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. |
ConfigServerGitProperty
Property of git.
Name | Type | Description |
---|---|---|
hostKey |
string |
Public sshKey of git repository. |
hostKeyAlgorithm |
string |
SshKey algorithm of git repository. |
label |
string |
Label of the repository |
password |
string |
Password of git repository basic auth. |
privateKey |
string |
Private sshKey algorithm of git repository. |
repositories |
Repositories of git. |
|
searchPaths |
string[] |
Searching path of the repository |
strictHostKeyChecking |
boolean |
Strict host key checking or not. |
uri |
string |
URI of the repository |
username |
string |
Username of git repository basic auth. |
ConfigServerProperties
Config server git properties payload
Name | Type | Description |
---|---|---|
configServer |
Settings of config server. |
|
error |
Error when apply config server settings. |
|
provisioningState |
State of the config server. |
ConfigServerResource
Config Server resource
Name | Type | Description |
---|---|---|
id |
string |
Fully qualified resource Id for the resource. |
name |
string |
The name of the resource. |
properties |
Properties of the Config Server resource |
|
systemData |
Metadata pertaining to creation and last modification of the resource. |
|
type |
string |
The type of the resource. |
ConfigServerSettings
The settings of config server.
Name | Type | Description |
---|---|---|
gitProperty |
Property of git environment. |
ConfigServerState
State of the config server.
Name | Type | Description |
---|---|---|
Deleted |
string |
|
Failed |
string |
|
NotAvailable |
string |
|
Succeeded |
string |
|
Updating |
string |
createdByType
The type of identity that created the resource.
Name | Type | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
Error
The error code compose of code and message.
Name | Type | Description |
---|---|---|
code |
string |
The code of error. |
message |
string |
The message of error. |
GitPatternRepository
Git repository property payload for config server
Name | Type | Description |
---|---|---|
hostKey |
string |
Public sshKey of git repository. |
hostKeyAlgorithm |
string |
SshKey algorithm of git repository. |
label |
string |
Label of the repository |
name |
string |
Name of the repository |
password |
string |
Password of git repository basic auth. |
pattern |
string[] |
Collection of pattern of the repository |
privateKey |
string |
Private sshKey algorithm of git repository. |
searchPaths |
string[] |
Searching path of the repository |
strictHostKeyChecking |
boolean |
Strict host key checking or not. |
uri |
string |
URI of the repository |
username |
string |
Username of git repository basic auth. |
lastModifiedByType
The type of identity that last modified the resource.
Name | Type | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
SystemData
Metadata pertaining to creation and last modification of the resource.
Name | Type | Description |
---|---|---|
createdAt |
string |
The timestamp of resource creation (UTC). |
createdBy |
string |
The identity that created the resource. |
createdByType |
The type of identity that created the resource. |
|
lastModifiedAt |
string |
The timestamp of resource modification (UTC). |
lastModifiedBy |
string |
The identity that last modified the resource. |
lastModifiedByType |
The type of identity that last modified the resource. |