Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. apicenter
  5. getApiDefinition
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.apicenter.getApiDefinition

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Returns details of the API definition. Azure REST API version: 2024-03-01.

Other available API versions: 2024-03-15-preview, 2024-06-01-preview.

Using getApiDefinition

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 getApiDefinition(args: GetApiDefinitionArgs, opts?: InvokeOptions): Promise<GetApiDefinitionResult>
function getApiDefinitionOutput(args: GetApiDefinitionOutputArgs, opts?: InvokeOptions): Output<GetApiDefinitionResult>
Copy
def get_api_definition(api_name: Optional[str] = None,
                       definition_name: Optional[str] = None,
                       resource_group_name: Optional[str] = None,
                       service_name: Optional[str] = None,
                       version_name: Optional[str] = None,
                       workspace_name: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetApiDefinitionResult
def get_api_definition_output(api_name: Optional[pulumi.Input[str]] = None,
                       definition_name: Optional[pulumi.Input[str]] = None,
                       resource_group_name: Optional[pulumi.Input[str]] = None,
                       service_name: Optional[pulumi.Input[str]] = None,
                       version_name: Optional[pulumi.Input[str]] = None,
                       workspace_name: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetApiDefinitionResult]
Copy
func LookupApiDefinition(ctx *Context, args *LookupApiDefinitionArgs, opts ...InvokeOption) (*LookupApiDefinitionResult, error)
func LookupApiDefinitionOutput(ctx *Context, args *LookupApiDefinitionOutputArgs, opts ...InvokeOption) LookupApiDefinitionResultOutput
Copy

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

public static class GetApiDefinition 
{
    public static Task<GetApiDefinitionResult> InvokeAsync(GetApiDefinitionArgs args, InvokeOptions? opts = null)
    public static Output<GetApiDefinitionResult> Invoke(GetApiDefinitionInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetApiDefinitionResult> getApiDefinition(GetApiDefinitionArgs args, InvokeOptions options)
public static Output<GetApiDefinitionResult> getApiDefinition(GetApiDefinitionArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:apicenter:getApiDefinition
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ApiName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API.
DefinitionName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API definition.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ServiceName
This property is required.
Changes to this property will trigger replacement.
string
The name of Azure API Center service.
VersionName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API version.
WorkspaceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the workspace.
ApiName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API.
DefinitionName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API definition.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ServiceName
This property is required.
Changes to this property will trigger replacement.
string
The name of Azure API Center service.
VersionName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API version.
WorkspaceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the workspace.
apiName
This property is required.
Changes to this property will trigger replacement.
String
The name of the API.
definitionName
This property is required.
Changes to this property will trigger replacement.
String
The name of the API definition.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
serviceName
This property is required.
Changes to this property will trigger replacement.
String
The name of Azure API Center service.
versionName
This property is required.
Changes to this property will trigger replacement.
String
The name of the API version.
workspaceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the workspace.
apiName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API.
definitionName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API definition.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
serviceName
This property is required.
Changes to this property will trigger replacement.
string
The name of Azure API Center service.
versionName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API version.
workspaceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the workspace.
api_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the API.
definition_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the API definition.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
service_name
This property is required.
Changes to this property will trigger replacement.
str
The name of Azure API Center service.
version_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the API version.
workspace_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the workspace.
apiName
This property is required.
Changes to this property will trigger replacement.
String
The name of the API.
definitionName
This property is required.
Changes to this property will trigger replacement.
String
The name of the API definition.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
serviceName
This property is required.
Changes to this property will trigger replacement.
String
The name of Azure API Center service.
versionName
This property is required.
Changes to this property will trigger replacement.
String
The name of the API version.
workspaceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the workspace.

getApiDefinition Result

The following output properties are available:

Id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
Name string
The name of the resource
Specification Pulumi.AzureNative.ApiCenter.Outputs.ApiDefinitionPropertiesSpecificationResponse
API specification details.
SystemData Pulumi.AzureNative.ApiCenter.Outputs.SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Title string
API definition title.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Description string
API definition description.
Id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
Name string
The name of the resource
Specification ApiDefinitionPropertiesSpecificationResponse
API specification details.
SystemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Title string
API definition title.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Description string
API definition description.
id String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name String
The name of the resource
specification ApiDefinitionPropertiesSpecificationResponse
API specification details.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
title String
API definition title.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
description String
API definition description.
id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name string
The name of the resource
specification ApiDefinitionPropertiesSpecificationResponse
API specification details.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
title string
API definition title.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
description string
API definition description.
id str
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name str
The name of the resource
specification ApiDefinitionPropertiesSpecificationResponse
API specification details.
system_data SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
title str
API definition title.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
description str
API definition description.
id String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name String
The name of the resource
specification Property Map
API specification details.
systemData Property Map
Azure Resource Manager metadata containing createdBy and modifiedBy information.
title String
API definition title.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
description String
API definition description.

Supporting Types

ApiDefinitionPropertiesSpecificationResponse

Name string
Specification name.
Version string
Specification version.
Name string
Specification name.
Version string
Specification version.
name String
Specification name.
version String
Specification version.
name string
Specification name.
version string
Specification version.
name str
Specification name.
version str
Specification version.
name String
Specification name.
version String
Specification version.

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 last 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 last 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 last 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 last 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 last 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 last 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-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native