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.89.1 published on Sunday, Mar 2, 2025 by Pulumi
azure-native.apimanagement.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.89.1 published on Sunday, Mar 2, 2025 by Pulumi
Gets the details of the API specified by its identifier. Azure REST API version: 2022-08-01.
Other available API versions: 2016-10-10, 2017-03-01, 2018-06-01-preview, 2020-12-01, 2022-09-01-preview, 2023-03-01-preview, 2023-05-01-preview, 2023-09-01-preview, 2024-05-01, 2024-06-01-preview.
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_id: Optional[str] = None,
            resource_group_name: Optional[str] = None,
            service_name: Optional[str] = None,
            opts: Optional[InvokeOptions] = None) -> GetApiResult
def get_api_output(api_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[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)
public static Output<GetApiResult> getApi(GetApiArgs args, InvokeOptions options)
fn::invoke:
  function: azure-native:apimanagement:getApi
  arguments:
    # arguments dictionaryThe following arguments are supported:
- ApiId string
- API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
- ResourceGroup stringName 
- The name of the resource group. The name is case insensitive.
- ServiceName string
- The name of the API Management service.
- ApiId string
- API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
- ResourceGroup stringName 
- The name of the resource group. The name is case insensitive.
- ServiceName string
- The name of the API Management service.
- apiId String
- API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
- resourceGroup StringName 
- The name of the resource group. The name is case insensitive.
- serviceName String
- The name of the API Management service.
- apiId string
- API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
- resourceGroup stringName 
- The name of the resource group. The name is case insensitive.
- serviceName string
- The name of the API Management service.
- api_id str
- API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
- resource_group_ strname 
- The name of the resource group. The name is case insensitive.
- service_name str
- The name of the API Management service.
- apiId String
- API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
- resourceGroup StringName 
- The name of the resource group. The name is case insensitive.
- serviceName String
- The name of the API Management service.
getApi Result
The following output properties are available:
- Id string
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- IsOnline bool
- Indicates if API revision is accessible via the gateway.
- Name string
- The name of the resource
- Path string
- Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- ApiRevision string
- Describes the revision of the API. If no value is provided, default revision 1 is created
- ApiRevision stringDescription 
- Description of the API Revision.
- ApiType string
- Type of API.
- ApiVersion string
- Indicates the version identifier of the API if the API is versioned
- ApiVersion stringDescription 
- Description of the API Version.
- ApiVersion Pulumi.Set Azure Native. Api Management. Outputs. Api Version Set Contract Details Response 
- Version set details
- ApiVersion stringSet Id 
- A resource identifier for the related ApiVersionSet.
- AuthenticationSettings Pulumi.Azure Native. Api Management. Outputs. Authentication Settings Contract Response 
- Collection of authentication settings included into this API.
- Contact
Pulumi.Azure Native. Api Management. Outputs. Api Contact Information Response 
- Contact information for the API.
- Description string
- Description of the API. May include HTML formatting tags.
- DisplayName string
- API name. Must be 1 to 300 characters long.
- IsCurrent bool
- Indicates if API revision is current api revision.
- License
Pulumi.Azure Native. Api Management. Outputs. Api License Information Response 
- License information for the API.
- Protocols List<string>
- Describes on which protocols the operations in this API can be invoked.
- ServiceUrl string
- Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long.
- SourceApi stringId 
- API identifier of the source API.
- SubscriptionKey Pulumi.Parameter Names Azure Native. Api Management. Outputs. Subscription Key Parameter Names Contract Response 
- Protocols over which API is made available.
- SubscriptionRequired bool
- Specifies whether an API or Product subscription is required for accessing the API.
- TermsOf stringService Url 
- A URL to the Terms of Service for the API. MUST be in the format of a URL.
- Id string
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- IsOnline bool
- Indicates if API revision is accessible via the gateway.
- Name string
- The name of the resource
- Path string
- Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- ApiRevision string
- Describes the revision of the API. If no value is provided, default revision 1 is created
- ApiRevision stringDescription 
- Description of the API Revision.
- ApiType string
- Type of API.
- ApiVersion string
- Indicates the version identifier of the API if the API is versioned
- ApiVersion stringDescription 
- Description of the API Version.
- ApiVersion ApiSet Version Set Contract Details Response 
- Version set details
- ApiVersion stringSet Id 
- A resource identifier for the related ApiVersionSet.
- AuthenticationSettings AuthenticationSettings Contract Response 
- Collection of authentication settings included into this API.
- Contact
ApiContact Information Response 
- Contact information for the API.
- Description string
- Description of the API. May include HTML formatting tags.
- DisplayName string
- API name. Must be 1 to 300 characters long.
- IsCurrent bool
- Indicates if API revision is current api revision.
- License
ApiLicense Information Response 
- License information for the API.
- Protocols []string
- Describes on which protocols the operations in this API can be invoked.
- ServiceUrl string
- Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long.
- SourceApi stringId 
- API identifier of the source API.
- SubscriptionKey SubscriptionParameter Names Key Parameter Names Contract Response 
- Protocols over which API is made available.
- SubscriptionRequired bool
- Specifies whether an API or Product subscription is required for accessing the API.
- TermsOf stringService Url 
- A URL to the Terms of Service for the API. MUST be in the format of a URL.
- id String
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- isOnline Boolean
- Indicates if API revision is accessible via the gateway.
- name String
- The name of the resource
- path String
- Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- apiRevision String
- Describes the revision of the API. If no value is provided, default revision 1 is created
- apiRevision StringDescription 
- Description of the API Revision.
- apiType String
- Type of API.
- apiVersion String
- Indicates the version identifier of the API if the API is versioned
- apiVersion StringDescription 
- Description of the API Version.
- apiVersion ApiSet Version Set Contract Details Response 
- Version set details
- apiVersion StringSet Id 
- A resource identifier for the related ApiVersionSet.
- authenticationSettings AuthenticationSettings Contract Response 
- Collection of authentication settings included into this API.
- contact
ApiContact Information Response 
- Contact information for the API.
- description String
- Description of the API. May include HTML formatting tags.
- displayName String
- API name. Must be 1 to 300 characters long.
- isCurrent Boolean
- Indicates if API revision is current api revision.
- license
ApiLicense Information Response 
- License information for the API.
- protocols List<String>
- Describes on which protocols the operations in this API can be invoked.
- serviceUrl String
- Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long.
- sourceApi StringId 
- API identifier of the source API.
- subscriptionKey SubscriptionParameter Names Key Parameter Names Contract Response 
- Protocols over which API is made available.
- subscriptionRequired Boolean
- Specifies whether an API or Product subscription is required for accessing the API.
- termsOf StringService Url 
- A URL to the Terms of Service for the API. MUST be in the format of a URL.
- id string
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- isOnline boolean
- Indicates if API revision is accessible via the gateway.
- name string
- The name of the resource
- path string
- Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.
- type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- apiRevision string
- Describes the revision of the API. If no value is provided, default revision 1 is created
- apiRevision stringDescription 
- Description of the API Revision.
- apiType string
- Type of API.
- apiVersion string
- Indicates the version identifier of the API if the API is versioned
- apiVersion stringDescription 
- Description of the API Version.
- apiVersion ApiSet Version Set Contract Details Response 
- Version set details
- apiVersion stringSet Id 
- A resource identifier for the related ApiVersionSet.
- authenticationSettings AuthenticationSettings Contract Response 
- Collection of authentication settings included into this API.
- contact
ApiContact Information Response 
- Contact information for the API.
- description string
- Description of the API. May include HTML formatting tags.
- displayName string
- API name. Must be 1 to 300 characters long.
- isCurrent boolean
- Indicates if API revision is current api revision.
- license
ApiLicense Information Response 
- License information for the API.
- protocols string[]
- Describes on which protocols the operations in this API can be invoked.
- serviceUrl string
- Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long.
- sourceApi stringId 
- API identifier of the source API.
- subscriptionKey SubscriptionParameter Names Key Parameter Names Contract Response 
- Protocols over which API is made available.
- subscriptionRequired boolean
- Specifies whether an API or Product subscription is required for accessing the API.
- termsOf stringService Url 
- A URL to the Terms of Service for the API. MUST be in the format of a URL.
- id str
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- is_online bool
- Indicates if API revision is accessible via the gateway.
- name str
- The name of the resource
- path str
- Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.
- type str
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- api_revision str
- Describes the revision of the API. If no value is provided, default revision 1 is created
- api_revision_ strdescription 
- Description of the API Revision.
- api_type str
- Type of API.
- api_version str
- Indicates the version identifier of the API if the API is versioned
- api_version_ strdescription 
- Description of the API Version.
- api_version_ Apiset Version Set Contract Details Response 
- Version set details
- api_version_ strset_ id 
- A resource identifier for the related ApiVersionSet.
- authentication_settings AuthenticationSettings Contract Response 
- Collection of authentication settings included into this API.
- contact
ApiContact Information Response 
- Contact information for the API.
- description str
- Description of the API. May include HTML formatting tags.
- display_name str
- API name. Must be 1 to 300 characters long.
- is_current bool
- Indicates if API revision is current api revision.
- license
ApiLicense Information Response 
- License information for the API.
- protocols Sequence[str]
- Describes on which protocols the operations in this API can be invoked.
- service_url str
- Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long.
- source_api_ strid 
- API identifier of the source API.
- subscription_key_ Subscriptionparameter_ names Key Parameter Names Contract Response 
- Protocols over which API is made available.
- subscription_required bool
- Specifies whether an API or Product subscription is required for accessing the API.
- terms_of_ strservice_ url 
- A URL to the Terms of Service for the API. MUST be in the format of a URL.
- id String
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- isOnline Boolean
- Indicates if API revision is accessible via the gateway.
- name String
- The name of the resource
- path String
- Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- apiRevision String
- Describes the revision of the API. If no value is provided, default revision 1 is created
- apiRevision StringDescription 
- Description of the API Revision.
- apiType String
- Type of API.
- apiVersion String
- Indicates the version identifier of the API if the API is versioned
- apiVersion StringDescription 
- Description of the API Version.
- apiVersion Property MapSet 
- Version set details
- apiVersion StringSet Id 
- A resource identifier for the related ApiVersionSet.
- authenticationSettings Property Map
- Collection of authentication settings included into this API.
- contact Property Map
- Contact information for the API.
- description String
- Description of the API. May include HTML formatting tags.
- displayName String
- API name. Must be 1 to 300 characters long.
- isCurrent Boolean
- Indicates if API revision is current api revision.
- license Property Map
- License information for the API.
- protocols List<String>
- Describes on which protocols the operations in this API can be invoked.
- serviceUrl String
- Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long.
- sourceApi StringId 
- API identifier of the source API.
- subscriptionKey Property MapParameter Names 
- Protocols over which API is made available.
- subscriptionRequired Boolean
- Specifies whether an API or Product subscription is required for accessing the API.
- termsOf StringService Url 
- A URL to the Terms of Service for the API. MUST be in the format of a URL.
Supporting Types
ApiContactInformationResponse   
ApiLicenseInformationResponse   
ApiVersionSetContractDetailsResponse     
- Description string
- Description of API Version Set.
- Id string
- Identifier for existing API Version Set. Omit this value to create a new Version Set.
- Name string
- The display Name of the API Version Set.
- VersionHeader stringName 
- Name of HTTP header parameter that indicates the API Version if versioningScheme is set to header.
- VersionQuery stringName 
- Name of query parameter that indicates the API Version if versioningScheme is set to query.
- VersioningScheme string
- An value that determines where the API Version identifier will be located in a HTTP request.
- Description string
- Description of API Version Set.
- Id string
- Identifier for existing API Version Set. Omit this value to create a new Version Set.
- Name string
- The display Name of the API Version Set.
- VersionHeader stringName 
- Name of HTTP header parameter that indicates the API Version if versioningScheme is set to header.
- VersionQuery stringName 
- Name of query parameter that indicates the API Version if versioningScheme is set to query.
- VersioningScheme string
- An value that determines where the API Version identifier will be located in a HTTP request.
- description String
- Description of API Version Set.
- id String
- Identifier for existing API Version Set. Omit this value to create a new Version Set.
- name String
- The display Name of the API Version Set.
- versionHeader StringName 
- Name of HTTP header parameter that indicates the API Version if versioningScheme is set to header.
- versionQuery StringName 
- Name of query parameter that indicates the API Version if versioningScheme is set to query.
- versioningScheme String
- An value that determines where the API Version identifier will be located in a HTTP request.
- description string
- Description of API Version Set.
- id string
- Identifier for existing API Version Set. Omit this value to create a new Version Set.
- name string
- The display Name of the API Version Set.
- versionHeader stringName 
- Name of HTTP header parameter that indicates the API Version if versioningScheme is set to header.
- versionQuery stringName 
- Name of query parameter that indicates the API Version if versioningScheme is set to query.
- versioningScheme string
- An value that determines where the API Version identifier will be located in a HTTP request.
- description str
- Description of API Version Set.
- id str
- Identifier for existing API Version Set. Omit this value to create a new Version Set.
- name str
- The display Name of the API Version Set.
- version_header_ strname 
- Name of HTTP header parameter that indicates the API Version if versioningScheme is set to header.
- version_query_ strname 
- Name of query parameter that indicates the API Version if versioningScheme is set to query.
- versioning_scheme str
- An value that determines where the API Version identifier will be located in a HTTP request.
- description String
- Description of API Version Set.
- id String
- Identifier for existing API Version Set. Omit this value to create a new Version Set.
- name String
- The display Name of the API Version Set.
- versionHeader StringName 
- Name of HTTP header parameter that indicates the API Version if versioningScheme is set to header.
- versionQuery StringName 
- Name of query parameter that indicates the API Version if versioningScheme is set to query.
- versioningScheme String
- An value that determines where the API Version identifier will be located in a HTTP request.
AuthenticationSettingsContractResponse   
- OAuth2
Pulumi.Azure Native. Api Management. Inputs. OAuth2Authentication Settings Contract Response 
- OAuth2 Authentication settings
- OAuth2AuthenticationSettings List<Pulumi.Azure Native. Api Management. Inputs. OAuth2Authentication Settings Contract Response> 
- Collection of OAuth2 authentication settings included into this API.
- Openid
Pulumi.Azure Native. Api Management. Inputs. Open Id Authentication Settings Contract Response 
- OpenID Connect Authentication Settings
- OpenidAuthentication List<Pulumi.Settings Azure Native. Api Management. Inputs. Open Id Authentication Settings Contract Response> 
- Collection of Open ID Connect authentication settings included into this API.
- OAuth2
OAuth2AuthenticationSettings Contract Response 
- OAuth2 Authentication settings
- OAuth2AuthenticationSettings []OAuth2AuthenticationSettings Contract Response 
- Collection of OAuth2 authentication settings included into this API.
- Openid
OpenId Authentication Settings Contract Response 
- OpenID Connect Authentication Settings
- OpenidAuthentication []OpenSettings Id Authentication Settings Contract Response 
- Collection of Open ID Connect authentication settings included into this API.
- oAuth2 OAuth2AuthenticationSettings Contract Response 
- OAuth2 Authentication settings
- oAuth2Authentication List<OAuth2AuthenticationSettings Settings Contract Response> 
- Collection of OAuth2 authentication settings included into this API.
- openid
OpenId Authentication Settings Contract Response 
- OpenID Connect Authentication Settings
- openidAuthentication List<OpenSettings Id Authentication Settings Contract Response> 
- Collection of Open ID Connect authentication settings included into this API.
- oAuth2 OAuth2AuthenticationSettings Contract Response 
- OAuth2 Authentication settings
- oAuth2Authentication OAuth2AuthenticationSettings Settings Contract Response[] 
- Collection of OAuth2 authentication settings included into this API.
- openid
OpenId Authentication Settings Contract Response 
- OpenID Connect Authentication Settings
- openidAuthentication OpenSettings Id Authentication Settings Contract Response[] 
- Collection of Open ID Connect authentication settings included into this API.
- o_auth2 OAuth2AuthenticationSettings Contract Response 
- OAuth2 Authentication settings
- o_auth2_ Sequence[OAuth2Authenticationauthentication_ settings Settings Contract Response] 
- Collection of OAuth2 authentication settings included into this API.
- openid
OpenId Authentication Settings Contract Response 
- OpenID Connect Authentication Settings
- openid_authentication_ Sequence[Opensettings Id Authentication Settings Contract Response] 
- Collection of Open ID Connect authentication settings included into this API.
- oAuth2 Property Map
- OAuth2 Authentication settings
- oAuth2Authentication List<Property Map>Settings 
- Collection of OAuth2 authentication settings included into this API.
- openid Property Map
- OpenID Connect Authentication Settings
- openidAuthentication List<Property Map>Settings 
- Collection of Open ID Connect authentication settings included into this API.
OAuth2AuthenticationSettingsContractResponse   
- string
- OAuth authorization server identifier.
- Scope string
- operations scope.
- string
- OAuth authorization server identifier.
- Scope string
- operations scope.
- String
- OAuth authorization server identifier.
- scope String
- operations scope.
- string
- OAuth authorization server identifier.
- scope string
- operations scope.
- str
- OAuth authorization server identifier.
- scope str
- operations scope.
- String
- OAuth authorization server identifier.
- scope String
- operations scope.
OpenIdAuthenticationSettingsContractResponse     
- BearerToken List<string>Sending Methods 
- How to send token to the server.
- OpenidProvider stringId 
- OAuth authorization server identifier.
- BearerToken []stringSending Methods 
- How to send token to the server.
- OpenidProvider stringId 
- OAuth authorization server identifier.
- bearerToken List<String>Sending Methods 
- How to send token to the server.
- openidProvider StringId 
- OAuth authorization server identifier.
- bearerToken string[]Sending Methods 
- How to send token to the server.
- openidProvider stringId 
- OAuth authorization server identifier.
- bearer_token_ Sequence[str]sending_ methods 
- How to send token to the server.
- openid_provider_ strid 
- OAuth authorization server identifier.
- bearerToken List<String>Sending Methods 
- How to send token to the server.
- openidProvider StringId 
- OAuth authorization server identifier.
SubscriptionKeyParameterNamesContractResponse     
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.89.1 published on Sunday, Mar 2, 2025 by Pulumi