azure-native.web.getCustomApi
Explore with Pulumi AI
Gets a custom API by name for a specific subscription and resource group Azure REST API version: 2016-06-01.
Using getCustomApi
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 getCustomApi(args: GetCustomApiArgs, opts?: InvokeOptions): Promise<GetCustomApiResult>
function getCustomApiOutput(args: GetCustomApiOutputArgs, opts?: InvokeOptions): Output<GetCustomApiResult>
def get_custom_api(api_name: Optional[str] = None,
resource_group_name: Optional[str] = None,
subscription_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetCustomApiResult
def get_custom_api_output(api_name: Optional[pulumi.Input[str]] = None,
resource_group_name: Optional[pulumi.Input[str]] = None,
subscription_id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetCustomApiResult]
func LookupCustomApi(ctx *Context, args *LookupCustomApiArgs, opts ...InvokeOption) (*LookupCustomApiResult, error)
func LookupCustomApiOutput(ctx *Context, args *LookupCustomApiOutputArgs, opts ...InvokeOption) LookupCustomApiResultOutput
> Note: This function is named LookupCustomApi
in the Go SDK.
public static class GetCustomApi
{
public static Task<GetCustomApiResult> InvokeAsync(GetCustomApiArgs args, InvokeOptions? opts = null)
public static Output<GetCustomApiResult> Invoke(GetCustomApiInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetCustomApiResult> getCustomApi(GetCustomApiArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: azure-native:web:getCustomApi
arguments:
# arguments dictionary
The following arguments are supported:
- Api
Name string API name
- Resource
Group stringName The resource group
- Subscription
Id string Subscription Id
- Api
Name string API name
- Resource
Group stringName The resource group
- Subscription
Id string Subscription Id
- api
Name String API name
- resource
Group StringName The resource group
- subscription
Id String Subscription Id
- api
Name string API name
- resource
Group stringName The resource group
- subscription
Id string Subscription Id
- api_
name str API name
- resource_
group_ strname The resource group
- subscription_
id str Subscription Id
- api
Name String API name
- resource
Group StringName The resource group
- subscription
Id String Subscription Id
getCustomApi Result
The following output properties are available:
- Id string
Resource id
- Name string
Resource name
- Properties
Pulumi.
Azure Native. Web. Outputs. Custom Api Properties Definition Response Custom API properties
- Type string
Resource type
- Etag string
Resource ETag
- Location string
Resource location
- Dictionary<string, string>
Resource tags
- Id string
Resource id
- Name string
Resource name
- Properties
Custom
Api Properties Definition Response Custom API properties
- Type string
Resource type
- Etag string
Resource ETag
- Location string
Resource location
- map[string]string
Resource tags
- id String
Resource id
- name String
Resource name
- properties
Custom
Api Properties Definition Response Custom API properties
- type String
Resource type
- etag String
Resource ETag
- location String
Resource location
- Map<String,String>
Resource tags
- id string
Resource id
- name string
Resource name
- properties
Custom
Api Properties Definition Response Custom API properties
- type string
Resource type
- etag string
Resource ETag
- location string
Resource location
- {[key: string]: string}
Resource tags
- id str
Resource id
- name str
Resource name
- properties
Custom
Api Properties Definition Response Custom API properties
- type str
Resource type
- etag str
Resource ETag
- location str
Resource location
- Mapping[str, str]
Resource tags
- id String
Resource id
- name String
Resource name
- properties Property Map
Custom API properties
- type String
Resource type
- etag String
Resource ETag
- location String
Resource location
- Map<String>
Resource tags
Supporting Types
ApiOAuthSettingsParameterResponse
- Options object
Options available to this parameter
- Ui
Definition object UI definitions per culture as caller can specify the culture
- Value string
Value of the setting
- Options interface{}
Options available to this parameter
- Ui
Definition interface{} UI definitions per culture as caller can specify the culture
- Value string
Value of the setting
- options Object
Options available to this parameter
- ui
Definition Object UI definitions per culture as caller can specify the culture
- value String
Value of the setting
- options any
Options available to this parameter
- ui
Definition any UI definitions per culture as caller can specify the culture
- value string
Value of the setting
- options Any
Options available to this parameter
- ui_
definition Any UI definitions per culture as caller can specify the culture
- value str
Value of the setting
- options Any
Options available to this parameter
- ui
Definition Any UI definitions per culture as caller can specify the culture
- value String
Value of the setting
ApiOAuthSettingsResponse
- Client
Id string Resource provider client id
- Client
Secret string Client Secret needed for OAuth
- Custom
Parameters Dictionary<string, Pulumi.Azure Native. Web. Inputs. Api OAuth Settings Parameter Response> OAuth parameters key is the name of parameter
- Identity
Provider string Identity provider
- Properties object
Read only properties for this oauth setting.
- Redirect
Url string Url
- Scopes List<string>
OAuth scopes
- Client
Id string Resource provider client id
- Client
Secret string Client Secret needed for OAuth
- Custom
Parameters map[string]ApiOAuth Settings Parameter Response OAuth parameters key is the name of parameter
- Identity
Provider string Identity provider
- Properties interface{}
Read only properties for this oauth setting.
- Redirect
Url string Url
- Scopes []string
OAuth scopes
- client
Id String Resource provider client id
- client
Secret String Client Secret needed for OAuth
- custom
Parameters Map<String,ApiOAuth Settings Parameter Response> OAuth parameters key is the name of parameter
- identity
Provider String Identity provider
- properties Object
Read only properties for this oauth setting.
- redirect
Url String Url
- scopes List<String>
OAuth scopes
- client
Id string Resource provider client id
- client
Secret string Client Secret needed for OAuth
- custom
Parameters {[key: string]: ApiOAuth Settings Parameter Response} OAuth parameters key is the name of parameter
- identity
Provider string Identity provider
- properties any
Read only properties for this oauth setting.
- redirect
Url string Url
- scopes string[]
OAuth scopes
- client_
id str Resource provider client id
- client_
secret str Client Secret needed for OAuth
- custom_
parameters Mapping[str, ApiOAuth Settings Parameter Response] OAuth parameters key is the name of parameter
- identity_
provider str Identity provider
- properties Any
Read only properties for this oauth setting.
- redirect_
url str Url
- scopes Sequence[str]
OAuth scopes
- client
Id String Resource provider client id
- client
Secret String Client Secret needed for OAuth
- custom
Parameters Map<Property Map> OAuth parameters key is the name of parameter
- identity
Provider String Identity provider
- properties Any
Read only properties for this oauth setting.
- redirect
Url String Url
- scopes List<String>
OAuth scopes
ApiResourceBackendServiceResponse
- Service
Url string The service URL
- Service
Url string The service URL
- service
Url String The service URL
- service
Url string The service URL
- service_
url str The service URL
- service
Url String The service URL
ApiResourceDefinitionsResponse
- Modified
Swagger stringUrl The modified swagger URL
- Original
Swagger stringUrl The original swagger URL
- Modified
Swagger stringUrl The modified swagger URL
- Original
Swagger stringUrl The original swagger URL
- modified
Swagger StringUrl The modified swagger URL
- original
Swagger StringUrl The original swagger URL
- modified
Swagger stringUrl The modified swagger URL
- original
Swagger stringUrl The original swagger URL
- modified_
swagger_ strurl The modified swagger URL
- original_
swagger_ strurl The original swagger URL
- modified
Swagger StringUrl The modified swagger URL
- original
Swagger StringUrl The original swagger URL
ConnectionParameterResponse
- OAuth
Settings Pulumi.Azure Native. Web. Inputs. Api OAuth Settings Response OAuth settings for the connection provider
- Type string
Type of the parameter
- OAuth
Settings ApiOAuth Settings Response OAuth settings for the connection provider
- Type string
Type of the parameter
- o
Auth ApiSettings OAuth Settings Response OAuth settings for the connection provider
- type String
Type of the parameter
- o
Auth ApiSettings OAuth Settings Response OAuth settings for the connection provider
- type string
Type of the parameter
- o_
auth_ Apisettings OAuth Settings Response OAuth settings for the connection provider
- type str
Type of the parameter
- o
Auth Property MapSettings OAuth settings for the connection provider
- type String
Type of the parameter
CustomApiPropertiesDefinitionResponse
- Api
Definitions Pulumi.Azure Native. Web. Inputs. Api Resource Definitions Response API Definitions
- Api
Type string The API type
- Backend
Service Pulumi.Azure Native. Web. Inputs. Api Resource Backend Service Response The API backend service
- Brand
Color string Brand color
- Capabilities List<string>
The custom API capabilities
- Connection
Parameters Dictionary<string, Pulumi.Azure Native. Web. Inputs. Connection Parameter Response> Connection parameters
- Description string
The custom API description
- Display
Name string The display name
- Icon
Uri string The icon URI
- Runtime
Urls List<string> Runtime URLs
- Swagger object
The JSON representation of the swagger
- Wsdl
Definition Pulumi.Azure Native. Web. Inputs. Wsdl Definition Response The WSDL definition
- Api
Definitions ApiResource Definitions Response API Definitions
- Api
Type string The API type
- Backend
Service ApiResource Backend Service Response The API backend service
- Brand
Color string Brand color
- Capabilities []string
The custom API capabilities
- Connection
Parameters map[string]ConnectionParameter Response Connection parameters
- Description string
The custom API description
- Display
Name string The display name
- Icon
Uri string The icon URI
- Runtime
Urls []string Runtime URLs
- Swagger interface{}
The JSON representation of the swagger
- Wsdl
Definition WsdlDefinition Response The WSDL definition
- api
Definitions ApiResource Definitions Response API Definitions
- api
Type String The API type
- backend
Service ApiResource Backend Service Response The API backend service
- brand
Color String Brand color
- capabilities List<String>
The custom API capabilities
- connection
Parameters Map<String,ConnectionParameter Response> Connection parameters
- description String
The custom API description
- display
Name String The display name
- icon
Uri String The icon URI
- runtime
Urls List<String> Runtime URLs
- swagger Object
The JSON representation of the swagger
- wsdl
Definition WsdlDefinition Response The WSDL definition
- api
Definitions ApiResource Definitions Response API Definitions
- api
Type string The API type
- backend
Service ApiResource Backend Service Response The API backend service
- brand
Color string Brand color
- capabilities string[]
The custom API capabilities
- connection
Parameters {[key: string]: ConnectionParameter Response} Connection parameters
- description string
The custom API description
- display
Name string The display name
- icon
Uri string The icon URI
- runtime
Urls string[] Runtime URLs
- swagger any
The JSON representation of the swagger
- wsdl
Definition WsdlDefinition Response The WSDL definition
- api_
definitions ApiResource Definitions Response API Definitions
- api_
type str The API type
- backend_
service ApiResource Backend Service Response The API backend service
- brand_
color str Brand color
- capabilities Sequence[str]
The custom API capabilities
- connection_
parameters Mapping[str, ConnectionParameter Response] Connection parameters
- description str
The custom API description
- display_
name str The display name
- icon_
uri str The icon URI
- runtime_
urls Sequence[str] Runtime URLs
- swagger Any
The JSON representation of the swagger
- wsdl_
definition WsdlDefinition Response The WSDL definition
- api
Definitions Property Map API Definitions
- api
Type String The API type
- backend
Service Property Map The API backend service
- brand
Color String Brand color
- capabilities List<String>
The custom API capabilities
- connection
Parameters Map<Property Map> Connection parameters
- description String
The custom API description
- display
Name String The display name
- icon
Uri String The icon URI
- runtime
Urls List<String> Runtime URLs
- swagger Any
The JSON representation of the swagger
- wsdl
Definition Property Map The WSDL definition
WsdlDefinitionResponse
- Content string
The WSDL content
- Import
Method string The WSDL import method
- Service
Pulumi.
Azure Native. Web. Inputs. Wsdl Service Response The service with name and endpoint names
- Url string
The WSDL URL
- Content string
The WSDL content
- Import
Method string The WSDL import method
- Service
Wsdl
Service Response The service with name and endpoint names
- Url string
The WSDL URL
- content String
The WSDL content
- import
Method String The WSDL import method
- service
Wsdl
Service Response The service with name and endpoint names
- url String
The WSDL URL
- content string
The WSDL content
- import
Method string The WSDL import method
- service
Wsdl
Service Response The service with name and endpoint names
- url string
The WSDL URL
- content str
The WSDL content
- import_
method str The WSDL import method
- service
Wsdl
Service Response The service with name and endpoint names
- url str
The WSDL URL
- content String
The WSDL content
- import
Method String The WSDL import method
- service Property Map
The service with name and endpoint names
- url String
The WSDL URL
WsdlServiceResponse
- Qualified
Name string The service's qualified name
- Endpoint
Qualified List<string>Names List of the endpoints' qualified names
- Qualified
Name string The service's qualified name
- Endpoint
Qualified []stringNames List of the endpoints' qualified names
- qualified
Name String The service's qualified name
- endpoint
Qualified List<String>Names List of the endpoints' qualified names
- qualified
Name string The service's qualified name
- endpoint
Qualified string[]Names List of the endpoints' qualified names
- qualified_
name str The service's qualified name
- endpoint_
qualified_ Sequence[str]names List of the endpoints' qualified names
- qualified
Name String The service's qualified name
- endpoint
Qualified List<String>Names List of the endpoints' qualified names
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0