Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. apimanagement
  5. getApiRelease
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
pulumi/pulumi-azure-native

azure-native.apimanagement.getApiRelease

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
pulumi/pulumi-azure-native

Returns the details of an API release.

Uses Azure REST API version 2022-09-01-preview.

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

Using getApiRelease

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 getApiRelease(args: GetApiReleaseArgs, opts?: InvokeOptions): Promise<GetApiReleaseResult>
function getApiReleaseOutput(args: GetApiReleaseOutputArgs, opts?: InvokeOptions): Output<GetApiReleaseResult>
Copy
def get_api_release(api_id: Optional[str] = None,
                    release_id: Optional[str] = None,
                    resource_group_name: Optional[str] = None,
                    service_name: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetApiReleaseResult
def get_api_release_output(api_id: Optional[pulumi.Input[str]] = None,
                    release_id: Optional[pulumi.Input[str]] = None,
                    resource_group_name: Optional[pulumi.Input[str]] = None,
                    service_name: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetApiReleaseResult]
Copy
func LookupApiRelease(ctx *Context, args *LookupApiReleaseArgs, opts ...InvokeOption) (*LookupApiReleaseResult, error)
func LookupApiReleaseOutput(ctx *Context, args *LookupApiReleaseOutputArgs, opts ...InvokeOption) LookupApiReleaseResultOutput
Copy

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

public static class GetApiRelease 
{
    public static Task<GetApiReleaseResult> InvokeAsync(GetApiReleaseArgs args, InvokeOptions? opts = null)
    public static Output<GetApiReleaseResult> Invoke(GetApiReleaseInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetApiReleaseResult> getApiRelease(GetApiReleaseArgs args, InvokeOptions options)
public static Output<GetApiReleaseResult> getApiRelease(GetApiReleaseArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:apimanagement:getApiRelease
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ApiId
This property is required.
Changes to this property will trigger replacement.
string
API identifier. Must be unique in the current API Management service instance.
ReleaseId
This property is required.
Changes to this property will trigger replacement.
string
Release identifier within an API. Must be unique in the current API Management service instance.
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 the API Management service.
ApiId
This property is required.
Changes to this property will trigger replacement.
string
API identifier. Must be unique in the current API Management service instance.
ReleaseId
This property is required.
Changes to this property will trigger replacement.
string
Release identifier within an API. Must be unique in the current API Management service instance.
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 the API Management service.
apiId
This property is required.
Changes to this property will trigger replacement.
String
API identifier. Must be unique in the current API Management service instance.
releaseId
This property is required.
Changes to this property will trigger replacement.
String
Release identifier within an API. Must be unique in the current API Management service instance.
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 the API Management service.
apiId
This property is required.
Changes to this property will trigger replacement.
string
API identifier. Must be unique in the current API Management service instance.
releaseId
This property is required.
Changes to this property will trigger replacement.
string
Release identifier within an API. Must be unique in the current API Management service instance.
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 the API Management service.
api_id
This property is required.
Changes to this property will trigger replacement.
str
API identifier. Must be unique in the current API Management service instance.
release_id
This property is required.
Changes to this property will trigger replacement.
str
Release identifier within an API. Must be unique in the current API Management service instance.
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 the API Management service.
apiId
This property is required.
Changes to this property will trigger replacement.
String
API identifier. Must be unique in the current API Management service instance.
releaseId
This property is required.
Changes to this property will trigger replacement.
String
Release identifier within an API. Must be unique in the current API Management service instance.
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 the API Management service.

getApiRelease Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
CreatedDateTime string
The time the API was released. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string
The name of the resource
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
UpdatedDateTime string
The time the API release was updated.
ApiId string
Identifier of the API the release belongs to.
Notes string
Release Notes
AzureApiVersion string
The Azure API version of the resource.
CreatedDateTime string
The time the API was released. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string
The name of the resource
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
UpdatedDateTime string
The time the API release was updated.
ApiId string
Identifier of the API the release belongs to.
Notes string
Release Notes
azureApiVersion String
The Azure API version of the resource.
createdDateTime String
The time the API was released. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String
The name of the resource
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
updatedDateTime String
The time the API release was updated.
apiId String
Identifier of the API the release belongs to.
notes String
Release Notes
azureApiVersion string
The Azure API version of the resource.
createdDateTime string
The time the API was released. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name string
The name of the resource
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
updatedDateTime string
The time the API release was updated.
apiId string
Identifier of the API the release belongs to.
notes string
Release Notes
azure_api_version str
The Azure API version of the resource.
created_date_time str
The time the API was released. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
id str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name str
The name of the resource
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
updated_date_time str
The time the API release was updated.
api_id str
Identifier of the API the release belongs to.
notes str
Release Notes
azureApiVersion String
The Azure API version of the resource.
createdDateTime String
The time the API was released. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String
The name of the resource
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
updatedDateTime String
The time the API release was updated.
apiId String
Identifier of the API the release belongs to.
notes String
Release Notes

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
pulumi/pulumi-azure-native