Azure Native

v1.80.0 published on Tuesday, Oct 4, 2022 by Pulumi

getCustomApi

A custom API 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:

ApiName string

API name

ResourceGroupName string

The resource group

SubscriptionId string

Subscription Id

ApiName string

API name

ResourceGroupName string

The resource group

SubscriptionId string

Subscription Id

apiName String

API name

resourceGroupName String

The resource group

subscriptionId String

Subscription Id

apiName string

API name

resourceGroupName string

The resource group

subscriptionId string

Subscription Id

api_name str

API name

resource_group_name str

The resource group

subscription_id str

Subscription Id

apiName String

API name

resourceGroupName String

The resource group

subscriptionId String

Subscription Id

getCustomApi Result

The following output properties are available:

Id string

Resource id

Name string

Resource name

Properties Pulumi.AzureNative.Web.Outputs.CustomApiPropertiesDefinitionResponse

Custom API properties

Type string

Resource type

Etag string

Resource ETag

Location string

Resource location

Tags Dictionary<string, string>

Resource tags

Id string

Resource id

Name string

Resource name

Properties CustomApiPropertiesDefinitionResponse

Custom API properties

Type string

Resource type

Etag string

Resource ETag

Location string

Resource location

Tags map[string]string

Resource tags

id String

Resource id

name String

Resource name

properties CustomApiPropertiesDefinitionResponse

Custom API properties

type String

Resource type

etag String

Resource ETag

location String

Resource location

tags Map<String,String>

Resource tags

id string

Resource id

name string

Resource name

properties CustomApiPropertiesDefinitionResponse

Custom API properties

type string

Resource type

etag string

Resource ETag

location string

Resource location

tags {[key: string]: string}

Resource tags

id str

Resource id

name str

Resource name

properties CustomApiPropertiesDefinitionResponse

Custom API properties

type str

Resource type

etag str

Resource ETag

location str

Resource location

tags 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

tags Map<String>

Resource tags

Supporting Types

ApiOAuthSettingsParameterResponse

Options object

Options available to this parameter

UiDefinition object

UI definitions per culture as caller can specify the culture

Value string

Value of the setting

Options interface{}

Options available to this parameter

UiDefinition interface{}

UI definitions per culture as caller can specify the culture

Value string

Value of the setting

options Object

Options available to this parameter

uiDefinition Object

UI definitions per culture as caller can specify the culture

value String

Value of the setting

options any

Options available to this parameter

uiDefinition 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

uiDefinition Any

UI definitions per culture as caller can specify the culture

value String

Value of the setting

ApiOAuthSettingsResponse

ClientId string

Resource provider client id

ClientSecret string

Client Secret needed for OAuth

CustomParameters Dictionary<string, Pulumi.AzureNative.Web.Inputs.ApiOAuthSettingsParameterResponse>

OAuth parameters key is the name of parameter

IdentityProvider string

Identity provider

Properties object

Read only properties for this oauth setting.

RedirectUrl string

Url

Scopes List<string>

OAuth scopes

ClientId string

Resource provider client id

ClientSecret string

Client Secret needed for OAuth

CustomParameters map[string]ApiOAuthSettingsParameterResponse

OAuth parameters key is the name of parameter

IdentityProvider string

Identity provider

Properties interface{}

Read only properties for this oauth setting.

RedirectUrl string

Url

Scopes []string

OAuth scopes

clientId String

Resource provider client id

clientSecret String

Client Secret needed for OAuth

customParameters Map<String,ApiOAuthSettingsParameterResponse>

OAuth parameters key is the name of parameter

identityProvider String

Identity provider

properties Object

Read only properties for this oauth setting.

redirectUrl String

Url

scopes List<String>

OAuth scopes

clientId string

Resource provider client id

clientSecret string

Client Secret needed for OAuth

customParameters {[key: string]: ApiOAuthSettingsParameterResponse}

OAuth parameters key is the name of parameter

identityProvider string

Identity provider

properties any

Read only properties for this oauth setting.

redirectUrl 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, ApiOAuthSettingsParameterResponse]

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

clientId String

Resource provider client id

clientSecret String

Client Secret needed for OAuth

customParameters Map<Property Map>

OAuth parameters key is the name of parameter

identityProvider String

Identity provider

properties Any

Read only properties for this oauth setting.

redirectUrl String

Url

scopes List<String>

OAuth scopes

ApiResourceBackendServiceResponse

ServiceUrl string

The service URL

ServiceUrl string

The service URL

serviceUrl String

The service URL

serviceUrl string

The service URL

service_url str

The service URL

serviceUrl String

The service URL

ApiResourceDefinitionsResponse

ModifiedSwaggerUrl string

The modified swagger URL

OriginalSwaggerUrl string

The original swagger URL

ModifiedSwaggerUrl string

The modified swagger URL

OriginalSwaggerUrl string

The original swagger URL

modifiedSwaggerUrl String

The modified swagger URL

originalSwaggerUrl String

The original swagger URL

modifiedSwaggerUrl string

The modified swagger URL

originalSwaggerUrl string

The original swagger URL

modified_swagger_url str

The modified swagger URL

original_swagger_url str

The original swagger URL

modifiedSwaggerUrl String

The modified swagger URL

originalSwaggerUrl String

The original swagger URL

ConnectionParameterResponse

OAuthSettings Pulumi.AzureNative.Web.Inputs.ApiOAuthSettingsResponse

OAuth settings for the connection provider

Type string

Type of the parameter

OAuthSettings ApiOAuthSettingsResponse

OAuth settings for the connection provider

Type string

Type of the parameter

oAuthSettings ApiOAuthSettingsResponse

OAuth settings for the connection provider

type String

Type of the parameter

oAuthSettings ApiOAuthSettingsResponse

OAuth settings for the connection provider

type string

Type of the parameter

o_auth_settings ApiOAuthSettingsResponse

OAuth settings for the connection provider

type str

Type of the parameter

oAuthSettings Property Map

OAuth settings for the connection provider

type String

Type of the parameter

CustomApiPropertiesDefinitionResponse

ApiDefinitions Pulumi.AzureNative.Web.Inputs.ApiResourceDefinitionsResponse

API Definitions

ApiType string

The API type

BackendService Pulumi.AzureNative.Web.Inputs.ApiResourceBackendServiceResponse

The API backend service

BrandColor string

Brand color

Capabilities List<string>

The custom API capabilities

ConnectionParameters Dictionary<string, Pulumi.AzureNative.Web.Inputs.ConnectionParameterResponse>

Connection parameters

Description string

The custom API description

DisplayName string

The display name

IconUri string

The icon URI

RuntimeUrls List<string>

Runtime URLs

Swagger object

The JSON representation of the swagger

WsdlDefinition Pulumi.AzureNative.Web.Inputs.WsdlDefinitionResponse

The WSDL definition

ApiDefinitions ApiResourceDefinitionsResponse

API Definitions

ApiType string

The API type

BackendService ApiResourceBackendServiceResponse

The API backend service

BrandColor string

Brand color

Capabilities []string

The custom API capabilities

ConnectionParameters map[string]ConnectionParameterResponse

Connection parameters

Description string

The custom API description

DisplayName string

The display name

IconUri string

The icon URI

RuntimeUrls []string

Runtime URLs

Swagger interface{}

The JSON representation of the swagger

WsdlDefinition WsdlDefinitionResponse

The WSDL definition

apiDefinitions ApiResourceDefinitionsResponse

API Definitions

apiType String

The API type

backendService ApiResourceBackendServiceResponse

The API backend service

brandColor String

Brand color

capabilities List<String>

The custom API capabilities

connectionParameters Map<String,ConnectionParameterResponse>

Connection parameters

description String

The custom API description

displayName String

The display name

iconUri String

The icon URI

runtimeUrls List<String>

Runtime URLs

swagger Object

The JSON representation of the swagger

wsdlDefinition WsdlDefinitionResponse

The WSDL definition

apiDefinitions ApiResourceDefinitionsResponse

API Definitions

apiType string

The API type

backendService ApiResourceBackendServiceResponse

The API backend service

brandColor string

Brand color

capabilities string[]

The custom API capabilities

connectionParameters {[key: string]: ConnectionParameterResponse}

Connection parameters

description string

The custom API description

displayName string

The display name

iconUri string

The icon URI

runtimeUrls string[]

Runtime URLs

swagger any

The JSON representation of the swagger

wsdlDefinition WsdlDefinitionResponse

The WSDL definition

api_definitions ApiResourceDefinitionsResponse

API Definitions

api_type str

The API type

backend_service ApiResourceBackendServiceResponse

The API backend service

brand_color str

Brand color

capabilities Sequence[str]

The custom API capabilities

connection_parameters Mapping[str, ConnectionParameterResponse]

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 WsdlDefinitionResponse

The WSDL definition

apiDefinitions Property Map

API Definitions

apiType String

The API type

backendService Property Map

The API backend service

brandColor String

Brand color

capabilities List<String>

The custom API capabilities

connectionParameters Map<Property Map>

Connection parameters

description String

The custom API description

displayName String

The display name

iconUri String

The icon URI

runtimeUrls List<String>

Runtime URLs

swagger Any

The JSON representation of the swagger

wsdlDefinition Property Map

The WSDL definition

WsdlDefinitionResponse

Content string

The WSDL content

ImportMethod string

The WSDL import method

Service Pulumi.AzureNative.Web.Inputs.WsdlServiceResponse

The service with name and endpoint names

Url string

The WSDL URL

Content string

The WSDL content

ImportMethod string

The WSDL import method

Service WsdlServiceResponse

The service with name and endpoint names

Url string

The WSDL URL

content String

The WSDL content

importMethod String

The WSDL import method

service WsdlServiceResponse

The service with name and endpoint names

url String

The WSDL URL

content string

The WSDL content

importMethod string

The WSDL import method

service WsdlServiceResponse

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 WsdlServiceResponse

The service with name and endpoint names

url str

The WSDL URL

content String

The WSDL content

importMethod String

The WSDL import method

service Property Map

The service with name and endpoint names

url String

The WSDL URL

WsdlServiceResponse

QualifiedName string

The service's qualified name

EndpointQualifiedNames List<string>

List of the endpoints' qualified names

QualifiedName string

The service's qualified name

EndpointQualifiedNames []string

List of the endpoints' qualified names

qualifiedName String

The service's qualified name

endpointQualifiedNames List<String>

List of the endpoints' qualified names

qualifiedName string

The service's qualified name

endpointQualifiedNames string[]

List of the endpoints' qualified names

qualified_name str

The service's qualified name

endpoint_qualified_names Sequence[str]

List of the endpoints' qualified names

qualifiedName String

The service's qualified name

endpointQualifiedNames List<String>

List of the endpoints' qualified names

Package Details

Repository
https://github.com/pulumi/pulumi-azure-native
License
Apache-2.0