GradientEdge CDK Utils
    Preparing search index...

    Interface ApiManagementApiProps

    interface ApiManagementApiProps {
        apiId?: Input<string>;
        apiRevision?: Input<string>;
        apiRevisionDescription?: Input<string>;
        apiType?: Input<string>;
        apiVersion?: Input<string>;
        apiVersionDescription?: Input<string>;
        apiVersionSet?: Input<ApiVersionSetContractDetailsArgs>;
        apiVersionSetId?: Input<string>;
        authenticationSettings?: Input<AuthenticationSettingsContractArgs>;
        cacheSetInboundPolicy?: string;
        cacheSetOutboundPolicy?: string;
        commonInboundPolicyXml?: string;
        commonOutboundPolicyXml?: string;
        contact?: Input<ApiContactInformationArgs>;
        description?: Input<string>;
        displayName?: Input<string>;
        format?: Input<string>;
        isCurrent?: Input<boolean>;
        license?: Input<ApiLicenseInformationArgs>;
        operations: ApiManagementApiOperationProps[];
        path: Input<string>;
        protocols?: Input<Input<string>[]>;
        rateLimit?: ApiManagementApiRateLimit;
        resourceGroupName: Input<string>;
        serviceName: Input<string>;
        serviceUrl?: Input<string>;
        soapApiType?: Input<string>;
        sourceApiId?: Input<string>;
        subscriptionKeyParameterNames?: Input<
            SubscriptionKeyParameterNamesContractArgs,
        >;
        subscriptionRequired?: Input<boolean>;
        termsOfServiceUrl?: Input<string>;
        translateRequiredQueryParametersConduct?: Input<string>;
        value?: Input<string>;
        wsdlSelector?: Input<ApiCreateOrUpdatePropertiesWsdlSelectorArgs>;
    }

    Hierarchy

    • ApiArgs
      • ApiManagementApiProps
    Index

    Properties

    apiId? apiRevision? apiRevisionDescription? apiType? apiVersion? apiVersionDescription? apiVersionSet? apiVersionSetId? authenticationSettings? cacheSetInboundPolicy? cacheSetOutboundPolicy? commonInboundPolicyXml? commonOutboundPolicyXml? contact? description? displayName? format? isCurrent? license? operations path protocols? rateLimit? resourceGroupName serviceName serviceUrl? soapApiType? sourceApiId? subscriptionKeyParameterNames? subscriptionRequired? termsOfServiceUrl? translateRequiredQueryParametersConduct? value? wsdlSelector?

    Properties

    apiId?: Input<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.

    apiRevision?: Input<string>

    Describes the revision of the API. If no value is provided, default revision 1 is created

    apiRevisionDescription?: Input<string>

    Description of the API Revision.

    apiType?: Input<string>

    Type of API.

    apiVersion?: Input<string>

    Indicates the version identifier of the API if the API is versioned

    apiVersionDescription?: Input<string>

    Description of the API Version.

    apiVersionSet?: Input<ApiVersionSetContractDetailsArgs>

    Version set details

    apiVersionSetId?: Input<string>

    A resource identifier for the related ApiVersionSet.

    authenticationSettings?: Input<AuthenticationSettingsContractArgs>

    Collection of authentication settings included into this API.

    cacheSetInboundPolicy?: string
    cacheSetOutboundPolicy?: string
    commonInboundPolicyXml?: string
    commonOutboundPolicyXml?: string
    contact?: Input<ApiContactInformationArgs>

    Contact information for the API.

    description?: Input<string>

    Description of the API. May include HTML formatting tags.

    displayName?: Input<string>

    API name. Must be 1 to 300 characters long.

    format?: Input<string>

    Format of the Content in which the API is getting imported. New formats can be added in the future

    isCurrent?: Input<boolean>

    Indicates if API revision is current api revision.

    license?: Input<ApiLicenseInformationArgs>

    License information for the API.

    operations: ApiManagementApiOperationProps[]
    path: Input<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.

    protocols?: Input<Input<string>[]>

    Describes on which protocols the operations in this API can be invoked.

    rateLimit?: ApiManagementApiRateLimit
    resourceGroupName: Input<string>

    The name of the resource group. The name is case insensitive.

    serviceName: Input<string>

    The name of the API Management service.

    serviceUrl?: Input<string>

    Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long.

    soapApiType?: Input<string>

    Type of API to create.

    • http creates a REST API
    • soap creates a SOAP pass-through API
    • websocket creates websocket API
    • graphql creates GraphQL API. New types can be added in the future.
    sourceApiId?: Input<string>

    API identifier of the source API.

    subscriptionKeyParameterNames?: Input<SubscriptionKeyParameterNamesContractArgs>

    Protocols over which API is made available.

    subscriptionRequired?: Input<boolean>

    Specifies whether an API or Product subscription is required for accessing the API.

    termsOfServiceUrl?: Input<string>

    A URL to the Terms of Service for the API. MUST be in the format of a URL.

    translateRequiredQueryParametersConduct?: Input<string>

    Strategy of translating required query parameters to template ones. By default has value 'template'. Possible values: 'template', 'query'

    value?: Input<string>

    Content value when Importing an API.

    wsdlSelector?: Input<ApiCreateOrUpdatePropertiesWsdlSelectorArgs>

    Criteria to limit import of WSDL to a subset of the document.

    Settings

    Member Visibility

    On This Page

    Properties