Azure Native v2.73.0, Nov 20 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.73.0 published on Wednesday, Nov 20, 2024 by Pulumi

pulumi/pulumi-azure-native

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.73.0 published on Wednesday, Nov 20, 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_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)
// Output-based functions aren't available in Java yet

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

The 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.
ResourceGroupName string: 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.
ResourceGroupName string: 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.
resourceGroupName String: 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.
resourceGroupName string: 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_name str: 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.
resourceGroupName String: 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
ApiRevisionDescription string: Description of the API Revision.
ApiType string: Type of API.
ApiVersion string: Indicates the version identifier of the API if the API is versioned
ApiVersionDescription string: Description of the API Version.
ApiVersionSet Pulumi.AzureNative.ApiManagement.Outputs.ApiVersionSetContractDetailsResponse: Version set details
ApiVersionSetId string: A resource identifier for the related ApiVersionSet.
AuthenticationSettings Pulumi.AzureNative.ApiManagement.Outputs.AuthenticationSettingsContractResponse: Collection of authentication settings included into this API.
Contact Pulumi.AzureNative.ApiManagement.Outputs.ApiContactInformationResponse: 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.AzureNative.ApiManagement.Outputs.ApiLicenseInformationResponse: 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.
SourceApiId string: API identifier of the source API.
SubscriptionKeyParameterNames Pulumi.AzureNative.ApiManagement.Outputs.SubscriptionKeyParameterNamesContractResponse: Protocols over which API is made available.
SubscriptionRequired bool: Specifies whether an API or Product subscription is required for accessing the API.
TermsOfServiceUrl string: 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
ApiRevisionDescription string: Description of the API Revision.
ApiType string: Type of API.
ApiVersion string: Indicates the version identifier of the API if the API is versioned
ApiVersionDescription string: Description of the API Version.
ApiVersionSet ApiVersionSetContractDetailsResponse: Version set details
ApiVersionSetId string: A resource identifier for the related ApiVersionSet.
AuthenticationSettings AuthenticationSettingsContractResponse: Collection of authentication settings included into this API.
Contact ApiContactInformationResponse: 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 ApiLicenseInformationResponse: 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.
SourceApiId string: API identifier of the source API.
SubscriptionKeyParameterNames SubscriptionKeyParameterNamesContractResponse: Protocols over which API is made available.
SubscriptionRequired bool: Specifies whether an API or Product subscription is required for accessing the API.
TermsOfServiceUrl string: 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
apiRevisionDescription String: Description of the API Revision.
apiType String: Type of API.
apiVersion String: Indicates the version identifier of the API if the API is versioned
apiVersionDescription String: Description of the API Version.
apiVersionSet ApiVersionSetContractDetailsResponse: Version set details
apiVersionSetId String: A resource identifier for the related ApiVersionSet.
authenticationSettings AuthenticationSettingsContractResponse: Collection of authentication settings included into this API.
contact ApiContactInformationResponse: 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 ApiLicenseInformationResponse: 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.
sourceApiId String: API identifier of the source API.
subscriptionKeyParameterNames SubscriptionKeyParameterNamesContractResponse: Protocols over which API is made available.
subscriptionRequired Boolean: Specifies whether an API or Product subscription is required for accessing the API.
termsOfServiceUrl String: 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
apiRevisionDescription string: Description of the API Revision.
apiType string: Type of API.
apiVersion string: Indicates the version identifier of the API if the API is versioned
apiVersionDescription string: Description of the API Version.
apiVersionSet ApiVersionSetContractDetailsResponse: Version set details
apiVersionSetId string: A resource identifier for the related ApiVersionSet.
authenticationSettings AuthenticationSettingsContractResponse: Collection of authentication settings included into this API.
contact ApiContactInformationResponse: 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 ApiLicenseInformationResponse: 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.
sourceApiId string: API identifier of the source API.
subscriptionKeyParameterNames SubscriptionKeyParameterNamesContractResponse: Protocols over which API is made available.
subscriptionRequired boolean: Specifies whether an API or Product subscription is required for accessing the API.
termsOfServiceUrl string: 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_description str: 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_description str: Description of the API Version.
api_version_set ApiVersionSetContractDetailsResponse: Version set details
api_version_set_id str: A resource identifier for the related ApiVersionSet.
authentication_settings AuthenticationSettingsContractResponse: Collection of authentication settings included into this API.
contact ApiContactInformationResponse: 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 ApiLicenseInformationResponse: 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_id str: API identifier of the source API.
subscription_key_parameter_names SubscriptionKeyParameterNamesContractResponse: 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_service_url str: 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
apiRevisionDescription String: Description of the API Revision.
apiType String: Type of API.
apiVersion String: Indicates the version identifier of the API if the API is versioned
apiVersionDescription String: Description of the API Version.
apiVersionSet Property Map: Version set details
apiVersionSetId String: 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.
sourceApiId String: API identifier of the source API.
subscriptionKeyParameterNames Property Map: Protocols over which API is made available.
subscriptionRequired Boolean: Specifies whether an API or Product subscription is required for accessing the API.
termsOfServiceUrl String: A URL to the Terms of Service for the API. MUST be in the format of a URL.

Supporting Types

ApiContactInformationResponse

Email string: The email address of the contact person/organization. MUST be in the format of an email address
Name string: The identifying name of the contact person/organization
Url string: The URL pointing to the contact information. MUST be in the format of a URL

Email string: The email address of the contact person/organization. MUST be in the format of an email address
Name string: The identifying name of the contact person/organization
Url string: The URL pointing to the contact information. MUST be in the format of a URL

email String: The email address of the contact person/organization. MUST be in the format of an email address
name String: The identifying name of the contact person/organization
url String: The URL pointing to the contact information. MUST be in the format of a URL

email string: The email address of the contact person/organization. MUST be in the format of an email address
name string: The identifying name of the contact person/organization
url string: The URL pointing to the contact information. MUST be in the format of a URL

email str: The email address of the contact person/organization. MUST be in the format of an email address
name str: The identifying name of the contact person/organization
url str: The URL pointing to the contact information. MUST be in the format of a URL

email String: The email address of the contact person/organization. MUST be in the format of an email address
name String: The identifying name of the contact person/organization
url String: The URL pointing to the contact information. MUST be in the format of a URL

ApiLicenseInformationResponse

Name string: The license name used for the API
Url string: A URL to the license used for the API. MUST be in the format of a URL

Name string: The license name used for the API
Url string: A URL to the license used for the API. MUST be in the format of a URL

name String: The license name used for the API
url String: A URL to the license used for the API. MUST be in the format of a URL

name string: The license name used for the API
url string: A URL to the license used for the API. MUST be in the format of a URL

name str: The license name used for the API
url str: A URL to the license used for the API. MUST be in the format of a URL

name String: The license name used for the API
url String: A URL to the license used for the API. MUST be in the format of a URL

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.
VersionHeaderName string: Name of HTTP header parameter that indicates the API Version if versioningScheme is set to header.
VersionQueryName string: 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.
VersionHeaderName string: Name of HTTP header parameter that indicates the API Version if versioningScheme is set to header.
VersionQueryName string: 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.
versionHeaderName String: Name of HTTP header parameter that indicates the API Version if versioningScheme is set to header.
versionQueryName String: 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.
versionHeaderName string: Name of HTTP header parameter that indicates the API Version if versioningScheme is set to header.
versionQueryName string: 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_name str: Name of HTTP header parameter that indicates the API Version if versioningScheme is set to header.
version_query_name str: 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.
versionHeaderName String: Name of HTTP header parameter that indicates the API Version if versioningScheme is set to header.
versionQueryName String: 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.AzureNative.ApiManagement.Inputs.OAuth2AuthenticationSettingsContractResponse: OAuth2 Authentication settings
OAuth2AuthenticationSettings List<Pulumi.AzureNative.ApiManagement.Inputs.OAuth2AuthenticationSettingsContractResponse>: Collection of OAuth2 authentication settings included into this API.
Openid Pulumi.AzureNative.ApiManagement.Inputs.OpenIdAuthenticationSettingsContractResponse: OpenID Connect Authentication Settings
OpenidAuthenticationSettings List<Pulumi.AzureNative.ApiManagement.Inputs.OpenIdAuthenticationSettingsContractResponse>: Collection of Open ID Connect authentication settings included into this API.

OAuth2 OAuth2AuthenticationSettingsContractResponse: OAuth2 Authentication settings
OAuth2AuthenticationSettings []OAuth2AuthenticationSettingsContractResponse: Collection of OAuth2 authentication settings included into this API.
Openid OpenIdAuthenticationSettingsContractResponse: OpenID Connect Authentication Settings
OpenidAuthenticationSettings []OpenIdAuthenticationSettingsContractResponse: Collection of Open ID Connect authentication settings included into this API.

oAuth2 OAuth2AuthenticationSettingsContractResponse: OAuth2 Authentication settings
oAuth2AuthenticationSettings List<OAuth2AuthenticationSettingsContractResponse>: Collection of OAuth2 authentication settings included into this API.
openid OpenIdAuthenticationSettingsContractResponse: OpenID Connect Authentication Settings
openidAuthenticationSettings List<OpenIdAuthenticationSettingsContractResponse>: Collection of Open ID Connect authentication settings included into this API.

oAuth2 OAuth2AuthenticationSettingsContractResponse: OAuth2 Authentication settings
oAuth2AuthenticationSettings OAuth2AuthenticationSettingsContractResponse[]: Collection of OAuth2 authentication settings included into this API.
openid OpenIdAuthenticationSettingsContractResponse: OpenID Connect Authentication Settings
openidAuthenticationSettings OpenIdAuthenticationSettingsContractResponse[]: Collection of Open ID Connect authentication settings included into this API.

o_auth2 OAuth2AuthenticationSettingsContractResponse: OAuth2 Authentication settings
o_auth2_authentication_settings Sequence[OAuth2AuthenticationSettingsContractResponse]: Collection of OAuth2 authentication settings included into this API.
openid OpenIdAuthenticationSettingsContractResponse: OpenID Connect Authentication Settings
openid_authentication_settings Sequence[OpenIdAuthenticationSettingsContractResponse]: Collection of Open ID Connect authentication settings included into this API.

oAuth2 Property Map: OAuth2 Authentication settings
oAuth2AuthenticationSettings List<Property Map>: Collection of OAuth2 authentication settings included into this API.
openid Property Map: OpenID Connect Authentication Settings
openidAuthenticationSettings List<Property Map>: Collection of Open ID Connect authentication settings included into this API.

OAuth2AuthenticationSettingsContractResponse

AuthorizationServerId string: OAuth authorization server identifier.
Scope string: operations scope.

AuthorizationServerId string: OAuth authorization server identifier.
Scope string: operations scope.

authorizationServerId String: OAuth authorization server identifier.
scope String: operations scope.

authorizationServerId string: OAuth authorization server identifier.
scope string: operations scope.

authorization_server_id str: OAuth authorization server identifier.
scope str: operations scope.

authorizationServerId String: OAuth authorization server identifier.
scope String: operations scope.

OpenIdAuthenticationSettingsContractResponse

BearerTokenSendingMethods List<string>: How to send token to the server.
OpenidProviderId string: OAuth authorization server identifier.

BearerTokenSendingMethods []string: How to send token to the server.
OpenidProviderId string: OAuth authorization server identifier.

bearerTokenSendingMethods List<String>: How to send token to the server.
openidProviderId String: OAuth authorization server identifier.

bearerTokenSendingMethods string[]: How to send token to the server.
openidProviderId string: OAuth authorization server identifier.

bearer_token_sending_methods Sequence[str]: How to send token to the server.
openid_provider_id str: OAuth authorization server identifier.

bearerTokenSendingMethods List<String>: How to send token to the server.
openidProviderId String: OAuth authorization server identifier.

SubscriptionKeyParameterNamesContractResponse

Header string: Subscription key header name.
Query string: Subscription key query string parameter name.

Header string: Subscription key header name.
Query string: Subscription key query string parameter name.

header String: Subscription key header name.
query String: Subscription key query string parameter name.

header string: Subscription key header name.
query string: Subscription key query string parameter name.

header str: Subscription key header name.
query str: Subscription key query string parameter name.

header String: Subscription key header name.
query String: Subscription key query string parameter name.

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.73.0 published on Wednesday, Nov 20, 2024 by Pulumi

pulumi/pulumi-azure-native

azure-native.apimanagement.getApi

On this page

On this page

Using getApi

getApi Result

Supporting Types

ApiContactInformationResponse

ApiLicenseInformationResponse

ApiVersionSetContractDetailsResponse

AuthenticationSettingsContractResponse

OAuth2AuthenticationSettingsContractResponse

OpenIdAuthenticationSettingsContractResponse

SubscriptionKeyParameterNamesContractResponse

Package Details

On this page

On this page