Docs Packages
  1. Packages
  2. Azure Native
  3. API Docs
  4. apicenter
  5. getMetadataSchema
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.41.0 published on Tuesday, May 14, 2024 by Pulumi
pulumi/pulumi-azure-native

azure-native.apicenter.getMetadataSchema

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.41.0 published on Tuesday, May 14, 2024 by Pulumi
pulumi/pulumi-azure-native

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

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

    Using getMetadataSchema

    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 getMetadataSchema(args: GetMetadataSchemaArgs, opts?: InvokeOptions): Promise<GetMetadataSchemaResult>
function getMetadataSchemaOutput(args: GetMetadataSchemaOutputArgs, opts?: InvokeOptions): Output<GetMetadataSchemaResult>
    def get_metadata_schema(metadata_schema_name: Optional[str] = None,
                        resource_group_name: Optional[str] = None,
                        service_name: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetMetadataSchemaResult
def get_metadata_schema_output(metadata_schema_name: Optional[pulumi.Input[str]] = None,
                        resource_group_name: Optional[pulumi.Input[str]] = None,
                        service_name: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetMetadataSchemaResult]
    func LookupMetadataSchema(ctx *Context, args *LookupMetadataSchemaArgs, opts ...InvokeOption) (*LookupMetadataSchemaResult, error)
func LookupMetadataSchemaOutput(ctx *Context, args *LookupMetadataSchemaOutputArgs, opts ...InvokeOption) LookupMetadataSchemaResultOutput

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

    public static class GetMetadataSchema 
{
    public static Task<GetMetadataSchemaResult> InvokeAsync(GetMetadataSchemaArgs args, InvokeOptions? opts = null)
    public static Output<GetMetadataSchemaResult> Invoke(GetMetadataSchemaInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetMetadataSchemaResult> getMetadataSchema(GetMetadataSchemaArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: azure-native:apicenter:getMetadataSchema
  arguments:
    # arguments dictionary

    The following arguments are supported:

    MetadataSchemaName string
    The name of the metadata schema.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ServiceName string
    The name of Azure API Center service.
    MetadataSchemaName string
    The name of the metadata schema.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ServiceName string
    The name of Azure API Center service.
    metadataSchemaName String
    The name of the metadata schema.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    serviceName String
    The name of Azure API Center service.
    metadataSchemaName string
    The name of the metadata schema.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    serviceName string
    The name of Azure API Center service.
    metadata_schema_name str
    The name of the metadata schema.
    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.
    metadataSchemaName String
    The name of the metadata schema.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    serviceName String
    The name of Azure API Center service.

    getMetadataSchema 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
    Schema string
    The schema defining the type.
    SystemData Pulumi.AzureNative.ApiCenter.Outputs.SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    AssignedTo List<Pulumi.AzureNative.ApiCenter.Outputs.MetadataAssignmentResponse>
    The assignees
    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
    Schema string
    The schema defining the type.
    SystemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    AssignedTo []MetadataAssignmentResponse
    The assignees
    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
    schema String
    The schema defining the type.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    assignedTo List<MetadataAssignmentResponse>
    The assignees
    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
    schema string
    The schema defining the type.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    assignedTo MetadataAssignmentResponse[]
    The assignees
    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
    schema str
    The schema defining the type.
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    assigned_to Sequence[MetadataAssignmentResponse]
    The assignees
    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
    schema String
    The schema defining the type.
    systemData Property Map
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    assignedTo List<Property Map>
    The assignees

    Supporting Types

    MetadataAssignmentResponse

    Deprecated bool
    Deprecated assignment
    Entity string
    The entities this metadata schema component gets applied to.
    Required bool
    Required assignment
    Deprecated bool
    Deprecated assignment
    Entity string
    The entities this metadata schema component gets applied to.
    Required bool
    Required assignment
    deprecated Boolean
    Deprecated assignment
    entity String
    The entities this metadata schema component gets applied to.
    required Boolean
    Required assignment
    deprecated boolean
    Deprecated assignment
    entity string
    The entities this metadata schema component gets applied to.
    required boolean
    Required assignment
    deprecated bool
    Deprecated assignment
    entity str
    The entities this metadata schema component gets applied to.
    required bool
    Required assignment
    deprecated Boolean
    Deprecated assignment
    entity String
    The entities this metadata schema component gets applied to.
    required Boolean
    Required assignment

    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.41.0 published on Tuesday, May 14, 2024 by Pulumi
    pulumi/pulumi-azure-native