1. Packages
  2. Azure Native
  3. API Docs
  4. appplatform
  5. getConfigServer
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi

azure-native.appplatform.getConfigServer

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi

Get the config server and its properties.

Uses Azure REST API version 2024-01-01-preview.

Other available API versions: 2023-05-01-preview, 2023-07-01-preview, 2023-09-01-preview, 2023-11-01-preview, 2023-12-01, 2024-05-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native appplatform [ApiVersion]. See the version guide for details.

Using getConfigServer

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getConfigServer(args: GetConfigServerArgs, opts?: InvokeOptions): Promise<GetConfigServerResult>
function getConfigServerOutput(args: GetConfigServerOutputArgs, opts?: InvokeOptions): Output<GetConfigServerResult>
Copy
def get_config_server(resource_group_name: Optional[str] = None,
                      service_name: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetConfigServerResult
def get_config_server_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                      service_name: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetConfigServerResult]
Copy
func LookupConfigServer(ctx *Context, args *LookupConfigServerArgs, opts ...InvokeOption) (*LookupConfigServerResult, error)
func LookupConfigServerOutput(ctx *Context, args *LookupConfigServerOutputArgs, opts ...InvokeOption) LookupConfigServerResultOutput
Copy

> Note: This function is named LookupConfigServer in the Go SDK.

public static class GetConfigServer 
{
    public static Task<GetConfigServerResult> InvokeAsync(GetConfigServerArgs args, InvokeOptions? opts = null)
    public static Output<GetConfigServerResult> Invoke(GetConfigServerInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetConfigServerResult> getConfigServer(GetConfigServerArgs args, InvokeOptions options)
public static Output<GetConfigServerResult> getConfigServer(GetConfigServerArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:appplatform:getConfigServer
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
string
The name of the Service resource.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
string
The name of the Service resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
String
The name of the Service resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
string
The name of the Service resource.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
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_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Service resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
String
The name of the Service resource.

getConfigServer Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
Id string
Fully qualified resource Id for the resource.
Name string
The name of the resource.
Properties Pulumi.AzureNative.AppPlatform.Outputs.ConfigServerPropertiesResponse
Properties of the Config Server resource
SystemData Pulumi.AzureNative.AppPlatform.Outputs.SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
Type string
The type of the resource.
AzureApiVersion string
The Azure API version of the resource.
Id string
Fully qualified resource Id for the resource.
Name string
The name of the resource.
Properties ConfigServerPropertiesResponse
Properties of the Config Server resource
SystemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
Type string
The type of the resource.
azureApiVersion String
The Azure API version of the resource.
id String
Fully qualified resource Id for the resource.
name String
The name of the resource.
properties ConfigServerPropertiesResponse
Properties of the Config Server resource
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type String
The type of the resource.
azureApiVersion string
The Azure API version of the resource.
id string
Fully qualified resource Id for the resource.
name string
The name of the resource.
properties ConfigServerPropertiesResponse
Properties of the Config Server resource
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type string
The type of the resource.
azure_api_version str
The Azure API version of the resource.
id str
Fully qualified resource Id for the resource.
name str
The name of the resource.
properties ConfigServerPropertiesResponse
Properties of the Config Server resource
system_data SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type str
The type of the resource.
azureApiVersion String
The Azure API version of the resource.
id String
Fully qualified resource Id for the resource.
name String
The name of the resource.
properties Property Map
Properties of the Config Server resource
systemData Property Map
Metadata pertaining to creation and last modification of the resource.
type String
The type of the resource.

Supporting Types

ConfigServerGitPropertyResponse

Uri This property is required. string
URI of the repository
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 List<Pulumi.AzureNative.AppPlatform.Inputs.GitPatternRepositoryResponse>
Repositories of git.
SearchPaths List<string>
Searching path of the repository
StrictHostKeyChecking bool
Strict host key checking or not.
Username string
Username of git repository basic auth.
Uri This property is required. string
URI of the repository
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 []GitPatternRepositoryResponse
Repositories of git.
SearchPaths []string
Searching path of the repository
StrictHostKeyChecking bool
Strict host key checking or not.
Username string
Username of git repository basic auth.
uri This property is required. String
URI of the repository
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 List<GitPatternRepositoryResponse>
Repositories of git.
searchPaths List<String>
Searching path of the repository
strictHostKeyChecking Boolean
Strict host key checking or not.
username String
Username of git repository basic auth.
uri This property is required. string
URI of the repository
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 GitPatternRepositoryResponse[]
Repositories of git.
searchPaths string[]
Searching path of the repository
strictHostKeyChecking boolean
Strict host key checking or not.
username string
Username of git repository basic auth.
uri This property is required. str
URI of the repository
host_key str
Public sshKey of git repository.
host_key_algorithm str
SshKey algorithm of git repository.
label str
Label of the repository
password str
Password of git repository basic auth.
private_key str
Private sshKey algorithm of git repository.
repositories Sequence[GitPatternRepositoryResponse]
Repositories of git.
search_paths Sequence[str]
Searching path of the repository
strict_host_key_checking bool
Strict host key checking or not.
username str
Username of git repository basic auth.
uri This property is required. String
URI of the repository
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 List<Property Map>
Repositories of git.
searchPaths List<String>
Searching path of the repository
strictHostKeyChecking Boolean
Strict host key checking or not.
username String
Username of git repository basic auth.

ConfigServerPropertiesResponse

ProvisioningState This property is required. string
State of the config server.
ConfigServer Pulumi.AzureNative.AppPlatform.Inputs.ConfigServerSettingsResponse
Settings of config server.
EnabledState string
Enabled state of the config server. This is only used in Consumption tier.
Error Pulumi.AzureNative.AppPlatform.Inputs.ErrorResponse
Error when apply config server settings.
ProvisioningState This property is required. string
State of the config server.
ConfigServer ConfigServerSettingsResponse
Settings of config server.
EnabledState string
Enabled state of the config server. This is only used in Consumption tier.
Error ErrorResponse
Error when apply config server settings.
provisioningState This property is required. String
State of the config server.
configServer ConfigServerSettingsResponse
Settings of config server.
enabledState String
Enabled state of the config server. This is only used in Consumption tier.
error ErrorResponse
Error when apply config server settings.
provisioningState This property is required. string
State of the config server.
configServer ConfigServerSettingsResponse
Settings of config server.
enabledState string
Enabled state of the config server. This is only used in Consumption tier.
error ErrorResponse
Error when apply config server settings.
provisioning_state This property is required. str
State of the config server.
config_server ConfigServerSettingsResponse
Settings of config server.
enabled_state str
Enabled state of the config server. This is only used in Consumption tier.
error ErrorResponse
Error when apply config server settings.
provisioningState This property is required. String
State of the config server.
configServer Property Map
Settings of config server.
enabledState String
Enabled state of the config server. This is only used in Consumption tier.
error Property Map
Error when apply config server settings.

ConfigServerSettingsResponse

GitProperty ConfigServerGitPropertyResponse
Property of git environment.
gitProperty ConfigServerGitPropertyResponse
Property of git environment.
gitProperty ConfigServerGitPropertyResponse
Property of git environment.
git_property ConfigServerGitPropertyResponse
Property of git environment.
gitProperty Property Map
Property of git environment.

ErrorResponse

Code string
The code of error.
Message string
The message of error.
Code string
The code of error.
Message string
The message of error.
code String
The code of error.
message String
The message of error.
code string
The code of error.
message string
The message of error.
code str
The code of error.
message str
The message of error.
code String
The code of error.
message String
The message of error.

GitPatternRepositoryResponse

Name This property is required. string
Name of the repository
Uri This property is required. string
URI of the repository
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.
Pattern List<string>
Collection of pattern of the repository
PrivateKey string
Private sshKey algorithm of git repository.
SearchPaths List<string>
Searching path of the repository
StrictHostKeyChecking bool
Strict host key checking or not.
Username string
Username of git repository basic auth.
Name This property is required. string
Name of the repository
Uri This property is required. string
URI of the repository
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.
Pattern []string
Collection of pattern of the repository
PrivateKey string
Private sshKey algorithm of git repository.
SearchPaths []string
Searching path of the repository
StrictHostKeyChecking bool
Strict host key checking or not.
Username string
Username of git repository basic auth.
name This property is required. String
Name of the repository
uri This property is required. String
URI of the repository
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.
pattern List<String>
Collection of pattern of the repository
privateKey String
Private sshKey algorithm of git repository.
searchPaths List<String>
Searching path of the repository
strictHostKeyChecking Boolean
Strict host key checking or not.
username String
Username of git repository basic auth.
name This property is required. string
Name of the repository
uri This property is required. string
URI of the repository
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.
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.
username string
Username of git repository basic auth.
name This property is required. str
Name of the repository
uri This property is required. str
URI of the repository
host_key str
Public sshKey of git repository.
host_key_algorithm str
SshKey algorithm of git repository.
label str
Label of the repository
password str
Password of git repository basic auth.
pattern Sequence[str]
Collection of pattern of the repository
private_key str
Private sshKey algorithm of git repository.
search_paths Sequence[str]
Searching path of the repository
strict_host_key_checking bool
Strict host key checking or not.
username str
Username of git repository basic auth.
name This property is required. String
Name of the repository
uri This property is required. String
URI of the repository
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.
pattern List<String>
Collection of pattern of the repository
privateKey String
Private sshKey algorithm of git repository.
searchPaths List<String>
Searching path of the repository
strictHostKeyChecking Boolean
Strict host key checking or not.
username String
Username of git repository basic auth.

SystemDataResponse

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
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 string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
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 string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
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 String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
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 string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource modification (UTC).
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
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 String
The type of identity that last modified the resource.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi