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.71.0 published on Friday, Nov 8, 2024 by Pulumi
azure-native.apicenter.getApiDefinition
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.71.0 published on Friday, Nov 8, 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:
- Api
Name string - The name of the API.
- Definition
Name string - The name of the API definition.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Service
Name string - The name of Azure API Center service.
- Version
Name string - The name of the API version.
- Workspace
Name string - The name of the workspace.
- Api
Name string - The name of the API.
- Definition
Name string - The name of the API definition.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Service
Name string - The name of Azure API Center service.
- Version
Name string - The name of the API version.
- Workspace
Name string - The name of the workspace.
- api
Name String - The name of the API.
- definition
Name String - The name of the API definition.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- service
Name String - The name of Azure API Center service.
- version
Name String - The name of the API version.
- workspace
Name String - The name of the workspace.
- api
Name string - The name of the API.
- definition
Name string - The name of the API definition.
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- service
Name string - The name of Azure API Center service.
- version
Name string - The name of the API version.
- workspace
Name 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_ strname - 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.
- api
Name String - The name of the API.
- definition
Name String - The name of the API definition.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- service
Name String - The name of Azure API Center service.
- version
Name String - The name of the API version.
- workspace
Name 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.
Azure Native. Api Center. Outputs. Api Definition Properties Specification Response - API specification details.
- System
Data Pulumi.Azure Native. Api Center. Outputs. System Data Response - 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
Api
Definition Properties Specification Response - API specification details.
- System
Data SystemData Response - 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
Api
Definition Properties Specification Response - API specification details.
- system
Data SystemData Response - 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
Api
Definition Properties Specification Response - API specification details.
- system
Data SystemData Response - 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
Api
Definition Properties Specification Response - API specification details.
- system_
data SystemData Response - 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.
- system
Data 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
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.
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.71.0 published on Friday, Nov 8, 2024 by Pulumi