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.65.0 published on Monday, Oct 7, 2024 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.65.0 published on Monday, Oct 7, 2024 by Pulumi
Gets the details of the API specified by its identifier. Azure REST API version: 2022-08-01.
Other available API versions: 2016-07-07, 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.
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:
- Api
Id 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.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Service
Name string - The name of the API Management service.
- Api
Id 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.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Service
Name string - The name of the API Management service.
- api
Id 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.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- service
Name String - The name of the API Management service.
- api
Id 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.
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- service
Name 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.
- api
Id 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.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- service
Name 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}
- Is
Online 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"
- Api
Revision string - Describes the revision of the API. If no value is provided, default revision 1 is created
- Api
Revision stringDescription - Description of the API Revision.
- Api
Type string - Type of API.
- Api
Version string - Indicates the version identifier of the API if the API is versioned
- Api
Version stringDescription - Description of the API Version.
- Api
Version Pulumi.Set Azure Native. Api Management. Outputs. Api Version Set Contract Details Response - Version set details
- Api
Version stringSet Id - A resource identifier for the related ApiVersionSet.
- Authentication
Settings 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.
- Display
Name string - API name. Must be 1 to 300 characters long.
- Is
Current 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.
- Service
Url string - Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long.
- Source
Api stringId - API identifier of the source API.
- Subscription
Key Pulumi.Parameter Names Azure Native. Api Management. Outputs. Subscription 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 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}
- Is
Online 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"
- Api
Revision string - Describes the revision of the API. If no value is provided, default revision 1 is created
- Api
Revision stringDescription - Description of the API Revision.
- Api
Type string - Type of API.
- Api
Version string - Indicates the version identifier of the API if the API is versioned
- Api
Version stringDescription - Description of the API Version.
- Api
Version ApiSet Version Set Contract Details Response - Version set details
- Api
Version stringSet Id - A resource identifier for the related ApiVersionSet.
- Authentication
Settings AuthenticationSettings Contract Response - Collection of authentication settings included into this API.
- Contact
Api
Contact Information Response - Contact information for the API.
- Description string
- Description of the API. May include HTML formatting tags.
- Display
Name string - API name. Must be 1 to 300 characters long.
- Is
Current bool - Indicates if API revision is current api revision.
- License
Api
License Information Response - License information for the API.
- Protocols []string
- Describes on which protocols the operations in this API can be invoked.
- Service
Url string - Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long.
- Source
Api stringId - 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 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}
- is
Online 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"
- api
Revision String - Describes the revision of the API. If no value is provided, default revision 1 is created
- api
Revision StringDescription - Description of the API Revision.
- api
Type String - Type of API.
- api
Version String - Indicates the version identifier of the API if the API is versioned
- api
Version StringDescription - Description of the API Version.
- api
Version ApiSet Version Set Contract Details Response - Version set details
- api
Version StringSet Id - A resource identifier for the related ApiVersionSet.
- authentication
Settings AuthenticationSettings Contract Response - Collection of authentication settings included into this API.
- contact
Api
Contact Information Response - Contact information for the API.
- description String
- Description of the API. May include HTML formatting tags.
- display
Name String - API name. Must be 1 to 300 characters long.
- is
Current Boolean - Indicates if API revision is current api revision.
- license
Api
License Information Response - License information for the API.
- protocols List<String>
- Describes on which protocols the operations in this API can be invoked.
- service
Url String - Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long.
- source
Api StringId - API identifier of the source API.
- subscription
Key SubscriptionParameter Names Key Parameter Names Contract Response - Protocols over which API is made available.
- subscription
Required Boolean - Specifies whether an API or Product subscription is required for accessing the API.
- terms
Of 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}
- is
Online 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"
- api
Revision string - Describes the revision of the API. If no value is provided, default revision 1 is created
- api
Revision stringDescription - Description of the API Revision.
- api
Type string - Type of API.
- api
Version string - Indicates the version identifier of the API if the API is versioned
- api
Version stringDescription - Description of the API Version.
- api
Version ApiSet Version Set Contract Details Response - Version set details
- api
Version stringSet Id - A resource identifier for the related ApiVersionSet.
- authentication
Settings AuthenticationSettings Contract Response - Collection of authentication settings included into this API.
- contact
Api
Contact Information Response - Contact information for the API.
- description string
- Description of the API. May include HTML formatting tags.
- display
Name string - API name. Must be 1 to 300 characters long.
- is
Current boolean - Indicates if API revision is current api revision.
- license
Api
License Information Response - License information for the API.
- protocols string[]
- Describes on which protocols the operations in this API can be invoked.
- service
Url string - Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long.
- source
Api stringId - API identifier of the source API.
- subscription
Key SubscriptionParameter Names Key Parameter Names Contract Response - Protocols over which API is made available.
- subscription
Required boolean - Specifies whether an API or Product subscription is required for accessing the API.
- terms
Of 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
Api
Contact 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
Api
License 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}
- is
Online 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"
- api
Revision String - Describes the revision of the API. If no value is provided, default revision 1 is created
- api
Revision StringDescription - Description of the API Revision.
- api
Type String - Type of API.
- api
Version String - Indicates the version identifier of the API if the API is versioned
- api
Version StringDescription - Description of the API Version.
- api
Version Property MapSet - Version set details
- api
Version StringSet Id - A resource identifier for the related ApiVersionSet.
- authentication
Settings 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.
- display
Name String - API name. Must be 1 to 300 characters long.
- is
Current 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.
- service
Url String - Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long.
- source
Api StringId - API identifier of the source API.
- subscription
Key Property MapParameter Names - Protocols over which API is made available.
- subscription
Required Boolean - Specifies whether an API or Product subscription is required for accessing the API.
- terms
Of 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.
- Version
Header stringName - Name of HTTP header parameter that indicates the API Version if versioningScheme is set to
header
. - Version
Query stringName - Name of query parameter that indicates the API Version if versioningScheme is set to
query
. - Versioning
Scheme 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.
- Version
Header stringName - Name of HTTP header parameter that indicates the API Version if versioningScheme is set to
header
. - Version
Query stringName - Name of query parameter that indicates the API Version if versioningScheme is set to
query
. - Versioning
Scheme 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.
- version
Header StringName - Name of HTTP header parameter that indicates the API Version if versioningScheme is set to
header
. - version
Query StringName - Name of query parameter that indicates the API Version if versioningScheme is set to
query
. - versioning
Scheme 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.
- version
Header stringName - Name of HTTP header parameter that indicates the API Version if versioningScheme is set to
header
. - version
Query stringName - Name of query parameter that indicates the API Version if versioningScheme is set to
query
. - versioning
Scheme 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.
- version
Header StringName - Name of HTTP header parameter that indicates the API Version if versioningScheme is set to
header
. - version
Query StringName - Name of query parameter that indicates the API Version if versioningScheme is set to
query
. - versioning
Scheme 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
- OAuth2Authentication
Settings 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
- Openid
Authentication 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
OAuth2Authentication
Settings Contract Response - OAuth2 Authentication settings
- OAuth2Authentication
Settings []OAuth2AuthenticationSettings Contract Response - Collection of OAuth2 authentication settings included into this API.
- Openid
Open
Id Authentication Settings Contract Response - OpenID Connect Authentication Settings
- Openid
Authentication []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
Auth2Authentication List<OAuth2AuthenticationSettings Settings Contract Response> - Collection of OAuth2 authentication settings included into this API.
- openid
Open
Id Authentication Settings Contract Response - OpenID Connect Authentication Settings
- openid
Authentication List<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
Auth2Authentication OAuth2AuthenticationSettings Settings Contract Response[] - Collection of OAuth2 authentication settings included into this API.
- openid
Open
Id Authentication Settings Contract Response - OpenID Connect Authentication Settings
- openid
Authentication 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
Open
Id 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.
- o
Auth2 Property Map - OAuth2 Authentication settings
- o
Auth2Authentication List<Property Map>Settings - Collection of OAuth2 authentication settings included into this API.
- openid Property Map
- OpenID Connect Authentication Settings
- openid
Authentication 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
- Bearer
Token List<string>Sending Methods - How to send token to the server.
- Openid
Provider stringId - OAuth authorization server identifier.
- Bearer
Token []stringSending Methods - How to send token to the server.
- Openid
Provider stringId - OAuth authorization server identifier.
- bearer
Token List<String>Sending Methods - How to send token to the server.
- openid
Provider StringId - OAuth authorization server identifier.
- bearer
Token string[]Sending Methods - How to send token to the server.
- openid
Provider 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.
- bearer
Token List<String>Sending Methods - How to send token to the server.
- openid
Provider 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.65.0 published on Monday, Oct 7, 2024 by Pulumi