Azure Native

Pulumi Official
Package maintained by Pulumi
v1.64.1 published on Wednesday, May 18, 2022 by Pulumi

getApi

Api details. API Version: 2020-12-01.

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.

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.

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.

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.

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.

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.

serviceName String

The name of the API Management service.

getApi Result

The following output properties are available:

Id string

Resource ID.

IsOnline bool

Indicates if API revision is accessible via the gateway.

Name string

Resource name.

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

Resource type for API Management resource.

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.

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.

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.

Id string

Resource ID.

IsOnline bool

Indicates if API revision is accessible via the gateway.

Name string

Resource name.

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

Resource type for API Management resource.

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.

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.

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.

id String

Resource ID.

isOnline Boolean

Indicates if API revision is accessible via the gateway.

name String

Resource name.

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

Resource type for API Management resource.

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.

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.

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.

id string

Resource ID.

isOnline boolean

Indicates if API revision is accessible via the gateway.

name string

Resource name.

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

Resource type for API Management resource.

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.

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.

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.

id str

Resource ID.

is_online bool

Indicates if API revision is accessible via the gateway.

name str

Resource name.

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

Resource type for API Management resource.

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.

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.

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.

id String

Resource ID.

isOnline Boolean

Indicates if API revision is accessible via the gateway.

name String

Resource name.

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

Resource type for API Management resource.

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.

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.

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.

Supporting Types

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 OAuth2AuthenticationSettingsContractResponse

OAuth2 Authentication settings

Openid OpenIdAuthenticationSettingsContractResponse

OpenID Connect Authentication Settings

oAuth2 OAuth2AuthenticationSettingsContractResponse

OAuth2 Authentication settings

openid OpenIdAuthenticationSettingsContractResponse

OpenID Connect Authentication Settings

oAuth2 OAuth2AuthenticationSettingsContractResponse

OAuth2 Authentication settings

openid OpenIdAuthenticationSettingsContractResponse

OpenID Connect Authentication Settings

o_auth2 OAuth2AuthenticationSettingsContractResponse

OAuth2 Authentication settings

openid OpenIdAuthenticationSettingsContractResponse

OpenID Connect Authentication Settings

oAuth2 Property Map

OAuth2 Authentication settings

openid Property Map

OpenID Connect Authentication Settings

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
https://github.com/pulumi/pulumi-azure-native
License
Apache-2.0