Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v1
  3. API Docs
  4. sql
  5. getServer
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

azure-native.sql.getServer

Explore with Pulumi AI

azure-native-v1 logo
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

    Gets a server. API Version: 2020-11-01-preview.

    Using getServer

    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 getServer(args: GetServerArgs, opts?: InvokeOptions): Promise<GetServerResult>
function getServerOutput(args: GetServerOutputArgs, opts?: InvokeOptions): Output<GetServerResult>
    def get_server(expand: Optional[str] = None,
               resource_group_name: Optional[str] = None,
               server_name: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetServerResult
def get_server_output(expand: Optional[pulumi.Input[str]] = None,
               resource_group_name: Optional[pulumi.Input[str]] = None,
               server_name: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetServerResult]
    func LookupServer(ctx *Context, args *LookupServerArgs, opts ...InvokeOption) (*LookupServerResult, error)
func LookupServerOutput(ctx *Context, args *LookupServerOutputArgs, opts ...InvokeOption) LookupServerResultOutput

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

    public static class GetServer 
{
    public static Task<GetServerResult> InvokeAsync(GetServerArgs args, InvokeOptions? opts = null)
    public static Output<GetServerResult> Invoke(GetServerInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetServerResult> getServer(GetServerArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: azure-native:sql:getServer
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ResourceGroupName 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.
    ServerName string
    The name of the server.
    Expand string
    The child resources to include in the response.
    ResourceGroupName 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.
    ServerName string
    The name of the server.
    Expand string
    The child resources to include in the response.
    resourceGroupName 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.
    serverName String
    The name of the server.
    expand String
    The child resources to include in the response.
    resourceGroupName 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.
    serverName string
    The name of the server.
    expand string
    The child resources to include in the response.
    resource_group_name 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.
    server_name str
    The name of the server.
    expand str
    The child resources to include in the response.
    resourceGroupName 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.
    serverName String
    The name of the server.
    expand String
    The child resources to include in the response.

    getServer Result

    The following output properties are available:

    FullyQualifiedDomainName string
    The fully qualified domain name of the server.
    Id string
    Resource ID.
    Kind string
    Kind of sql server. This is metadata used for the Azure portal experience.
    Location string
    Resource location.
    Name string
    Resource name.
    PrivateEndpointConnections List<Pulumi.AzureNative.Sql.Outputs.ServerPrivateEndpointConnectionResponse>
    List of private endpoint connections on a server
    State string
    The state of the server.
    Type string
    Resource type.
    WorkspaceFeature string
    Whether or not existing server has a workspace created and if it allows connection from workspace
    AdministratorLogin string
    Administrator username for the server. Once created it cannot be changed.
    Administrators Pulumi.AzureNative.Sql.Outputs.ServerExternalAdministratorResponse
    The Azure Active Directory identity of the server.
    Identity Pulumi.AzureNative.Sql.Outputs.ResourceIdentityResponse
    The Azure Active Directory identity of the server.
    KeyId string
    A CMK URI of the key to use for encryption.
    MinimalTlsVersion string
    Minimal TLS version. Allowed values: '1.0', '1.1', '1.2'
    PrimaryUserAssignedIdentityId string
    The resource id of a user assigned identity to be used by default.
    PublicNetworkAccess string
    Whether or not public endpoint access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled'
    Tags Dictionary<string, string>
    Resource tags.
    Version string
    The version of the server.
    FullyQualifiedDomainName string
    The fully qualified domain name of the server.
    Id string
    Resource ID.
    Kind string
    Kind of sql server. This is metadata used for the Azure portal experience.
    Location string
    Resource location.
    Name string
    Resource name.
    PrivateEndpointConnections []ServerPrivateEndpointConnectionResponse
    List of private endpoint connections on a server
    State string
    The state of the server.
    Type string
    Resource type.
    WorkspaceFeature string
    Whether or not existing server has a workspace created and if it allows connection from workspace
    AdministratorLogin string
    Administrator username for the server. Once created it cannot be changed.
    Administrators ServerExternalAdministratorResponse
    The Azure Active Directory identity of the server.
    Identity ResourceIdentityResponse
    The Azure Active Directory identity of the server.
    KeyId string
    A CMK URI of the key to use for encryption.
    MinimalTlsVersion string
    Minimal TLS version. Allowed values: '1.0', '1.1', '1.2'
    PrimaryUserAssignedIdentityId string
    The resource id of a user assigned identity to be used by default.
    PublicNetworkAccess string
    Whether or not public endpoint access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled'
    Tags map[string]string
    Resource tags.
    Version string
    The version of the server.
    fullyQualifiedDomainName String
    The fully qualified domain name of the server.
    id String
    Resource ID.
    kind String
    Kind of sql server. This is metadata used for the Azure portal experience.
    location String
    Resource location.
    name String
    Resource name.
    privateEndpointConnections List<ServerPrivateEndpointConnectionResponse>
    List of private endpoint connections on a server
    state String
    The state of the server.
    type String
    Resource type.
    workspaceFeature String
    Whether or not existing server has a workspace created and if it allows connection from workspace
    administratorLogin String
    Administrator username for the server. Once created it cannot be changed.
    administrators ServerExternalAdministratorResponse
    The Azure Active Directory identity of the server.
    identity ResourceIdentityResponse
    The Azure Active Directory identity of the server.
    keyId String
    A CMK URI of the key to use for encryption.
    minimalTlsVersion String
    Minimal TLS version. Allowed values: '1.0', '1.1', '1.2'
    primaryUserAssignedIdentityId String
    The resource id of a user assigned identity to be used by default.
    publicNetworkAccess String
    Whether or not public endpoint access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled'
    tags Map<String,String>
    Resource tags.
    version String
    The version of the server.
    fullyQualifiedDomainName string
    The fully qualified domain name of the server.
    id string
    Resource ID.
    kind string
    Kind of sql server. This is metadata used for the Azure portal experience.
    location string
    Resource location.
    name string
    Resource name.
    privateEndpointConnections ServerPrivateEndpointConnectionResponse[]
    List of private endpoint connections on a server
    state string
    The state of the server.
    type string
    Resource type.
    workspaceFeature string
    Whether or not existing server has a workspace created and if it allows connection from workspace
    administratorLogin string
    Administrator username for the server. Once created it cannot be changed.
    administrators ServerExternalAdministratorResponse
    The Azure Active Directory identity of the server.
    identity ResourceIdentityResponse
    The Azure Active Directory identity of the server.
    keyId string
    A CMK URI of the key to use for encryption.
    minimalTlsVersion string
    Minimal TLS version. Allowed values: '1.0', '1.1', '1.2'
    primaryUserAssignedIdentityId string
    The resource id of a user assigned identity to be used by default.
    publicNetworkAccess string
    Whether or not public endpoint access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled'
    tags {[key: string]: string}
    Resource tags.
    version string
    The version of the server.
    fully_qualified_domain_name str
    The fully qualified domain name of the server.
    id str
    Resource ID.
    kind str
    Kind of sql server. This is metadata used for the Azure portal experience.
    location str
    Resource location.
    name str
    Resource name.
    private_endpoint_connections Sequence[ServerPrivateEndpointConnectionResponse]
    List of private endpoint connections on a server
    state str
    The state of the server.
    type str
    Resource type.
    workspace_feature str
    Whether or not existing server has a workspace created and if it allows connection from workspace
    administrator_login str
    Administrator username for the server. Once created it cannot be changed.
    administrators ServerExternalAdministratorResponse
    The Azure Active Directory identity of the server.
    identity ResourceIdentityResponse
    The Azure Active Directory identity of the server.
    key_id str
    A CMK URI of the key to use for encryption.
    minimal_tls_version str
    Minimal TLS version. Allowed values: '1.0', '1.1', '1.2'
    primary_user_assigned_identity_id str
    The resource id of a user assigned identity to be used by default.
    public_network_access str
    Whether or not public endpoint access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled'
    tags Mapping[str, str]
    Resource tags.
    version str
    The version of the server.
    fullyQualifiedDomainName String
    The fully qualified domain name of the server.
    id String
    Resource ID.
    kind String
    Kind of sql server. This is metadata used for the Azure portal experience.
    location String
    Resource location.
    name String
    Resource name.
    privateEndpointConnections List<Property Map>
    List of private endpoint connections on a server
    state String
    The state of the server.
    type String
    Resource type.
    workspaceFeature String
    Whether or not existing server has a workspace created and if it allows connection from workspace
    administratorLogin String
    Administrator username for the server. Once created it cannot be changed.
    administrators Property Map
    The Azure Active Directory identity of the server.
    identity Property Map
    The Azure Active Directory identity of the server.
    keyId String
    A CMK URI of the key to use for encryption.
    minimalTlsVersion String
    Minimal TLS version. Allowed values: '1.0', '1.1', '1.2'
    primaryUserAssignedIdentityId String
    The resource id of a user assigned identity to be used by default.
    publicNetworkAccess String
    Whether or not public endpoint access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled'
    tags Map<String>
    Resource tags.
    version String
    The version of the server.

    Supporting Types

    PrivateEndpointConnectionPropertiesResponse

    ProvisioningState string
    State of the private endpoint connection.
    PrivateEndpoint Pulumi.AzureNative.Sql.Inputs.PrivateEndpointPropertyResponse
    Private endpoint which the connection belongs to.
    PrivateLinkServiceConnectionState Pulumi.AzureNative.Sql.Inputs.PrivateLinkServiceConnectionStatePropertyResponse
    Connection state of the private endpoint connection.
    ProvisioningState string
    State of the private endpoint connection.
    PrivateEndpoint PrivateEndpointPropertyResponse
    Private endpoint which the connection belongs to.
    PrivateLinkServiceConnectionState PrivateLinkServiceConnectionStatePropertyResponse
    Connection state of the private endpoint connection.
    provisioningState String
    State of the private endpoint connection.
    privateEndpoint PrivateEndpointPropertyResponse
    Private endpoint which the connection belongs to.
    privateLinkServiceConnectionState PrivateLinkServiceConnectionStatePropertyResponse
    Connection state of the private endpoint connection.
    provisioningState string
    State of the private endpoint connection.
    privateEndpoint PrivateEndpointPropertyResponse
    Private endpoint which the connection belongs to.
    privateLinkServiceConnectionState PrivateLinkServiceConnectionStatePropertyResponse
    Connection state of the private endpoint connection.
    provisioning_state str
    State of the private endpoint connection.
    private_endpoint PrivateEndpointPropertyResponse
    Private endpoint which the connection belongs to.
    private_link_service_connection_state PrivateLinkServiceConnectionStatePropertyResponse
    Connection state of the private endpoint connection.
    provisioningState String
    State of the private endpoint connection.
    privateEndpoint Property Map
    Private endpoint which the connection belongs to.
    privateLinkServiceConnectionState Property Map
    Connection state of the private endpoint connection.

    PrivateEndpointPropertyResponse

    Id string
    Resource id of the private endpoint.
    Id string
    Resource id of the private endpoint.
    id String
    Resource id of the private endpoint.
    id string
    Resource id of the private endpoint.
    id str
    Resource id of the private endpoint.
    id String
    Resource id of the private endpoint.

    PrivateLinkServiceConnectionStatePropertyResponse

    ActionsRequired string
    The actions required for private link service connection.
    Description string
    The private link service connection description.
    Status string
    The private link service connection status.
    ActionsRequired string
    The actions required for private link service connection.
    Description string
    The private link service connection description.
    Status string
    The private link service connection status.
    actionsRequired String
    The actions required for private link service connection.
    description String
    The private link service connection description.
    status String
    The private link service connection status.
    actionsRequired string
    The actions required for private link service connection.
    description string
    The private link service connection description.
    status string
    The private link service connection status.
    actions_required str
    The actions required for private link service connection.
    description str
    The private link service connection description.
    status str
    The private link service connection status.
    actionsRequired String
    The actions required for private link service connection.
    description String
    The private link service connection description.
    status String
    The private link service connection status.

    ResourceIdentityResponse

    PrincipalId string
    The Azure Active Directory principal id.
    TenantId string
    The Azure Active Directory tenant id.
    Type string
    The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource.
    UserAssignedIdentities Dictionary<string, Pulumi.AzureNative.Sql.Inputs.UserIdentityResponse>
    The resource ids of the user assigned identities to use
    PrincipalId string
    The Azure Active Directory principal id.
    TenantId string
    The Azure Active Directory tenant id.
    Type string
    The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource.
    UserAssignedIdentities map[string]UserIdentityResponse
    The resource ids of the user assigned identities to use
    principalId String
    The Azure Active Directory principal id.
    tenantId String
    The Azure Active Directory tenant id.
    type String
    The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource.
    userAssignedIdentities Map<String,UserIdentityResponse>
    The resource ids of the user assigned identities to use
    principalId string
    The Azure Active Directory principal id.
    tenantId string
    The Azure Active Directory tenant id.
    type string
    The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource.
    userAssignedIdentities {[key: string]: UserIdentityResponse}
    The resource ids of the user assigned identities to use
    principal_id str
    The Azure Active Directory principal id.
    tenant_id str
    The Azure Active Directory tenant id.
    type str
    The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource.
    user_assigned_identities Mapping[str, UserIdentityResponse]
    The resource ids of the user assigned identities to use
    principalId String
    The Azure Active Directory principal id.
    tenantId String
    The Azure Active Directory tenant id.
    type String
    The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource.
    userAssignedIdentities Map<Property Map>
    The resource ids of the user assigned identities to use

    ServerExternalAdministratorResponse

    AdministratorType string
    Type of the sever administrator.
    AzureADOnlyAuthentication bool
    Azure Active Directory only Authentication enabled.
    Login string
    Login name of the server administrator.
    PrincipalType string
    Principal Type of the sever administrator.
    Sid string
    SID (object ID) of the server administrator.
    TenantId string
    Tenant ID of the administrator.
    AdministratorType string
    Type of the sever administrator.
    AzureADOnlyAuthentication bool
    Azure Active Directory only Authentication enabled.
    Login string
    Login name of the server administrator.
    PrincipalType string
    Principal Type of the sever administrator.
    Sid string
    SID (object ID) of the server administrator.
    TenantId string
    Tenant ID of the administrator.
    administratorType String
    Type of the sever administrator.
    azureADOnlyAuthentication Boolean
    Azure Active Directory only Authentication enabled.
    login String
    Login name of the server administrator.
    principalType String
    Principal Type of the sever administrator.
    sid String
    SID (object ID) of the server administrator.
    tenantId String
    Tenant ID of the administrator.
    administratorType string
    Type of the sever administrator.
    azureADOnlyAuthentication boolean
    Azure Active Directory only Authentication enabled.
    login string
    Login name of the server administrator.
    principalType string
    Principal Type of the sever administrator.
    sid string
    SID (object ID) of the server administrator.
    tenantId string
    Tenant ID of the administrator.
    administrator_type str
    Type of the sever administrator.
    azure_ad_only_authentication bool
    Azure Active Directory only Authentication enabled.
    login str
    Login name of the server administrator.
    principal_type str
    Principal Type of the sever administrator.
    sid str
    SID (object ID) of the server administrator.
    tenant_id str
    Tenant ID of the administrator.
    administratorType String
    Type of the sever administrator.
    azureADOnlyAuthentication Boolean
    Azure Active Directory only Authentication enabled.
    login String
    Login name of the server administrator.
    principalType String
    Principal Type of the sever administrator.
    sid String
    SID (object ID) of the server administrator.
    tenantId String
    Tenant ID of the administrator.

    ServerPrivateEndpointConnectionResponse

    Id string
    Resource ID.
    Properties Pulumi.AzureNative.Sql.Inputs.PrivateEndpointConnectionPropertiesResponse
    Private endpoint connection properties
    Id string
    Resource ID.
    Properties PrivateEndpointConnectionPropertiesResponse
    Private endpoint connection properties
    id String
    Resource ID.
    properties PrivateEndpointConnectionPropertiesResponse
    Private endpoint connection properties
    id string
    Resource ID.
    properties PrivateEndpointConnectionPropertiesResponse
    Private endpoint connection properties
    id str
    Resource ID.
    properties PrivateEndpointConnectionPropertiesResponse
    Private endpoint connection properties
    id String
    Resource ID.
    properties Property Map
    Private endpoint connection properties

    UserIdentityResponse

    ClientId string
    The Azure Active Directory client id.
    PrincipalId string
    The Azure Active Directory principal id.
    ClientId string
    The Azure Active Directory client id.
    PrincipalId string
    The Azure Active Directory principal id.
    clientId String
    The Azure Active Directory client id.
    principalId String
    The Azure Active Directory principal id.
    clientId string
    The Azure Active Directory client id.
    principalId string
    The Azure Active Directory principal id.
    client_id str
    The Azure Active Directory client id.
    principal_id str
    The Azure Active Directory principal id.
    clientId String
    The Azure Active Directory client id.
    principalId String
    The Azure Active Directory principal id.

    Package Details

    Repository
    azure-native-v1 pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native-v1 logo
    These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
    Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
    pulumi/pulumi-azure-native