published on Wednesday, Mar 4, 2026 by Pulumi
published on Wednesday, Mar 4, 2026 by Pulumi
Gets the SQL userDefinedFunction under an existing Azure Cosmos DB database account.
Uses Azure REST API version 2025-10-15.
Other available API versions: 2019-08-01, 2019-12-12, 2020-03-01, 2020-04-01, 2020-06-01-preview, 2020-09-01, 2021-01-15, 2021-03-01-preview, 2021-03-15, 2021-04-01-preview, 2021-04-15, 2021-05-15, 2021-06-15, 2021-07-01-preview, 2021-10-15, 2021-10-15-preview, 2021-11-15-preview, 2022-02-15-preview, 2022-05-15, 2022-05-15-preview, 2022-08-15, 2022-08-15-preview, 2022-11-15, 2022-11-15-preview, 2023-03-01-preview, 2023-03-15, 2023-03-15-preview, 2023-04-15, 2023-09-15, 2023-09-15-preview, 2023-11-15, 2023-11-15-preview, 2024-02-15-preview, 2024-05-15, 2024-05-15-preview, 2024-08-15, 2024-09-01-preview, 2024-11-15, 2024-12-01-preview, 2025-04-15, 2025-05-01-preview, 2025-11-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native cosmosdb [ApiVersion]. See the version guide for details.
Using getSqlResourceSqlUserDefinedFunction
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 getSqlResourceSqlUserDefinedFunction(args: GetSqlResourceSqlUserDefinedFunctionArgs, opts?: InvokeOptions): Promise<GetSqlResourceSqlUserDefinedFunctionResult>
function getSqlResourceSqlUserDefinedFunctionOutput(args: GetSqlResourceSqlUserDefinedFunctionOutputArgs, opts?: InvokeOptions): Output<GetSqlResourceSqlUserDefinedFunctionResult>def get_sql_resource_sql_user_defined_function(account_name: Optional[str] = None,
container_name: Optional[str] = None,
database_name: Optional[str] = None,
resource_group_name: Optional[str] = None,
user_defined_function_name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetSqlResourceSqlUserDefinedFunctionResult
def get_sql_resource_sql_user_defined_function_output(account_name: Optional[pulumi.Input[str]] = None,
container_name: Optional[pulumi.Input[str]] = None,
database_name: Optional[pulumi.Input[str]] = None,
resource_group_name: Optional[pulumi.Input[str]] = None,
user_defined_function_name: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetSqlResourceSqlUserDefinedFunctionResult]func LookupSqlResourceSqlUserDefinedFunction(ctx *Context, args *LookupSqlResourceSqlUserDefinedFunctionArgs, opts ...InvokeOption) (*LookupSqlResourceSqlUserDefinedFunctionResult, error)
func LookupSqlResourceSqlUserDefinedFunctionOutput(ctx *Context, args *LookupSqlResourceSqlUserDefinedFunctionOutputArgs, opts ...InvokeOption) LookupSqlResourceSqlUserDefinedFunctionResultOutput> Note: This function is named LookupSqlResourceSqlUserDefinedFunction in the Go SDK.
public static class GetSqlResourceSqlUserDefinedFunction
{
public static Task<GetSqlResourceSqlUserDefinedFunctionResult> InvokeAsync(GetSqlResourceSqlUserDefinedFunctionArgs args, InvokeOptions? opts = null)
public static Output<GetSqlResourceSqlUserDefinedFunctionResult> Invoke(GetSqlResourceSqlUserDefinedFunctionInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetSqlResourceSqlUserDefinedFunctionResult> getSqlResourceSqlUserDefinedFunction(GetSqlResourceSqlUserDefinedFunctionArgs args, InvokeOptions options)
public static Output<GetSqlResourceSqlUserDefinedFunctionResult> getSqlResourceSqlUserDefinedFunction(GetSqlResourceSqlUserDefinedFunctionArgs args, InvokeOptions options)
fn::invoke:
function: azure-native:cosmosdb:getSqlResourceSqlUserDefinedFunction
arguments:
# arguments dictionaryThe following arguments are supported:
- Account
Name string - Cosmos DB database account name.
- Container
Name string - Cosmos DB container name.
- Database
Name string - Cosmos DB database name.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- User
Defined stringFunction Name - Cosmos DB userDefinedFunction name.
- Account
Name string - Cosmos DB database account name.
- Container
Name string - Cosmos DB container name.
- Database
Name string - Cosmos DB database name.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- User
Defined stringFunction Name - Cosmos DB userDefinedFunction name.
- account
Name String - Cosmos DB database account name.
- container
Name String - Cosmos DB container name.
- database
Name String - Cosmos DB database name.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- user
Defined StringFunction Name - Cosmos DB userDefinedFunction name.
- account
Name string - Cosmos DB database account name.
- container
Name string - Cosmos DB container name.
- database
Name string - Cosmos DB database name.
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- user
Defined stringFunction Name - Cosmos DB userDefinedFunction name.
- account_
name str - Cosmos DB database account name.
- container_
name str - Cosmos DB container name.
- database_
name str - Cosmos DB database name.
- resource_
group_ strname - The name of the resource group. The name is case insensitive.
- user_
defined_ strfunction_ name - Cosmos DB userDefinedFunction name.
- account
Name String - Cosmos DB database account name.
- container
Name String - Cosmos DB container name.
- database
Name String - Cosmos DB database name.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- user
Defined StringFunction Name - Cosmos DB userDefinedFunction name.
getSqlResourceSqlUserDefinedFunction Result
The following output properties are available:
- Azure
Api stringVersion - The Azure API version of the resource.
- Id string
- The unique resource identifier of the ARM resource.
- Name string
- The name of the ARM resource.
- Type string
- The type of Azure resource.
- Location string
- The location of the resource group to which the resource belongs.
- Resource
Pulumi.
Azure Native. Cosmos DB. Outputs. Sql User Defined Function Get Properties Response Resource - Dictionary<string, string>
- Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".
- Azure
Api stringVersion - The Azure API version of the resource.
- Id string
- The unique resource identifier of the ARM resource.
- Name string
- The name of the ARM resource.
- Type string
- The type of Azure resource.
- Location string
- The location of the resource group to which the resource belongs.
- Resource
Sql
User Defined Function Get Properties Response Resource - map[string]string
- Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".
- azure
Api StringVersion - The Azure API version of the resource.
- id String
- The unique resource identifier of the ARM resource.
- name String
- The name of the ARM resource.
- type String
- The type of Azure resource.
- location String
- The location of the resource group to which the resource belongs.
- resource
Sql
User Defined Function Get Properties Response Resource - Map<String,String>
- Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".
- azure
Api stringVersion - The Azure API version of the resource.
- id string
- The unique resource identifier of the ARM resource.
- name string
- The name of the ARM resource.
- type string
- The type of Azure resource.
- location string
- The location of the resource group to which the resource belongs.
- resource
Sql
User Defined Function Get Properties Response Resource - {[key: string]: string}
- Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".
- azure_
api_ strversion - The Azure API version of the resource.
- id str
- The unique resource identifier of the ARM resource.
- name str
- The name of the ARM resource.
- type str
- The type of Azure resource.
- location str
- The location of the resource group to which the resource belongs.
- resource
Sql
User Defined Function Get Properties Response Resource - Mapping[str, str]
- Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".
- azure
Api StringVersion - The Azure API version of the resource.
- id String
- The unique resource identifier of the ARM resource.
- name String
- The name of the ARM resource.
- type String
- The type of Azure resource.
- location String
- The location of the resource group to which the resource belongs.
- resource Property Map
- Map<String>
- Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".
Supporting Types
SqlUserDefinedFunctionGetPropertiesResponseResource
- Etag string
- A system generated property representing the resource etag required for optimistic concurrency control.
- Id string
- Name of the Cosmos DB SQL userDefinedFunction
- Rid string
- A system generated property. A unique identifier.
- Ts double
- A system generated property that denotes the last updated timestamp of the resource.
- Body string
- Body of the User Defined Function
- Etag string
- A system generated property representing the resource etag required for optimistic concurrency control.
- Id string
- Name of the Cosmos DB SQL userDefinedFunction
- Rid string
- A system generated property. A unique identifier.
- Ts float64
- A system generated property that denotes the last updated timestamp of the resource.
- Body string
- Body of the User Defined Function
- etag String
- A system generated property representing the resource etag required for optimistic concurrency control.
- id String
- Name of the Cosmos DB SQL userDefinedFunction
- rid String
- A system generated property. A unique identifier.
- ts Double
- A system generated property that denotes the last updated timestamp of the resource.
- body String
- Body of the User Defined Function
- etag string
- A system generated property representing the resource etag required for optimistic concurrency control.
- id string
- Name of the Cosmos DB SQL userDefinedFunction
- rid string
- A system generated property. A unique identifier.
- ts number
- A system generated property that denotes the last updated timestamp of the resource.
- body string
- Body of the User Defined Function
- etag str
- A system generated property representing the resource etag required for optimistic concurrency control.
- id str
- Name of the Cosmos DB SQL userDefinedFunction
- rid str
- A system generated property. A unique identifier.
- ts float
- A system generated property that denotes the last updated timestamp of the resource.
- body str
- Body of the User Defined Function
- etag String
- A system generated property representing the resource etag required for optimistic concurrency control.
- id String
- Name of the Cosmos DB SQL userDefinedFunction
- rid String
- A system generated property. A unique identifier.
- ts Number
- A system generated property that denotes the last updated timestamp of the resource.
- body String
- Body of the User Defined Function
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0
published on Wednesday, Mar 4, 2026 by Pulumi
