Azure Native v2.41.0, May 14 24

This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.

Azure Native v2.41.0 published on Tuesday, May 14, 2024 by Pulumi

pulumi/pulumi-azure-native

azure-native.apicenter.getApi

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.

Azure Native v2.41.0 published on Tuesday, May 14, 2024 by Pulumi

pulumi/pulumi-azure-native

Using getApi

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 getApi(args: GetApiArgs, opts?: InvokeOptions): Promise<GetApiResult>
function getApiOutput(args: GetApiOutputArgs, opts?: InvokeOptions): Output<GetApiResult>

def get_api(api_name: Optional[str] = None,
            resource_group_name: Optional[str] = None,
            service_name: Optional[str] = None,
            workspace_name: Optional[str] = None,
            opts: Optional[InvokeOptions] = None) -> GetApiResult
def get_api_output(api_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[GetApiResult]

func LookupApi(ctx *Context, args *LookupApiArgs, opts ...InvokeOption) (*LookupApiResult, error)
func LookupApiOutput(ctx *Context, args *LookupApiOutputArgs, opts ...InvokeOption) LookupApiResultOutput

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

public static class GetApi 
{
    public static Task<GetApiResult> InvokeAsync(GetApiArgs args, InvokeOptions? opts = null)
    public static Output<GetApiResult> Invoke(GetApiInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetApiResult> getApi(GetApiArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: azure-native:apicenter:getApi
  arguments:
    # arguments dictionary

The following arguments are supported:

ApiName string: The name of the API.
ResourceGroupName string: The name of the resource group. The name is case insensitive.
ServiceName string: The name of Azure API Center service.
WorkspaceName string: The name of the workspace.

ApiName string: The name of the API.
ResourceGroupName string: The name of the resource group. The name is case insensitive.
ServiceName string: The name of Azure API Center service.
WorkspaceName string: The name of the workspace.

apiName String: The name of the API.
resourceGroupName String: The name of the resource group. The name is case insensitive.
serviceName String: The name of Azure API Center service.
workspaceName String: The name of the workspace.

apiName string: The name of the API.
resourceGroupName string: The name of the resource group. The name is case insensitive.
serviceName string: The name of Azure API Center service.
workspaceName string: The name of the workspace.

api_name str: The name of the API.
resource_group_name str: The name of the resource group. The name is case insensitive.
service_name str: The name of Azure API Center service.
workspace_name str: The name of the workspace.

apiName String: The name of the API.
resourceGroupName String: The name of the resource group. The name is case insensitive.
serviceName String: The name of Azure API Center service.
workspaceName String: The name of the workspace.

getApi 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}"
Kind string: Kind of API. For example, REST or GraphQL.
LifecycleStage string: Current lifecycle stage of the API.
Name string: The name of the resource
SystemData Pulumi.AzureNative.ApiCenter.Outputs.SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
Title string: API title.
Type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Contacts List<Pulumi.AzureNative.ApiCenter.Outputs.ContactResponse>: The set of contacts
CustomProperties object: The custom metadata defined for API catalog entities.
Description string: Description of the API.
ExternalDocumentation List<Pulumi.AzureNative.ApiCenter.Outputs.ExternalDocumentationResponse>: The set of external documentation
License Pulumi.AzureNative.ApiCenter.Outputs.LicenseResponse: The license information for the API.
Summary string: Short description of the API.
TermsOfService Pulumi.AzureNative.ApiCenter.Outputs.TermsOfServiceResponse: Terms of service for the API.

Id string: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
Kind string: Kind of API. For example, REST or GraphQL.
LifecycleStage string: Current lifecycle stage of the API.
Name string: The name of the resource
SystemData SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
Title string: API title.
Type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Contacts []ContactResponse: The set of contacts
CustomProperties interface{}: The custom metadata defined for API catalog entities.
Description string: Description of the API.
ExternalDocumentation []ExternalDocumentationResponse: The set of external documentation
License LicenseResponse: The license information for the API.
Summary string: Short description of the API.
TermsOfService TermsOfServiceResponse: Terms of service for the API.

id String: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind String: Kind of API. For example, REST or GraphQL.
lifecycleStage String: Current lifecycle stage of the API.
name String: The name of the resource
systemData SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
title String: API title.
type String: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
contacts List<ContactResponse>: The set of contacts
customProperties Object: The custom metadata defined for API catalog entities.
description String: Description of the API.
externalDocumentation List<ExternalDocumentationResponse>: The set of external documentation
license LicenseResponse: The license information for the API.
summary String: Short description of the API.
termsOfService TermsOfServiceResponse: Terms of service for the API.

id string: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind string: Kind of API. For example, REST or GraphQL.
lifecycleStage string: Current lifecycle stage of the API.
name string: The name of the resource
systemData SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
title string: API title.
type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
contacts ContactResponse[]: The set of contacts
customProperties any: The custom metadata defined for API catalog entities.
description string: Description of the API.
externalDocumentation ExternalDocumentationResponse[]: The set of external documentation
license LicenseResponse: The license information for the API.
summary string: Short description of the API.
termsOfService TermsOfServiceResponse: Terms of service for the API.

id str: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind str: Kind of API. For example, REST or GraphQL.
lifecycle_stage str: Current lifecycle stage of the API.
name str: The name of the resource
system_data SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
title str: API title.
type str: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
contacts Sequence[ContactResponse]: The set of contacts
custom_properties Any: The custom metadata defined for API catalog entities.
description str: Description of the API.
external_documentation Sequence[ExternalDocumentationResponse]: The set of external documentation
license LicenseResponse: The license information for the API.
summary str: Short description of the API.
terms_of_service TermsOfServiceResponse: Terms of service for the API.

id String: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind String: Kind of API. For example, REST or GraphQL.
lifecycleStage String: Current lifecycle stage of the API.
name String: The name of the resource
systemData Property Map: Azure Resource Manager metadata containing createdBy and modifiedBy information.
title String: API title.
type String: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
contacts List<Property Map>: The set of contacts
customProperties Any: The custom metadata defined for API catalog entities.
description String: Description of the API.
externalDocumentation List<Property Map>: The set of external documentation
license Property Map: The license information for the API.
summary String: Short description of the API.
termsOfService Property Map: Terms of service for the API.

Supporting Types

ContactResponse

Email string: Email address of the contact.
Name string: Name of the contact.
Url string: URL for the contact.

Email string: Email address of the contact.
Name string: Name of the contact.
Url string: URL for the contact.

email String: Email address of the contact.
name String: Name of the contact.
url String: URL for the contact.

email string: Email address of the contact.
name string: Name of the contact.
url string: URL for the contact.

email str: Email address of the contact.
name str: Name of the contact.
url str: URL for the contact.

email String: Email address of the contact.
name String: Name of the contact.
url String: URL for the contact.

ExternalDocumentationResponse

Url string: URL pointing to the documentation.
Description string: Description of the documentation.
Title string: Title of the documentation.

Url string: URL pointing to the documentation.
Description string: Description of the documentation.
Title string: Title of the documentation.

url String: URL pointing to the documentation.
description String: Description of the documentation.
title String: Title of the documentation.

url string: URL pointing to the documentation.
description string: Description of the documentation.
title string: Title of the documentation.

url str: URL pointing to the documentation.
description str: Description of the documentation.
title str: Title of the documentation.

url String: URL pointing to the documentation.
description String: Description of the documentation.
title String: Title of the documentation.

LicenseResponse

Identifier string: SPDX license information for the API. The identifier field is mutually exclusive of the URL field.
Name string: Name of the license.
Url string: URL pointing to the license details. The URL field is mutually exclusive of the identifier field.

Identifier string: SPDX license information for the API. The identifier field is mutually exclusive of the URL field.
Name string: Name of the license.
Url string: URL pointing to the license details. The URL field is mutually exclusive of the identifier field.

identifier String: SPDX license information for the API. The identifier field is mutually exclusive of the URL field.
name String: Name of the license.
url String: URL pointing to the license details. The URL field is mutually exclusive of the identifier field.

identifier string: SPDX license information for the API. The identifier field is mutually exclusive of the URL field.
name string: Name of the license.
url string: URL pointing to the license details. The URL field is mutually exclusive of the identifier field.

identifier str: SPDX license information for the API. The identifier field is mutually exclusive of the URL field.
name str: Name of the license.
url str: URL pointing to the license details. The URL field is mutually exclusive of the identifier field.

identifier String: SPDX license information for the API. The identifier field is mutually exclusive of the URL field.
name String: Name of the license.
url String: URL pointing to the license details. The URL field is mutually exclusive of the identifier field.

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.

TermsOfServiceResponse

Url string: URL pointing to the terms of service.

Url string: URL pointing to the terms of service.

url String: URL pointing to the terms of service.

url string: URL pointing to the terms of service.

url str: URL pointing to the terms of service.

url String: URL pointing to the terms of service.

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 v1 docs if using the v1 version of this package.

Azure Native v2.41.0 published on Tuesday, May 14, 2024 by Pulumi

pulumi/pulumi-azure-native

azure-native.apicenter.getApi

On this page

On this page

Using getApi

getApi Result

Supporting Types

ContactResponse

ExternalDocumentationResponse

LicenseResponse

SystemDataResponse

TermsOfServiceResponse

Package Details

On this page

On this page