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.75.0 published on Saturday, Nov 30, 2024 by Pulumi
azure-native.apicenter.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.75.0 published on Saturday, Nov 30, 2024 by Pulumi
Returns details of the API. Azure REST API version: 2024-03-01.
Other available API versions: 2024-03-15-preview, 2024-06-01-preview.
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_name: Optional[str] = None,
resource_group_name: Optional[str] = None,
service_name: Optional[str] = None,
workspace_name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetApiResult
def get_api_output(api_name: Optional[pulumi.Input[str]] = None,
resource_group_name: Optional[pulumi.Input[str]] = None,
service_name: Optional[pulumi.Input[str]] = None,
workspace_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:apicenter:getApi
arguments:
# arguments dictionary
The following arguments are supported:
- Api
Name string - The name of the API.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Service
Name string - The name of Azure API Center service.
- Workspace
Name string - The name of the workspace.
- Api
Name string - The name of the API.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Service
Name string - The name of Azure API Center service.
- Workspace
Name string - The name of the workspace.
- api
Name String - The name of the API.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- service
Name String - The name of Azure API Center service.
- workspace
Name String - The name of the workspace.
- api
Name string - The name of the API.
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- service
Name string - The name of Azure API Center service.
- workspace
Name string - The name of the workspace.
- api_
name str - The name of the API.
- resource_
group_ strname - The name of the resource group. The name is case insensitive.
- service_
name str - The name of Azure API Center service.
- workspace_
name str - The name of the workspace.
- api
Name String - The name of the API.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- service
Name String - The name of Azure API Center service.
- workspace
Name String - The name of the workspace.
getApi Result
The following output properties are available:
- Id string
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- Kind string
- Kind of API. For example, REST or GraphQL.
- Lifecycle
Stage string - Current lifecycle stage of the API.
- Name string
- The name of the resource
- System
Data Pulumi.Azure Native. Api Center. Outputs. System Data Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Title string
- API title.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Contacts
List<Pulumi.
Azure Native. Api Center. Outputs. Contact Response> - The set of contacts
- Custom
Properties object - The custom metadata defined for API catalog entities.
- Description string
- Description of the API.
- External
Documentation List<Pulumi.Azure Native. Api Center. Outputs. External Documentation Response> - The set of external documentation
- License
Pulumi.
Azure Native. Api Center. Outputs. License Response - The license information for the API.
- Summary string
- Short description of the API.
- Terms
Of Pulumi.Service Azure Native. Api Center. Outputs. Terms Of Service Response - Terms of service for the API.
- Id string
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- Kind string
- Kind of API. For example, REST or GraphQL.
- Lifecycle
Stage string - Current lifecycle stage of the API.
- Name string
- The name of the resource
- System
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Title string
- API title.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Contacts
[]Contact
Response - The set of contacts
- Custom
Properties interface{} - The custom metadata defined for API catalog entities.
- Description string
- Description of the API.
- External
Documentation []ExternalDocumentation Response - The set of external documentation
- License
License
Response - The license information for the API.
- Summary string
- Short description of the API.
- Terms
Of TermsService Of Service Response - Terms of service for the API.
- id String
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- kind String
- Kind of API. For example, REST or GraphQL.
- lifecycle
Stage String - Current lifecycle stage of the API.
- name String
- The name of the resource
- system
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- title String
- API title.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- contacts
List<Contact
Response> - The set of contacts
- custom
Properties Object - The custom metadata defined for API catalog entities.
- description String
- Description of the API.
- external
Documentation List<ExternalDocumentation Response> - The set of external documentation
- license
License
Response - The license information for the API.
- summary String
- Short description of the API.
- terms
Of TermsService Of Service Response - Terms of service for the API.
- id string
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- kind string
- Kind of API. For example, REST or GraphQL.
- lifecycle
Stage string - Current lifecycle stage of the API.
- name string
- The name of the resource
- system
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- title string
- API title.
- type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- contacts
Contact
Response[] - The set of contacts
- custom
Properties any - The custom metadata defined for API catalog entities.
- description string
- Description of the API.
- external
Documentation ExternalDocumentation Response[] - The set of external documentation
- license
License
Response - The license information for the API.
- summary string
- Short description of the API.
- terms
Of TermsService Of Service Response - Terms of service for the API.
- id str
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- kind str
- Kind of API. For example, REST or GraphQL.
- lifecycle_
stage str - Current lifecycle stage of the API.
- name str
- The name of the resource
- system_
data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- title str
- API title.
- type str
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- contacts
Sequence[Contact
Response] - The set of contacts
- custom_
properties Any - The custom metadata defined for API catalog entities.
- description str
- Description of the API.
- external_
documentation Sequence[ExternalDocumentation Response] - The set of external documentation
- license
License
Response - The license information for the API.
- summary str
- Short description of the API.
- terms_
of_ Termsservice Of Service Response - Terms of service for the API.
- id String
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- kind String
- Kind of API. For example, REST or GraphQL.
- lifecycle
Stage String - Current lifecycle stage of the API.
- name String
- The name of the resource
- system
Data Property Map - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- title String
- API title.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- contacts List<Property Map>
- The set of contacts
- custom
Properties Any - The custom metadata defined for API catalog entities.
- description String
- Description of the API.
- external
Documentation List<Property Map> - The set of external documentation
- license Property Map
- The license information for the API.
- summary String
- Short description of the API.
- terms
Of Property MapService - Terms of service for the API.
Supporting Types
ContactResponse
ExternalDocumentationResponse
- Url string
- URL pointing to the documentation.
- Description string
- Description of the documentation.
- Title string
- Title of the documentation.
- Url string
- URL pointing to the documentation.
- Description string
- Description of the documentation.
- Title string
- Title of the documentation.
- url String
- URL pointing to the documentation.
- description String
- Description of the documentation.
- title String
- Title of the documentation.
- url string
- URL pointing to the documentation.
- description string
- Description of the documentation.
- title string
- Title of the documentation.
- url str
- URL pointing to the documentation.
- description str
- Description of the documentation.
- title str
- Title of the documentation.
- url String
- URL pointing to the documentation.
- description String
- Description of the documentation.
- title String
- Title of the documentation.
LicenseResponse
- Identifier string
- SPDX license information for the API. The identifier field is mutually exclusive of the URL field.
- Name string
- Name of the license.
- Url string
- URL pointing to the license details. The URL field is mutually exclusive of the identifier field.
- Identifier string
- SPDX license information for the API. The identifier field is mutually exclusive of the URL field.
- Name string
- Name of the license.
- Url string
- URL pointing to the license details. The URL field is mutually exclusive of the identifier field.
- identifier String
- SPDX license information for the API. The identifier field is mutually exclusive of the URL field.
- name String
- Name of the license.
- url String
- URL pointing to the license details. The URL field is mutually exclusive of the identifier field.
- identifier string
- SPDX license information for the API. The identifier field is mutually exclusive of the URL field.
- name string
- Name of the license.
- url string
- URL pointing to the license details. The URL field is mutually exclusive of the identifier field.
- identifier str
- SPDX license information for the API. The identifier field is mutually exclusive of the URL field.
- name str
- Name of the license.
- url str
- URL pointing to the license details. The URL field is mutually exclusive of the identifier field.
- identifier String
- SPDX license information for the API. The identifier field is mutually exclusive of the URL field.
- name String
- Name of the license.
- url String
- URL pointing to the license details. The URL field is mutually exclusive of the identifier field.
SystemDataResponse
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - The type of identity that last modified the resource.
- created_
at str - The timestamp of resource creation (UTC).
- created_
by str - The identity that created the resource.
- created_
by_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The timestamp of resource last modification (UTC)
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
TermsOfServiceResponse
- Url string
- URL pointing to the terms of service.
- Url string
- URL pointing to the terms of service.
- url String
- URL pointing to the terms of service.
- url string
- URL pointing to the terms of service.
- url str
- URL pointing to the terms of service.
- url String
- URL pointing to the terms of service.
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.75.0 published on Saturday, Nov 30, 2024 by Pulumi