1. Packages
  2. Azure Native
  3. API Docs
  4. apicenter
  5. getApiDefinition
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.37.0 published on Monday, Apr 15, 2024 by Pulumi

azure-native.apicenter.getApiDefinition

Explore with Pulumi AI

azure-native logo
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.37.0 published on Monday, Apr 15, 2024 by Pulumi

    Returns details of the API definition. Azure REST API version: 2024-03-01.

    Other available API versions: 2024-03-15-preview.

    Using getApiDefinition

    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 getApiDefinition(args: GetApiDefinitionArgs, opts?: InvokeOptions): Promise<GetApiDefinitionResult>
    function getApiDefinitionOutput(args: GetApiDefinitionOutputArgs, opts?: InvokeOptions): Output<GetApiDefinitionResult>
    def get_api_definition(api_name: Optional[str] = None,
                           definition_name: Optional[str] = None,
                           resource_group_name: Optional[str] = None,
                           service_name: Optional[str] = None,
                           version_name: Optional[str] = None,
                           workspace_name: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetApiDefinitionResult
    def get_api_definition_output(api_name: Optional[pulumi.Input[str]] = None,
                           definition_name: Optional[pulumi.Input[str]] = None,
                           resource_group_name: Optional[pulumi.Input[str]] = None,
                           service_name: Optional[pulumi.Input[str]] = None,
                           version_name: Optional[pulumi.Input[str]] = None,
                           workspace_name: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetApiDefinitionResult]
    func LookupApiDefinition(ctx *Context, args *LookupApiDefinitionArgs, opts ...InvokeOption) (*LookupApiDefinitionResult, error)
    func LookupApiDefinitionOutput(ctx *Context, args *LookupApiDefinitionOutputArgs, opts ...InvokeOption) LookupApiDefinitionResultOutput

    > Note: This function is named LookupApiDefinition in the Go SDK.

    public static class GetApiDefinition 
    {
        public static Task<GetApiDefinitionResult> InvokeAsync(GetApiDefinitionArgs args, InvokeOptions? opts = null)
        public static Output<GetApiDefinitionResult> Invoke(GetApiDefinitionInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetApiDefinitionResult> getApiDefinition(GetApiDefinitionArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:apicenter:getApiDefinition
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ApiName string
    The name of the API.
    DefinitionName string
    The name of the API definition.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ServiceName string
    The name of Azure API Center service.
    VersionName string
    The name of the API version.
    WorkspaceName string
    The name of the workspace.
    ApiName string
    The name of the API.
    DefinitionName string
    The name of the API definition.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ServiceName string
    The name of Azure API Center service.
    VersionName string
    The name of the API version.
    WorkspaceName string
    The name of the workspace.
    apiName String
    The name of the API.
    definitionName String
    The name of the API definition.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    serviceName String
    The name of Azure API Center service.
    versionName String
    The name of the API version.
    workspaceName String
    The name of the workspace.
    apiName string
    The name of the API.
    definitionName string
    The name of the API definition.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    serviceName string
    The name of Azure API Center service.
    versionName string
    The name of the API version.
    workspaceName string
    The name of the workspace.
    api_name str
    The name of the API.
    definition_name str
    The name of the API definition.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    service_name str
    The name of Azure API Center service.
    version_name str
    The name of the API version.
    workspace_name str
    The name of the workspace.
    apiName String
    The name of the API.
    definitionName String
    The name of the API definition.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    serviceName String
    The name of Azure API Center service.
    versionName String
    The name of the API version.
    workspaceName String
    The name of the workspace.

    getApiDefinition 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}"
    Name string
    The name of the resource
    Specification Pulumi.AzureNative.ApiCenter.Outputs.ApiDefinitionPropertiesSpecificationResponse
    API specification details.
    SystemData Pulumi.AzureNative.ApiCenter.Outputs.SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Title string
    API definition title.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Description string
    API definition description.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Name string
    The name of the resource
    Specification ApiDefinitionPropertiesSpecificationResponse
    API specification details.
    SystemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Title string
    API definition title.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Description string
    API definition description.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name String
    The name of the resource
    specification ApiDefinitionPropertiesSpecificationResponse
    API specification details.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    title String
    API definition title.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    description String
    API definition description.
    id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name string
    The name of the resource
    specification ApiDefinitionPropertiesSpecificationResponse
    API specification details.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    title string
    API definition title.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    description string
    API definition description.
    id str
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name str
    The name of the resource
    specification ApiDefinitionPropertiesSpecificationResponse
    API specification details.
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    title str
    API definition title.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    description str
    API definition description.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name String
    The name of the resource
    specification Property Map
    API specification details.
    systemData Property Map
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    title String
    API definition title.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    description String
    API definition description.

    Supporting Types

    ApiDefinitionPropertiesSpecificationResponse

    Name string
    Specification name.
    Version string
    Specification version.
    Name string
    Specification name.
    Version string
    Specification version.
    name String
    Specification name.
    version String
    Specification version.
    name string
    Specification name.
    version string
    Specification version.
    name str
    Specification name.
    version str
    Specification version.
    name String
    Specification name.
    version String
    Specification version.

    SystemDataResponse

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    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_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    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.37.0 published on Monday, Apr 15, 2024 by Pulumi