Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. apicenter
  5. getDeployment
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.apicenter.getDeployment

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 details of the API deployment.

Uses Azure REST API version 2024-03-15-preview.

Other available API versions: 2024-03-01, 2024-06-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native apicenter [ApiVersion]. See the version guide for details.

Using getDeployment

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 getDeployment(args: GetDeploymentArgs, opts?: InvokeOptions): Promise<GetDeploymentResult>
function getDeploymentOutput(args: GetDeploymentOutputArgs, opts?: InvokeOptions): Output<GetDeploymentResult>
Copy
def get_deployment(api_name: Optional[str] = None,
                   deployment_name: Optional[str] = None,
                   resource_group_name: Optional[str] = None,
                   service_name: Optional[str] = None,
                   workspace_name: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetDeploymentResult
def get_deployment_output(api_name: Optional[pulumi.Input[str]] = None,
                   deployment_name: Optional[pulumi.Input[str]] = None,
                   resource_group_name: Optional[pulumi.Input[str]] = None,
                   service_name: Optional[pulumi.Input[str]] = None,
                   workspace_name: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetDeploymentResult]
Copy
func LookupDeployment(ctx *Context, args *LookupDeploymentArgs, opts ...InvokeOption) (*LookupDeploymentResult, error)
func LookupDeploymentOutput(ctx *Context, args *LookupDeploymentOutputArgs, opts ...InvokeOption) LookupDeploymentResultOutput
Copy

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

public static class GetDeployment 
{
    public static Task<GetDeploymentResult> InvokeAsync(GetDeploymentArgs args, InvokeOptions? opts = null)
    public static Output<GetDeploymentResult> Invoke(GetDeploymentInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetDeploymentResult> getDeployment(GetDeploymentArgs args, InvokeOptions options)
public static Output<GetDeploymentResult> getDeployment(GetDeploymentArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:apicenter:getDeployment
  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.
DeploymentName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API deployment.
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.
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.
DeploymentName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API deployment.
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.
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.
deploymentName
This property is required.
Changes to this property will trigger replacement.
String
The name of the API deployment.
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.
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.
deploymentName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API deployment.
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.
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.
deployment_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the API deployment.
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.
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.
deploymentName
This property is required.
Changes to this property will trigger replacement.
String
The name of the API deployment.
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.
workspaceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the workspace.

getDeployment 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. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
Name string
The name of the resource
SystemData Pulumi.AzureNative.ApiCenter.Outputs.SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
CustomProperties object
The custom metadata defined for API catalog entities.
DefinitionId string
API center-scoped definition resource ID.
Description string
Description of the deployment.
EnvironmentId string
API center-scoped environment resource ID.
Server Pulumi.AzureNative.ApiCenter.Outputs.DeploymentServerResponse
The deployment server
State string
State of API deployment.
Title string
API deployment title
AzureApiVersion string
The Azure API version of the resource.
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
SystemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
CustomProperties interface{}
The custom metadata defined for API catalog entities.
DefinitionId string
API center-scoped definition resource ID.
Description string
Description of the deployment.
EnvironmentId string
API center-scoped environment resource ID.
Server DeploymentServerResponse
The deployment server
State string
State of API deployment.
Title string
API deployment title
azureApiVersion String
The Azure API version of the resource.
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
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
customProperties Object
The custom metadata defined for API catalog entities.
definitionId String
API center-scoped definition resource ID.
description String
Description of the deployment.
environmentId String
API center-scoped environment resource ID.
server DeploymentServerResponse
The deployment server
state String
State of API deployment.
title String
API deployment title
azureApiVersion string
The Azure API version of the resource.
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
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
customProperties any
The custom metadata defined for API catalog entities.
definitionId string
API center-scoped definition resource ID.
description string
Description of the deployment.
environmentId string
API center-scoped environment resource ID.
server DeploymentServerResponse
The deployment server
state string
State of API deployment.
title string
API deployment title
azure_api_version str
The Azure API version of the resource.
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
system_data SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
custom_properties Any
The custom metadata defined for API catalog entities.
definition_id str
API center-scoped definition resource ID.
description str
Description of the deployment.
environment_id str
API center-scoped environment resource ID.
server DeploymentServerResponse
The deployment server
state str
State of API deployment.
title str
API deployment title
azureApiVersion String
The Azure API version of the resource.
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
systemData Property Map
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
customProperties Any
The custom metadata defined for API catalog entities.
definitionId String
API center-scoped definition resource ID.
description String
Description of the deployment.
environmentId String
API center-scoped environment resource ID.
server Property Map
The deployment server
state String
State of API deployment.
title String
API deployment title

Supporting Types

DeploymentServerResponse

RuntimeUri List<string>
Base runtime URLs for this deployment.
RuntimeUri []string
Base runtime URLs for this deployment.
runtimeUri List<String>
Base runtime URLs for this deployment.
runtimeUri string[]
Base runtime URLs for this deployment.
runtime_uri Sequence[str]
Base runtime URLs for this deployment.
runtimeUri List<String>
Base runtime URLs for this deployment.

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 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