Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. apimanagement
  5. GatewayApiEntityTag
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.apimanagement.GatewayApiEntityTag

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

    API details.

    Uses Azure REST API version 2022-09-01-preview. In version 2.x of the Azure Native provider, it used API version 2022-08-01.

    Other available API versions: 2021-04-01-preview, 2021-08-01, 2021-12-01-preview, 2022-04-01-preview, 2022-08-01, 2023-03-01-preview, 2023-05-01-preview, 2023-09-01-preview, 2024-05-01, 2024-06-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native apimanagement [ApiVersion]. See the version guide for details.

    Example Usage

    ApiManagementCreateGatewayApi

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var gatewayApiEntityTag = new AzureNative.ApiManagement.GatewayApiEntityTag("gatewayApiEntityTag", new()
    {
        ApiId = "echo-api",
        GatewayId = "gw1",
        ProvisioningState = AzureNative.ApiManagement.ProvisioningState.Created,
        ResourceGroupName = "rg1",
        ServiceName = "apimService1",
    });

});

    package main

import (
	apimanagement "github.com/pulumi/pulumi-azure-native-sdk/apimanagement/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := apimanagement.NewGatewayApiEntityTag(ctx, "gatewayApiEntityTag", &apimanagement.GatewayApiEntityTagArgs{
			ApiId:             pulumi.String("echo-api"),
			GatewayId:         pulumi.String("gw1"),
			ProvisioningState: apimanagement.ProvisioningStateCreated,
			ResourceGroupName: pulumi.String("rg1"),
			ServiceName:       pulumi.String("apimService1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.apimanagement.GatewayApiEntityTag;
import com.pulumi.azurenative.apimanagement.GatewayApiEntityTagArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var gatewayApiEntityTag = new GatewayApiEntityTag("gatewayApiEntityTag", GatewayApiEntityTagArgs.builder()
            .apiId("echo-api")
            .gatewayId("gw1")
            .provisioningState("created")
            .resourceGroupName("rg1")
            .serviceName("apimService1")
            .build());

    }
}

    import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const gatewayApiEntityTag = new azure_native.apimanagement.GatewayApiEntityTag("gatewayApiEntityTag", {
    apiId: "echo-api",
    gatewayId: "gw1",
    provisioningState: azure_native.apimanagement.ProvisioningState.Created,
    resourceGroupName: "rg1",
    serviceName: "apimService1",
});

    import pulumi
import pulumi_azure_native as azure_native

gateway_api_entity_tag = azure_native.apimanagement.GatewayApiEntityTag("gatewayApiEntityTag",
    api_id="echo-api",
    gateway_id="gw1",
    provisioning_state=azure_native.apimanagement.ProvisioningState.CREATED,
    resource_group_name="rg1",
    service_name="apimService1")

    resources:
  gatewayApiEntityTag:
    type: azure-native:apimanagement:GatewayApiEntityTag
    properties:
      apiId: echo-api
      gatewayId: gw1
      provisioningState: created
      resourceGroupName: rg1
      serviceName: apimService1

    Create GatewayApiEntityTag Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new GatewayApiEntityTag(name: string, args: GatewayApiEntityTagArgs, opts?: CustomResourceOptions);
    @overload
def GatewayApiEntityTag(resource_name: str,
                        args: GatewayApiEntityTagArgs,
                        opts: Optional[ResourceOptions] = None)

@overload
def GatewayApiEntityTag(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        gateway_id: Optional[str] = None,
                        resource_group_name: Optional[str] = None,
                        service_name: Optional[str] = None,
                        api_id: Optional[str] = None,
                        provisioning_state: Optional[ProvisioningState] = None)
    func NewGatewayApiEntityTag(ctx *Context, name string, args GatewayApiEntityTagArgs, opts ...ResourceOption) (*GatewayApiEntityTag, error)
    public GatewayApiEntityTag(string name, GatewayApiEntityTagArgs args, CustomResourceOptions? opts = null)
    public GatewayApiEntityTag(String name, GatewayApiEntityTagArgs args)
public GatewayApiEntityTag(String name, GatewayApiEntityTagArgs args, CustomResourceOptions options)

    type: azure-native:apimanagement:GatewayApiEntityTag
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args GatewayApiEntityTagArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args GatewayApiEntityTagArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args GatewayApiEntityTagArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GatewayApiEntityTagArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GatewayApiEntityTagArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var gatewayApiEntityTagResource = new AzureNative.ApiManagement.GatewayApiEntityTag("gatewayApiEntityTagResource", new()
{
    GatewayId = "string",
    ResourceGroupName = "string",
    ServiceName = "string",
    ApiId = "string",
    ProvisioningState = AzureNative.ApiManagement.ProvisioningState.Created,
});

    example, err := apimanagement.NewGatewayApiEntityTag(ctx, "gatewayApiEntityTagResource", &apimanagement.GatewayApiEntityTagArgs{
	GatewayId:         pulumi.String("string"),
	ResourceGroupName: pulumi.String("string"),
	ServiceName:       pulumi.String("string"),
	ApiId:             pulumi.String("string"),
	ProvisioningState: apimanagement.ProvisioningStateCreated,
})

    var gatewayApiEntityTagResource = new GatewayApiEntityTag("gatewayApiEntityTagResource", GatewayApiEntityTagArgs.builder()
    .gatewayId("string")
    .resourceGroupName("string")
    .serviceName("string")
    .apiId("string")
    .provisioningState("created")
    .build());

    gateway_api_entity_tag_resource = azure_native.apimanagement.GatewayApiEntityTag("gatewayApiEntityTagResource",
    gateway_id="string",
    resource_group_name="string",
    service_name="string",
    api_id="string",
    provisioning_state=azure_native.apimanagement.ProvisioningState.CREATED)

    const gatewayApiEntityTagResource = new azure_native.apimanagement.GatewayApiEntityTag("gatewayApiEntityTagResource", {
    gatewayId: "string",
    resourceGroupName: "string",
    serviceName: "string",
    apiId: "string",
    provisioningState: azure_native.apimanagement.ProvisioningState.Created,
});

    type: azure-native:apimanagement:GatewayApiEntityTag
properties:
    apiId: string
    gatewayId: string
    provisioningState: created
    resourceGroupName: string
    serviceName: string

    GatewayApiEntityTag Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The GatewayApiEntityTag resource accepts the following input properties:

    GatewayId string
    Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ServiceName string
    The name of the API Management service.
    ApiId string
    API identifier. Must be unique in the current API Management service instance.
    ProvisioningState Pulumi.AzureNative.ApiManagement.ProvisioningState
    Provisioning state.
    GatewayId string
    Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ServiceName string
    The name of the API Management service.
    ApiId string
    API identifier. Must be unique in the current API Management service instance.
    ProvisioningState ProvisioningState
    Provisioning state.
    gatewayId String
    Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    serviceName String
    The name of the API Management service.
    apiId String
    API identifier. Must be unique in the current API Management service instance.
    provisioningState ProvisioningState
    Provisioning state.
    gatewayId string
    Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    serviceName string
    The name of the API Management service.
    apiId string
    API identifier. Must be unique in the current API Management service instance.
    provisioningState ProvisioningState
    Provisioning state.
    gateway_id str
    Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    service_name str
    The name of the API Management service.
    api_id str
    API identifier. Must be unique in the current API Management service instance.
    provisioning_state ProvisioningState
    Provisioning state.
    gatewayId String
    Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    serviceName String
    The name of the API Management service.
    apiId String
    API identifier. Must be unique in the current API Management service instance.
    provisioningState "created"
    Provisioning state.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the GatewayApiEntityTag resource produces the following output properties:

    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    IsOnline bool
    Indicates if API revision is accessible via the gateway.
    Name string
    The name of the resource
    Path string
    Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    ApiRevision string
    Describes the revision of the API. If no value is provided, default revision 1 is created
    ApiRevisionDescription string
    Description of the API Revision.
    ApiType string
    Type of API.
    ApiVersion string
    Indicates the version identifier of the API if the API is versioned
    ApiVersionDescription string
    Description of the API Version.
    ApiVersionSet Pulumi.AzureNative.ApiManagement.Outputs.ApiVersionSetContractDetailsResponse
    Version set details
    ApiVersionSetId string
    A resource identifier for the related ApiVersionSet.
    AuthenticationSettings Pulumi.AzureNative.ApiManagement.Outputs.AuthenticationSettingsContractResponse
    Collection of authentication settings included into this API.
    Contact Pulumi.AzureNative.ApiManagement.Outputs.ApiContactInformationResponse
    Contact information for the API.
    Description string
    Description of the API. May include HTML formatting tags.
    DisplayName string
    API name. Must be 1 to 300 characters long.
    IsCurrent bool
    Indicates if API revision is current api revision.
    License Pulumi.AzureNative.ApiManagement.Outputs.ApiLicenseInformationResponse
    License information for the API.
    Protocols List<string>
    Describes on which protocols the operations in this API can be invoked.
    ServiceUrl string
    Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long.
    SourceApiId string
    API identifier of the source API.
    SubscriptionKeyParameterNames Pulumi.AzureNative.ApiManagement.Outputs.SubscriptionKeyParameterNamesContractResponse
    Protocols over which API is made available.
    SubscriptionRequired bool
    Specifies whether an API or Product subscription is required for accessing the API.
    TermsOfServiceUrl string
    A URL to the Terms of Service for the API. MUST be in the format of a URL.
    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    IsOnline bool
    Indicates if API revision is accessible via the gateway.
    Name string
    The name of the resource
    Path string
    Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    ApiRevision string
    Describes the revision of the API. If no value is provided, default revision 1 is created
    ApiRevisionDescription string
    Description of the API Revision.
    ApiType string
    Type of API.
    ApiVersion string
    Indicates the version identifier of the API if the API is versioned
    ApiVersionDescription string
    Description of the API Version.
    ApiVersionSet ApiVersionSetContractDetailsResponse
    Version set details
    ApiVersionSetId string
    A resource identifier for the related ApiVersionSet.
    AuthenticationSettings AuthenticationSettingsContractResponse
    Collection of authentication settings included into this API.
    Contact ApiContactInformationResponse
    Contact information for the API.
    Description string
    Description of the API. May include HTML formatting tags.
    DisplayName string
    API name. Must be 1 to 300 characters long.
    IsCurrent bool
    Indicates if API revision is current api revision.
    License ApiLicenseInformationResponse
    License information for the API.
    Protocols []string
    Describes on which protocols the operations in this API can be invoked.
    ServiceUrl string
    Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long.
    SourceApiId string
    API identifier of the source API.
    SubscriptionKeyParameterNames SubscriptionKeyParameterNamesContractResponse
    Protocols over which API is made available.
    SubscriptionRequired bool
    Specifies whether an API or Product subscription is required for accessing the API.
    TermsOfServiceUrl string
    A URL to the Terms of Service for the API. MUST be in the format of a URL.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    The provider-assigned unique ID for this managed resource.
    isOnline Boolean
    Indicates if API revision is accessible via the gateway.
    name String
    The name of the resource
    path String
    Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    apiRevision String
    Describes the revision of the API. If no value is provided, default revision 1 is created
    apiRevisionDescription String
    Description of the API Revision.
    apiType String
    Type of API.
    apiVersion String
    Indicates the version identifier of the API if the API is versioned
    apiVersionDescription String
    Description of the API Version.
    apiVersionSet ApiVersionSetContractDetailsResponse
    Version set details
    apiVersionSetId String
    A resource identifier for the related ApiVersionSet.
    authenticationSettings AuthenticationSettingsContractResponse
    Collection of authentication settings included into this API.
    contact ApiContactInformationResponse
    Contact information for the API.
    description String
    Description of the API. May include HTML formatting tags.
    displayName String
    API name. Must be 1 to 300 characters long.
    isCurrent Boolean
    Indicates if API revision is current api revision.
    license ApiLicenseInformationResponse
    License information for the API.
    protocols List<String>
    Describes on which protocols the operations in this API can be invoked.
    serviceUrl String
    Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long.
    sourceApiId String
    API identifier of the source API.
    subscriptionKeyParameterNames SubscriptionKeyParameterNamesContractResponse
    Protocols over which API is made available.
    subscriptionRequired Boolean
    Specifies whether an API or Product subscription is required for accessing the API.
    termsOfServiceUrl String
    A URL to the Terms of Service for the API. MUST be in the format of a URL.
    azureApiVersion string
    The Azure API version of the resource.
    id string
    The provider-assigned unique ID for this managed resource.
    isOnline boolean
    Indicates if API revision is accessible via the gateway.
    name string
    The name of the resource
    path string
    Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    apiRevision string
    Describes the revision of the API. If no value is provided, default revision 1 is created
    apiRevisionDescription string
    Description of the API Revision.
    apiType string
    Type of API.
    apiVersion string
    Indicates the version identifier of the API if the API is versioned
    apiVersionDescription string
    Description of the API Version.
    apiVersionSet ApiVersionSetContractDetailsResponse
    Version set details
    apiVersionSetId string
    A resource identifier for the related ApiVersionSet.
    authenticationSettings AuthenticationSettingsContractResponse
    Collection of authentication settings included into this API.
    contact ApiContactInformationResponse
    Contact information for the API.
    description string
    Description of the API. May include HTML formatting tags.
    displayName string
    API name. Must be 1 to 300 characters long.
    isCurrent boolean
    Indicates if API revision is current api revision.
    license ApiLicenseInformationResponse
    License information for the API.
    protocols string[]
    Describes on which protocols the operations in this API can be invoked.
    serviceUrl string
    Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long.
    sourceApiId string
    API identifier of the source API.
    subscriptionKeyParameterNames SubscriptionKeyParameterNamesContractResponse
    Protocols over which API is made available.
    subscriptionRequired boolean
    Specifies whether an API or Product subscription is required for accessing the API.
    termsOfServiceUrl string
    A URL to the Terms of Service for the API. MUST be in the format of a URL.
    azure_api_version str
    The Azure API version of the resource.
    id str
    The provider-assigned unique ID for this managed resource.
    is_online bool
    Indicates if API revision is accessible via the gateway.
    name str
    The name of the resource
    path str
    Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    api_revision str
    Describes the revision of the API. If no value is provided, default revision 1 is created
    api_revision_description str
    Description of the API Revision.
    api_type str
    Type of API.
    api_version str
    Indicates the version identifier of the API if the API is versioned
    api_version_description str
    Description of the API Version.
    api_version_set ApiVersionSetContractDetailsResponse
    Version set details
    api_version_set_id str
    A resource identifier for the related ApiVersionSet.
    authentication_settings AuthenticationSettingsContractResponse
    Collection of authentication settings included into this API.
    contact ApiContactInformationResponse
    Contact information for the API.
    description str
    Description of the API. May include HTML formatting tags.
    display_name str
    API name. Must be 1 to 300 characters long.
    is_current bool
    Indicates if API revision is current api revision.
    license ApiLicenseInformationResponse
    License information for the API.
    protocols Sequence[str]
    Describes on which protocols the operations in this API can be invoked.
    service_url str
    Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long.
    source_api_id str
    API identifier of the source API.
    subscription_key_parameter_names SubscriptionKeyParameterNamesContractResponse
    Protocols over which API is made available.
    subscription_required bool
    Specifies whether an API or Product subscription is required for accessing the API.
    terms_of_service_url str
    A URL to the Terms of Service for the API. MUST be in the format of a URL.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    The provider-assigned unique ID for this managed resource.
    isOnline Boolean
    Indicates if API revision is accessible via the gateway.
    name String
    The name of the resource
    path String
    Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    apiRevision String
    Describes the revision of the API. If no value is provided, default revision 1 is created
    apiRevisionDescription String
    Description of the API Revision.
    apiType String
    Type of API.
    apiVersion String
    Indicates the version identifier of the API if the API is versioned
    apiVersionDescription String
    Description of the API Version.
    apiVersionSet Property Map
    Version set details
    apiVersionSetId String
    A resource identifier for the related ApiVersionSet.
    authenticationSettings Property Map
    Collection of authentication settings included into this API.
    contact Property Map
    Contact information for the API.
    description String
    Description of the API. May include HTML formatting tags.
    displayName String
    API name. Must be 1 to 300 characters long.
    isCurrent Boolean
    Indicates if API revision is current api revision.
    license Property Map
    License information for the API.
    protocols List<String>
    Describes on which protocols the operations in this API can be invoked.
    serviceUrl String
    Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long.
    sourceApiId String
    API identifier of the source API.
    subscriptionKeyParameterNames Property Map
    Protocols over which API is made available.
    subscriptionRequired Boolean
    Specifies whether an API or Product subscription is required for accessing the API.
    termsOfServiceUrl String
    A URL to the Terms of Service for the API. MUST be in the format of a URL.

    Supporting Types

    ApiContactInformationResponse, ApiContactInformationResponseArgs

    Email string
    The email address of the contact person/organization. MUST be in the format of an email address
    Name string
    The identifying name of the contact person/organization
    Url string
    The URL pointing to the contact information. MUST be in the format of a URL
    Email string
    The email address of the contact person/organization. MUST be in the format of an email address
    Name string
    The identifying name of the contact person/organization
    Url string
    The URL pointing to the contact information. MUST be in the format of a URL
    email String
    The email address of the contact person/organization. MUST be in the format of an email address
    name String
    The identifying name of the contact person/organization
    url String
    The URL pointing to the contact information. MUST be in the format of a URL
    email string
    The email address of the contact person/organization. MUST be in the format of an email address
    name string
    The identifying name of the contact person/organization
    url string
    The URL pointing to the contact information. MUST be in the format of a URL
    email str
    The email address of the contact person/organization. MUST be in the format of an email address
    name str
    The identifying name of the contact person/organization
    url str
    The URL pointing to the contact information. MUST be in the format of a URL
    email String
    The email address of the contact person/organization. MUST be in the format of an email address
    name String
    The identifying name of the contact person/organization
    url String
    The URL pointing to the contact information. MUST be in the format of a URL

    ApiLicenseInformationResponse, ApiLicenseInformationResponseArgs

    Name string
    The license name used for the API
    Url string
    A URL to the license used for the API. MUST be in the format of a URL
    Name string
    The license name used for the API
    Url string
    A URL to the license used for the API. MUST be in the format of a URL
    name String
    The license name used for the API
    url String
    A URL to the license used for the API. MUST be in the format of a URL
    name string
    The license name used for the API
    url string
    A URL to the license used for the API. MUST be in the format of a URL
    name str
    The license name used for the API
    url str
    A URL to the license used for the API. MUST be in the format of a URL
    name String
    The license name used for the API
    url String
    A URL to the license used for the API. MUST be in the format of a URL

    ApiVersionSetContractDetailsResponse, ApiVersionSetContractDetailsResponseArgs

    Description string
    Description of API Version Set.
    Id string
    Identifier for existing API Version Set. Omit this value to create a new Version Set.
    Name string
    The display Name of the API Version Set.
    VersionHeaderName string
    Name of HTTP header parameter that indicates the API Version if versioningScheme is set to header.
    VersionQueryName string
    Name of query parameter that indicates the API Version if versioningScheme is set to query.
    VersioningScheme string
    An value that determines where the API Version identifier will be located in a HTTP request.
    Description string
    Description of API Version Set.
    Id string
    Identifier for existing API Version Set. Omit this value to create a new Version Set.
    Name string
    The display Name of the API Version Set.
    VersionHeaderName string
    Name of HTTP header parameter that indicates the API Version if versioningScheme is set to header.
    VersionQueryName string
    Name of query parameter that indicates the API Version if versioningScheme is set to query.
    VersioningScheme string
    An value that determines where the API Version identifier will be located in a HTTP request.
    description String
    Description of API Version Set.
    id String
    Identifier for existing API Version Set. Omit this value to create a new Version Set.
    name String
    The display Name of the API Version Set.
    versionHeaderName String
    Name of HTTP header parameter that indicates the API Version if versioningScheme is set to header.
    versionQueryName String
    Name of query parameter that indicates the API Version if versioningScheme is set to query.
    versioningScheme String
    An value that determines where the API Version identifier will be located in a HTTP request.
    description string
    Description of API Version Set.
    id string
    Identifier for existing API Version Set. Omit this value to create a new Version Set.
    name string
    The display Name of the API Version Set.
    versionHeaderName string
    Name of HTTP header parameter that indicates the API Version if versioningScheme is set to header.
    versionQueryName string
    Name of query parameter that indicates the API Version if versioningScheme is set to query.
    versioningScheme string
    An value that determines where the API Version identifier will be located in a HTTP request.
    description str
    Description of API Version Set.
    id str
    Identifier for existing API Version Set. Omit this value to create a new Version Set.
    name str
    The display Name of the API Version Set.
    version_header_name str
    Name of HTTP header parameter that indicates the API Version if versioningScheme is set to header.
    version_query_name str
    Name of query parameter that indicates the API Version if versioningScheme is set to query.
    versioning_scheme str
    An value that determines where the API Version identifier will be located in a HTTP request.
    description String
    Description of API Version Set.
    id String
    Identifier for existing API Version Set. Omit this value to create a new Version Set.
    name String
    The display Name of the API Version Set.
    versionHeaderName String
    Name of HTTP header parameter that indicates the API Version if versioningScheme is set to header.
    versionQueryName String
    Name of query parameter that indicates the API Version if versioningScheme is set to query.
    versioningScheme String
    An value that determines where the API Version identifier will be located in a HTTP request.

    AuthenticationSettingsContractResponse, AuthenticationSettingsContractResponseArgs

    OAuth2 OAuth2AuthenticationSettingsContractResponse
    OAuth2 Authentication settings
    OAuth2AuthenticationSettings []OAuth2AuthenticationSettingsContractResponse
    Collection of OAuth2 authentication settings included into this API.
    Openid OpenIdAuthenticationSettingsContractResponse
    OpenID Connect Authentication Settings
    OpenidAuthenticationSettings []OpenIdAuthenticationSettingsContractResponse
    Collection of Open ID Connect authentication settings included into this API.
    oAuth2 OAuth2AuthenticationSettingsContractResponse
    OAuth2 Authentication settings
    oAuth2AuthenticationSettings List<OAuth2AuthenticationSettingsContractResponse>
    Collection of OAuth2 authentication settings included into this API.
    openid OpenIdAuthenticationSettingsContractResponse
    OpenID Connect Authentication Settings
    openidAuthenticationSettings List<OpenIdAuthenticationSettingsContractResponse>
    Collection of Open ID Connect authentication settings included into this API.
    oAuth2 OAuth2AuthenticationSettingsContractResponse
    OAuth2 Authentication settings
    oAuth2AuthenticationSettings OAuth2AuthenticationSettingsContractResponse[]
    Collection of OAuth2 authentication settings included into this API.
    openid OpenIdAuthenticationSettingsContractResponse
    OpenID Connect Authentication Settings
    openidAuthenticationSettings OpenIdAuthenticationSettingsContractResponse[]
    Collection of Open ID Connect authentication settings included into this API.
    o_auth2 OAuth2AuthenticationSettingsContractResponse
    OAuth2 Authentication settings
    o_auth2_authentication_settings Sequence[OAuth2AuthenticationSettingsContractResponse]
    Collection of OAuth2 authentication settings included into this API.
    openid OpenIdAuthenticationSettingsContractResponse
    OpenID Connect Authentication Settings
    openid_authentication_settings Sequence[OpenIdAuthenticationSettingsContractResponse]
    Collection of Open ID Connect authentication settings included into this API.
    oAuth2 Property Map
    OAuth2 Authentication settings
    oAuth2AuthenticationSettings List<Property Map>
    Collection of OAuth2 authentication settings included into this API.
    openid Property Map
    OpenID Connect Authentication Settings
    openidAuthenticationSettings List<Property Map>
    Collection of Open ID Connect authentication settings included into this API.

    OAuth2AuthenticationSettingsContractResponse, OAuth2AuthenticationSettingsContractResponseArgs

    AuthorizationServerId string
    OAuth authorization server identifier.
    Scope string
    operations scope.
    AuthorizationServerId string
    OAuth authorization server identifier.
    Scope string
    operations scope.
    authorizationServerId String
    OAuth authorization server identifier.
    scope String
    operations scope.
    authorizationServerId string
    OAuth authorization server identifier.
    scope string
    operations scope.
    authorization_server_id str
    OAuth authorization server identifier.
    scope str
    operations scope.
    authorizationServerId String
    OAuth authorization server identifier.
    scope String
    operations scope.

    OpenIdAuthenticationSettingsContractResponse, OpenIdAuthenticationSettingsContractResponseArgs

    BearerTokenSendingMethods List<string>
    How to send token to the server.
    OpenidProviderId string
    OAuth authorization server identifier.
    BearerTokenSendingMethods []string
    How to send token to the server.
    OpenidProviderId string
    OAuth authorization server identifier.
    bearerTokenSendingMethods List<String>
    How to send token to the server.
    openidProviderId String
    OAuth authorization server identifier.
    bearerTokenSendingMethods string[]
    How to send token to the server.
    openidProviderId string
    OAuth authorization server identifier.
    bearer_token_sending_methods Sequence[str]
    How to send token to the server.
    openid_provider_id str
    OAuth authorization server identifier.
    bearerTokenSendingMethods List<String>
    How to send token to the server.
    openidProviderId String
    OAuth authorization server identifier.

    ProvisioningState, ProvisioningStateArgs

    Created
    created
    ProvisioningStateCreated
    created
    Created
    created
    Created
    created
    CREATED
    created
    "created"
    created

    SubscriptionKeyParameterNamesContractResponse, SubscriptionKeyParameterNamesContractResponseArgs

    Header string
    Subscription key header name.
    Query string
    Subscription key query string parameter name.
    Header string
    Subscription key header name.
    Query string
    Subscription key query string parameter name.
    header String
    Subscription key header name.
    query String
    Subscription key query string parameter name.
    header string
    Subscription key header name.
    query string
    Subscription key query string parameter name.
    header str
    Subscription key header name.
    query str
    Subscription key query string parameter name.
    header String
    Subscription key header name.
    query String
    Subscription key query string parameter name.

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:apimanagement:GatewayApiEntityTag echo-api /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/apis/{apiId}

    To learn more about importing existing cloud resources, see Importing resources.

    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 v2 docs if using the v2 version of this package.
    Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
    pulumi/pulumi-azure-native