Docs Packages
  1. Packages
  2. Azure Native v1
  3. API Docs
  4. apimanagement
  5. ProductApi
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

azure-native.apimanagement.ProductApi

Explore with Pulumi AI

azure-native-v1 logo
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

    Api details. API Version: 2020-12-01.

    Example Usage

    ApiManagementCreateProductApi

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

return await Deployment.RunAsync(() => 
{
    var productApi = new AzureNative.ApiManagement.ProductApi("productApi", new()
    {
        ApiId = "echo-api",
        ProductId = "testproduct",
        ResourceGroupName = "rg1",
        ServiceName = "apimService1",
    });

});

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := apimanagement.NewProductApi(ctx, "productApi", &apimanagement.ProductApiArgs{
			ApiId:             pulumi.String("echo-api"),
			ProductId:         pulumi.String("testproduct"),
			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.ProductApi;
import com.pulumi.azurenative.apimanagement.ProductApiArgs;
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 productApi = new ProductApi("productApi", ProductApiArgs.builder()        
            .apiId("echo-api")
            .productId("testproduct")
            .resourceGroupName("rg1")
            .serviceName("apimService1")
            .build());

    }
}

    import pulumi
import pulumi_azure_native as azure_native

product_api = azure_native.apimanagement.ProductApi("productApi",
    api_id="echo-api",
    product_id="testproduct",
    resource_group_name="rg1",
    service_name="apimService1")

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

const productApi = new azure_native.apimanagement.ProductApi("productApi", {
    apiId: "echo-api",
    productId: "testproduct",
    resourceGroupName: "rg1",
    serviceName: "apimService1",
});

    resources:
  productApi:
    type: azure-native:apimanagement:ProductApi
    properties:
      apiId: echo-api
      productId: testproduct
      resourceGroupName: rg1
      serviceName: apimService1

    Create ProductApi Resource

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

    Constructor syntax

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

@overload
def ProductApi(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               product_id: Optional[str] = None,
               resource_group_name: Optional[str] = None,
               service_name: Optional[str] = None,
               api_id: Optional[str] = None)
    func NewProductApi(ctx *Context, name string, args ProductApiArgs, opts ...ResourceOption) (*ProductApi, error)
    public ProductApi(string name, ProductApiArgs args, CustomResourceOptions? opts = null)
    public ProductApi(String name, ProductApiArgs args)
public ProductApi(String name, ProductApiArgs args, CustomResourceOptions options)

    type: azure-native:apimanagement:ProductApi
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 ProductApiArgs
    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 ProductApiArgs
    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 ProductApiArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ProductApiArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ProductApiArgs
    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 productApiResource = new AzureNative.Apimanagement.ProductApi("productApiResource", new()
{
    ProductId = "string",
    ResourceGroupName = "string",
    ServiceName = "string",
    ApiId = "string",
});

    example, err := apimanagement.NewProductApi(ctx, "productApiResource", &apimanagement.ProductApiArgs{
	ProductId:         "string",
	ResourceGroupName: "string",
	ServiceName:       "string",
	ApiId:             "string",
})

    var productApiResource = new ProductApi("productApiResource", ProductApiArgs.builder()
    .productId("string")
    .resourceGroupName("string")
    .serviceName("string")
    .apiId("string")
    .build());

    product_api_resource = azure_native.apimanagement.ProductApi("productApiResource",
    product_id=string,
    resource_group_name=string,
    service_name=string,
    api_id=string)

    const productApiResource = new azure_native.apimanagement.ProductApi("productApiResource", {
    productId: "string",
    resourceGroupName: "string",
    serviceName: "string",
    apiId: "string",
});

    type: azure-native:apimanagement:ProductApi
properties:
    apiId: string
    productId: string
    resourceGroupName: string
    serviceName: string

    ProductApi Resource Properties

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

    Inputs

    The ProductApi resource accepts the following input properties:

    ProductId string
    Product identifier. Must be unique in the current API Management service instance.
    ResourceGroupName string
    The name of the resource group.
    ServiceName string
    The name of the API Management service.
    ApiId string
    API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
    ProductId string
    Product identifier. Must be unique in the current API Management service instance.
    ResourceGroupName string
    The name of the resource group.
    ServiceName string
    The name of the API Management service.
    ApiId string
    API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
    productId String
    Product identifier. Must be unique in the current API Management service instance.
    resourceGroupName String
    The name of the resource group.
    serviceName String
    The name of the API Management service.
    apiId String
    API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
    productId string
    Product identifier. Must be unique in the current API Management service instance.
    resourceGroupName string
    The name of the resource group.
    serviceName string
    The name of the API Management service.
    apiId string
    API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
    product_id str
    Product identifier. Must be unique in the current API Management service instance.
    resource_group_name str
    The name of the resource group.
    service_name str
    The name of the API Management service.
    api_id str
    API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
    productId String
    Product identifier. Must be unique in the current API Management service instance.
    resourceGroupName String
    The name of the resource group.
    serviceName String
    The name of the API Management service.
    apiId String
    API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    IsOnline bool
    Indicates if API revision is accessible via the gateway.
    Name string
    Resource name.
    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
    Resource type for API Management resource.
    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.
    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.
    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.
    Id string
    The provider-assigned unique ID for this managed resource.
    IsOnline bool
    Indicates if API revision is accessible via the gateway.
    Name string
    Resource name.
    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
    Resource type for API Management resource.
    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.
    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.
    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.
    id String
    The provider-assigned unique ID for this managed resource.
    isOnline Boolean
    Indicates if API revision is accessible via the gateway.
    name String
    Resource name.
    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
    Resource type for API Management resource.
    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.
    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.
    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.
    id string
    The provider-assigned unique ID for this managed resource.
    isOnline boolean
    Indicates if API revision is accessible via the gateway.
    name string
    Resource name.
    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
    Resource type for API Management resource.
    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.
    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.
    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.
    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
    Resource name.
    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
    Resource type for API Management resource.
    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.
    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.
    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.
    id String
    The provider-assigned unique ID for this managed resource.
    isOnline Boolean
    Indicates if API revision is accessible via the gateway.
    name String
    Resource name.
    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
    Resource type for API Management resource.
    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.
    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.
    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.

    Supporting Types

    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
    Openid OpenIdAuthenticationSettingsContractResponse
    OpenID Connect Authentication Settings
    oAuth2 OAuth2AuthenticationSettingsContractResponse
    OAuth2 Authentication settings
    openid OpenIdAuthenticationSettingsContractResponse
    OpenID Connect Authentication Settings
    oAuth2 OAuth2AuthenticationSettingsContractResponse
    OAuth2 Authentication settings
    openid OpenIdAuthenticationSettingsContractResponse
    OpenID Connect Authentication Settings
    o_auth2 OAuth2AuthenticationSettingsContractResponse
    OAuth2 Authentication settings
    openid OpenIdAuthenticationSettingsContractResponse
    OpenID Connect Authentication Settings
    oAuth2 Property Map
    OAuth2 Authentication settings
    openid Property Map
    OpenID Connect Authentication Settings

    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.

    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:ProductApi 5931a75ae4bbd512a88c680b /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5931a75ae4bbd512a88c680b

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

    Package Details

    Repository
    azure-native-v1 pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native-v1 logo
    These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
    Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
    pulumi/pulumi-azure-native