@datafire/azure_apimanagement_apimproducts

v5.0.0

Published

2 years ago

DataFire integration for ApiManagementClient

Downloads

0High
0Medium
0Low

datafire

@datafire/azure_apimanagement_apimproducts

Client library for ApiManagementClient

Installation and Usage

npm install --save @datafire/azure_apimanagement_apimproducts

let azure_apimanagement_apimproducts = require('@datafire/azure_apimanagement_apimproducts').create({
  access_token: "",
  refresh_token: "",
  client_id: "",
  client_secret: "",
  redirect_uri: ""
});

.then(data => {
  console.log(data);
});

Description

Use these REST APIs for performing operations on Product entity associated with your Azure API Management deployment. The Product entity represents a product in API Management. Products include one or more APIs and their associated terms of use. Once a product is published, developers can subscribe to the product and begin to use the product’s APIs.

Actions

Product_ListByService

Lists a collection of products in the specified service instance.

azure_apimanagement_apimproducts.Product_ListByService({
  "resourceGroupName": "",
  "serviceName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- serviceName required string: The name of the API Management service.
- $filter string: | Field | Usage | Supported operators | Supported functions ||-------------|-------------|-------------|-------------|| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | terms | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | state | filter | eq | | | groups | expand | | |
- $top integer: Number of records to return.
- $skip integer: Number of records to skip.
- expandGroups boolean: When set to true, the response contains an array of groups that have visibility to the product. The default is false.
- tags string: Products which are part of a specific tag.
- api-version required string: Version of the API to be used with the client request.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output object: Paged Products list representation.
- nextLink string: Next page link if any.
- value array: Page values.
  - items object: Product details.
    - properties object: Product profile.
      - displayName required string: Product name.
      - approvalRequired boolean: whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of true.
      - description string: Product description. May include HTML formatting tags.
      - state string (values: notPublished, published): whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is notPublished.
      - subscriptionRequired boolean: Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as "protected" and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as "open" and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it's value is assumed to be true.
      - subscriptionsLimit integer: Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of true.
      - terms string: Product terms of use. Developers trying to subscribe to the product will be presented and required to accept these terms before they can complete the subscription process.
    - id string: Resource ID.
    - name string: Resource name.
    - type string: Resource type for API Management resource.

Product_Delete

Delete product.

azure_apimanagement_apimproducts.Product_Delete({
  "resourceGroupName": "",
  "serviceName": "",
  "productId": "",
  "If-Match": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- serviceName required string: The name of the API Management service.
- productId required string: Product identifier. Must be unique in the current API Management service instance.
- If-Match required string: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
- deleteSubscriptions boolean: Delete existing subscriptions associated with the product or not.
- api-version required string: Version of the API to be used with the client request.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

Product_Get

Gets the details of the product specified by its identifier.

azure_apimanagement_apimproducts.Product_Get({
  "resourceGroupName": "",
  "serviceName": "",
  "productId": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- serviceName required string: The name of the API Management service.
- productId required string: Product identifier. Must be unique in the current API Management service instance.
- api-version required string: Version of the API to be used with the client request.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output object: Product details.
- properties object: Product profile.
  - displayName required string: Product name.
  - approvalRequired boolean: whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of true.
  - description string: Product description. May include HTML formatting tags.
  - state string (values: notPublished, published): whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is notPublished.
  - subscriptionRequired boolean: Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as "protected" and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as "open" and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it's value is assumed to be true.
  - subscriptionsLimit integer: Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of true.
  - terms string: Product terms of use. Developers trying to subscribe to the product will be presented and required to accept these terms before they can complete the subscription process.
- id string: Resource ID.
- name string: Resource name.
- type string: Resource type for API Management resource.

Product_GetEntityTag

Gets the entity state (Etag) version of the product specified by its identifier.

azure_apimanagement_apimproducts.Product_GetEntityTag({
  "resourceGroupName": "",
  "serviceName": "",
  "productId": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- serviceName required string: The name of the API Management service.
- productId required string: Product identifier. Must be unique in the current API Management service instance.
- api-version required string: Version of the API to be used with the client request.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

Product_Update

Update existing product details.

azure_apimanagement_apimproducts.Product_Update({
  "resourceGroupName": "",
  "serviceName": "",
  "productId": "",
  "parameters": null,
  "If-Match": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- serviceName required string: The name of the API Management service.
- productId required string: Product identifier. Must be unique in the current API Management service instance.
- parameters required object: Product Update parameters.
  - properties object: Parameters supplied to the Update Product operation.
    - displayName string: Product name.
    - approvalRequired boolean: whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of true.
    - description string: Product description. May include HTML formatting tags.
    - state string (values: notPublished, published): whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is notPublished.
    - subscriptionRequired boolean: Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as "protected" and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as "open" and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it's value is assumed to be true.
    - subscriptionsLimit integer: Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of true.
    - terms string: Product terms of use. Developers trying to subscribe to the product will be presented and required to accept these terms before they can complete the subscription process.
- If-Match required string: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
- api-version required string: Version of the API to be used with the client request.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

Product_CreateOrUpdate

Creates or Updates a product.

azure_apimanagement_apimproducts.Product_CreateOrUpdate({
  "resourceGroupName": "",
  "serviceName": "",
  "productId": "",
  "parameters": null,
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- serviceName required string: The name of the API Management service.
- productId required string: Product identifier. Must be unique in the current API Management service instance.
- parameters required object: Product details.
  - properties object: Product profile.
    - displayName required string: Product name.
    - approvalRequired boolean: whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of true.
    - description string: Product description. May include HTML formatting tags.
    - state string (values: notPublished, published): whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is notPublished.
    - subscriptionRequired boolean: Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as "protected" and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as "open" and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it's value is assumed to be true.
    - subscriptionsLimit integer: Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of true.
    - terms string: Product terms of use. Developers trying to subscribe to the product will be presented and required to accept these terms before they can complete the subscription process.
  - id string: Resource ID.
  - name string: Resource name.
  - type string: Resource type for API Management resource.
- If-Match string: ETag of the Entity. Not required when creating an entity, but required when updating an entity.
- api-version required string: Version of the API to be used with the client request.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output object: Product details.
- properties object: Product profile.
  - displayName required string: Product name.
  - approvalRequired boolean: whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of true.
  - description string: Product description. May include HTML formatting tags.
  - state string (values: notPublished, published): whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is notPublished.
  - subscriptionRequired boolean: Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as "protected" and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as "open" and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it's value is assumed to be true.
  - subscriptionsLimit integer: Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of true.
  - terms string: Product terms of use. Developers trying to subscribe to the product will be presented and required to accept these terms before they can complete the subscription process.
- id string: Resource ID.
- name string: Resource name.
- type string: Resource type for API Management resource.

ProductApi_ListByProduct

Lists a collection of the APIs associated with a product.

azure_apimanagement_apimproducts.ProductApi_ListByProduct({
  "resourceGroupName": "",
  "serviceName": "",
  "productId": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- serviceName required string: The name of the API Management service.
- productId required string: Product identifier. Must be unique in the current API Management service instance.
- $filter string: | Field | Usage | Supported operators | Supported functions ||-------------|-------------|-------------|-------------|| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | serviceUrl | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | path | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
- $top integer: Number of records to return.
- $skip integer: Number of records to skip.
- api-version required string: Version of the API to be used with the client request.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output object: Paged Api list representation.
- nextLink string: Next page link if any.
- value array: Page values.
  - items object: Api details.
    - properties object: Api Entity Properties
      - apiVersionSet object: An API Version Set contains the common configuration for a set of API Versions relating
        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 (values: Segment, Query, Header): An value that determines where the API Version identifer will be located in a HTTP request.
      - displayName string: API name. Must be 1 to 300 characters long.
      - path required 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 array: Describes on which protocols the operations in this API can be invoked.
        items string (values: http, https)
      - 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.
      - 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.
      - apiVersion string: Indicates the Version identifier of the API if the API is versioned
      - apiVersionDescription string: Description of the Api Version.
      - apiVersionSetId string: A resource identifier for the related ApiVersionSet.
      - authenticationSettings object: API Authentication Settings.
        oAuth2 object: API OAuth2 Authentication settings details.
        openid object: API OAuth2 Authentication settings details.
      - description string: Description of the API. May include HTML formatting tags.
      - isCurrent boolean: Indicates if API revision is current api revision.
      - isOnline boolean: Indicates if API revision is accessible via the gateway.
      - subscriptionKeyParameterNames object: Subscription key parameter names details.
        header string: Subscription key header name.
        query string: Subscription key query string parameter name.
      - subscriptionRequired boolean: Specifies whether an API or Product subscription is required for accessing the API.
      - type string (values: http, soap): Type of API.
    - id string: Resource ID.
    - name string: Resource name.
    - type string: Resource type for API Management resource.

ProductApi_Delete

Deletes the specified API from the specified product.

azure_apimanagement_apimproducts.ProductApi_Delete({
  "resourceGroupName": "",
  "serviceName": "",
  "productId": "",
  "apiId": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- serviceName required string: The name of the API Management service.
- productId required string: Product identifier. Must be unique in the current API Management service instance.
- apiId required 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.
- api-version required string: Version of the API to be used with the client request.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

ProductApi_CheckEntityExists

Checks that API entity specified by identifier is associated with the Product entity.

azure_apimanagement_apimproducts.ProductApi_CheckEntityExists({
  "resourceGroupName": "",
  "serviceName": "",
  "productId": "",
  "apiId": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- serviceName required string: The name of the API Management service.
- productId required string: Product identifier. Must be unique in the current API Management service instance.
- apiId required 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.
- api-version required string: Version of the API to be used with the client request.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

ProductApi_CreateOrUpdate

Adds an API to the specified product.

azure_apimanagement_apimproducts.ProductApi_CreateOrUpdate({
  "resourceGroupName": "",
  "serviceName": "",
  "productId": "",
  "apiId": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- serviceName required string: The name of the API Management service.
- productId required string: Product identifier. Must be unique in the current API Management service instance.
- apiId required 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.
- api-version required string: Version of the API to be used with the client request.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output object: Api details.
- properties object: Api Entity Properties
  - apiVersionSet object: An API Version Set contains the common configuration for a set of API Versions relating
    - 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 (values: Segment, Query, Header): An value that determines where the API Version identifer will be located in a HTTP request.
  - displayName string: API name. Must be 1 to 300 characters long.
  - path required 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 array: Describes on which protocols the operations in this API can be invoked.
    - items string (values: http, https)
  - 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.
  - 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.
  - apiVersion string: Indicates the Version identifier of the API if the API is versioned
  - apiVersionDescription string: Description of the Api Version.
  - apiVersionSetId string: A resource identifier for the related ApiVersionSet.
  - authenticationSettings object: API Authentication Settings.
    - oAuth2 object: API OAuth2 Authentication settings details.
      - authorizationServerId string: OAuth authorization server identifier.
      - scope string: operations scope.
    - openid object: API OAuth2 Authentication settings details.
      - bearerTokenSendingMethods array: How to send token to the server.
        items string (values: authorizationHeader, query): Form of an authorization grant, which the client uses to request the access token.
      - openidProviderId string: OAuth authorization server identifier.
  - description string: Description of the API. May include HTML formatting tags.
  - isCurrent boolean: Indicates if API revision is current api revision.
  - isOnline boolean: Indicates if API revision is accessible via the gateway.
  - subscriptionKeyParameterNames object: Subscription key parameter names details.
    - header string: Subscription key header name.
    - query string: Subscription key query string parameter name.
  - subscriptionRequired boolean: Specifies whether an API or Product subscription is required for accessing the API.
  - type string (values: http, soap): Type of API.
- id string: Resource ID.
- name string: Resource name.
- type string: Resource type for API Management resource.

ProductGroup_ListByProduct

Lists the collection of developer groups associated with the specified product.

azure_apimanagement_apimproducts.ProductGroup_ListByProduct({
  "resourceGroupName": "",
  "serviceName": "",
  "productId": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- serviceName required string: The name of the API Management service.
- productId required string: Product identifier. Must be unique in the current API Management service instance.
- $filter string: | Field | Usage | Supported operators | Supported functions ||-------------|-------------|-------------|-------------|| name | filter | ge, le, eq, ne, gt, lt | | | displayName | filter | eq, ne | | | description | filter | eq, ne | |
- $top integer: Number of records to return.
- $skip integer: Number of records to skip.
- api-version required string: Version of the API to be used with the client request.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output object: Paged Group list representation.
- nextLink string: Next page link if any.
- value array: Page values.
  - items object: Contract details.
    - properties object: Group contract Properties.
      - builtIn boolean: true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false.
      - description string: Group description. Can contain HTML formatting tags.
      - displayName required string: Group name.
      - externalId string: For external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; otherwise the value is null.
      - type string (values: custom, system, external): Group type.
    - id string: Resource ID.
    - name string: Resource name.
    - type string: Resource type for API Management resource.

ProductGroup_Delete

Deletes the association between the specified group and product.

azure_apimanagement_apimproducts.ProductGroup_Delete({
  "resourceGroupName": "",
  "serviceName": "",
  "productId": "",
  "groupId": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- serviceName required string: The name of the API Management service.
- productId required string: Product identifier. Must be unique in the current API Management service instance.
- groupId required string: Group identifier. Must be unique in the current API Management service instance.
- api-version required string: Version of the API to be used with the client request.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

ProductGroup_CheckEntityExists

Checks that Group entity specified by identifier is associated with the Product entity.

azure_apimanagement_apimproducts.ProductGroup_CheckEntityExists({
  "resourceGroupName": "",
  "serviceName": "",
  "productId": "",
  "groupId": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- serviceName required string: The name of the API Management service.
- productId required string: Product identifier. Must be unique in the current API Management service instance.
- groupId required string: Group identifier. Must be unique in the current API Management service instance.
- api-version required string: Version of the API to be used with the client request.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

ProductGroup_CreateOrUpdate

Adds the association between the specified developer group with the specified product.

azure_apimanagement_apimproducts.ProductGroup_CreateOrUpdate({
  "resourceGroupName": "",
  "serviceName": "",
  "productId": "",
  "groupId": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- serviceName required string: The name of the API Management service.
- productId required string: Product identifier. Must be unique in the current API Management service instance.
- groupId required string: Group identifier. Must be unique in the current API Management service instance.
- api-version required string: Version of the API to be used with the client request.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output object: Contract details.
- properties object: Group contract Properties.
  - builtIn boolean: true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false.
  - description string: Group description. Can contain HTML formatting tags.
  - displayName required string: Group name.
  - externalId string: For external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; otherwise the value is null.
  - type string (values: custom, system, external): Group type.
- id string: Resource ID.
- name string: Resource name.
- type string: Resource type for API Management resource.

ProductPolicy_ListByProduct

Get the policy configuration at the Product level.

azure_apimanagement_apimproducts.ProductPolicy_ListByProduct({
  "resourceGroupName": "",
  "serviceName": "",
  "productId": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- serviceName required string: The name of the API Management service.
- productId required string: Product identifier. Must be unique in the current API Management service instance.
- api-version required string: Version of the API to be used with the client request.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output object: The response of the list policy operation.
- nextLink string: Next page link if any.
- value array: Policy Contract value.
  - items object: Policy Contract details.
    - properties object: Policy contract Properties.
      - format string (values: xml, xml-link, rawxml, rawxml-link): Format of the policyContent.
      - value required string: Contents of the Policy as defined by the format.
    - id string: Resource ID.
    - name string: Resource name.
    - type string: Resource type for API Management resource.

ProductPolicy_Delete

Deletes the policy configuration at the Product.

azure_apimanagement_apimproducts.ProductPolicy_Delete({
  "resourceGroupName": "",
  "serviceName": "",
  "productId": "",
  "policyId": "",
  "If-Match": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- serviceName required string: The name of the API Management service.
- productId required string: Product identifier. Must be unique in the current API Management service instance.
- policyId required string (values: policy): The identifier of the Policy.
- If-Match required string: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
- api-version required string: Version of the API to be used with the client request.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

ProductPolicy_Get

Get the policy configuration at the Product level.

azure_apimanagement_apimproducts.ProductPolicy_Get({
  "resourceGroupName": "",
  "serviceName": "",
  "productId": "",
  "policyId": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- serviceName required string: The name of the API Management service.
- productId required string: Product identifier. Must be unique in the current API Management service instance.
- policyId required string (values: policy): The identifier of the Policy.
- format string (values: xml, rawxml): Policy Export Format.
- api-version required string: Version of the API to be used with the client request.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output object: Policy Contract details.
- properties object: Policy contract Properties.
  - format string (values: xml, xml-link, rawxml, rawxml-link): Format of the policyContent.
  - value required string: Contents of the Policy as defined by the format.
- id string: Resource ID.
- name string: Resource name.
- type string: Resource type for API Management resource.

ProductPolicy_GetEntityTag

Get the ETag of the policy configuration at the Product level.

azure_apimanagement_apimproducts.ProductPolicy_GetEntityTag({
  "resourceGroupName": "",
  "serviceName": "",
  "productId": "",
  "policyId": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- serviceName required string: The name of the API Management service.
- productId required string: Product identifier. Must be unique in the current API Management service instance.
- policyId required string (values: policy): The identifier of the Policy.
- api-version required string: Version of the API to be used with the client request.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

ProductPolicy_CreateOrUpdate

Creates or updates policy configuration for the Product.

azure_apimanagement_apimproducts.ProductPolicy_CreateOrUpdate({
  "resourceGroupName": "",
  "serviceName": "",
  "productId": "",
  "policyId": "",
  "parameters": null,
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- serviceName required string: The name of the API Management service.
- productId required string: Product identifier. Must be unique in the current API Management service instance.
- policyId required string (values: policy): The identifier of the Policy.
- If-Match string: ETag of the Entity. Not required when creating an entity, but required when updating an entity.
- parameters required object: Policy Contract details.
  - properties object: Policy contract Properties.
    - format string (values: xml, xml-link, rawxml, rawxml-link): Format of the policyContent.
    - value required string: Contents of the Policy as defined by the format.
  - id string: Resource ID.
  - name string: Resource name.
  - type string: Resource type for API Management resource.
- api-version required string: Version of the API to be used with the client request.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output object: Policy Contract details.
- properties object: Policy contract Properties.
  - format string (values: xml, xml-link, rawxml, rawxml-link): Format of the policyContent.
  - value required string: Contents of the Policy as defined by the format.
- id string: Resource ID.
- name string: Resource name.
- type string: Resource type for API Management resource.

ProductSubscriptions_List

Lists the collection of subscriptions to the specified product.

azure_apimanagement_apimproducts.ProductSubscriptions_List({
  "resourceGroupName": "",
  "serviceName": "",
  "productId": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- serviceName required string: The name of the API Management service.
- productId required string: Product identifier. Must be unique in the current API Management service instance.
- $filter string: | Field | Usage | Supported operators | Supported functions ||-------------|-------------|-------------|-------------|| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | stateComment | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | ownerId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | scope | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | userId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | productId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | state | filter | eq | | | user | expand | | |
- $top integer: Number of records to return.
- $skip integer: Number of records to skip.
- api-version required string: Version of the API to be used with the client request.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output object: Paged Subscriptions list representation.
- nextLink string: Next page link if any.
- value array: Page values.
  - items object: Subscription details.
    - properties object: Subscription details.
      - allowTracing boolean: Determines whether tracing is enabled
      - createdDate string: Subscription creation date. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
      - displayName string: The name of the subscription, or null if the subscription has no name.
      - endDate string: Date when subscription was cancelled or expired. The setting is for audit purposes only and the subscription is not automatically cancelled. The subscription lifecycle can be managed by using the state property. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
      - expirationDate string: Subscription expiration date. The setting is for audit purposes only and the subscription is not automatically expired. The subscription lifecycle can be managed by using the state property. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
      - notificationDate string: Upcoming subscription expiration notification date. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
      - ownerId string: The user resource identifier of the subscription owner. The value is a valid relative URL in the format of /users/{userId} where {userId} is a user identifier.
      - primaryKey string: Subscription primary key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.
      - scope required string: Scope like /products/{productId} or /apis or /apis/{apiId}.
      - secondaryKey string: Subscription secondary key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.
      - startDate string: Subscription activation date. The setting is for audit purposes only and the subscription is not automatically activated. The subscription lifecycle can be managed by using the state property. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
      - state required string (values: suspended, active, expired, submitted, rejected, cancelled): Subscription state. Possible states are * active – the subscription is active, * suspended – the subscription is blocked, and the subscriber cannot call any APIs of the product, * submitted – the subscription request has been made by the developer, but has not yet been approved or rejected, * rejected – the subscription request has been denied by an administrator, * cancelled – the subscription has been cancelled by the developer or administrator, * expired – the subscription reached its expiration date and was deactivated.
      - stateComment string: Optional subscription comment added by an administrator.
    - id string: Resource ID.
    - name string: Resource name.
    - type string: Resource type for API Management resource.

Tag_ListByProduct

Lists all Tags associated with the Product.

azure_apimanagement_apimproducts.Tag_ListByProduct({
  "resourceGroupName": "",
  "serviceName": "",
  "productId": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- serviceName required string: The name of the API Management service.
- productId required string: Product identifier. Must be unique in the current API Management service instance.
- $filter string: | Field | Usage | Supported operators | Supported functions ||-------------|-------------|-------------|-------------|| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
- $top integer: Number of records to return.
- $skip integer: Number of records to skip.
- api-version required string: Version of the API to be used with the client request.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output object: Paged Tag list representation.
- nextLink string: Next page link if any.
- value array: Page values.
  - items object: Tag Contract details.
    - properties object: Tag contract Properties.
      - displayName required string: Tag name.
    - id string: Resource ID.
    - name string: Resource name.
    - type string: Resource type for API Management resource.

Tag_DetachFromProduct

Detach the tag from the Product.

azure_apimanagement_apimproducts.Tag_DetachFromProduct({
  "resourceGroupName": "",
  "serviceName": "",
  "productId": "",
  "tagId": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- serviceName required string: The name of the API Management service.
- productId required string: Product identifier. Must be unique in the current API Management service instance.
- tagId required string: Tag identifier. Must be unique in the current API Management service instance.
- api-version required string: Version of the API to be used with the client request.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

Tag_GetByProduct

Get tag associated with the Product.

azure_apimanagement_apimproducts.Tag_GetByProduct({
  "resourceGroupName": "",
  "serviceName": "",
  "productId": "",
  "tagId": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- serviceName required string: The name of the API Management service.
- productId required string: Product identifier. Must be unique in the current API Management service instance.
- tagId required string: Tag identifier. Must be unique in the current API Management service instance.
- api-version required string: Version of the API to be used with the client request.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output object: Tag Contract details.
- properties object: Tag contract Properties.
  - displayName required string: Tag name.
- id string: Resource ID.
- name string: Resource name.
- type string: Resource type for API Management resource.

Tag_GetEntityStateByProduct

Gets the entity state version of the tag specified by its identifier.

azure_apimanagement_apimproducts.Tag_GetEntityStateByProduct({
  "resourceGroupName": "",
  "serviceName": "",
  "productId": "",
  "tagId": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- serviceName required string: The name of the API Management service.
- productId required string: Product identifier. Must be unique in the current API Management service instance.
- tagId required string: Tag identifier. Must be unique in the current API Management service instance.
- api-version required string: Version of the API to be used with the client request.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

Tag_AssignToProduct

Assign tag to the Product.

azure_apimanagement_apimproducts.Tag_AssignToProduct({
  "resourceGroupName": "",
  "serviceName": "",
  "productId": "",
  "tagId": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- serviceName required string: The name of the API Management service.
- productId required string: Product identifier. Must be unique in the current API Management service instance.
- tagId required string: Tag identifier. Must be unique in the current API Management service instance.
- api-version required string: Version of the API to be used with the client request.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output object: Tag Contract details.
- properties object: Tag contract Properties.
  - displayName required string: Tag name.
- id string: Resource ID.
- name string: Resource name.
- type string: Resource type for API Management resource.

Definitions

This integration has no definitions

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

@datafire/azure_apimanagement_apimproducts

Installation and Usage

Description

Actions

Product_ListByService

Input

Output

Product_Delete

Input

Output

Product_Get

Input

Output

Product_GetEntityTag

Input

Output

Product_Update

Input

Output

Product_CreateOrUpdate

Input

Output

ProductApi_ListByProduct

Input

Output

ProductApi_Delete

Input

Output

ProductApi_CheckEntityExists

Input

Output

ProductApi_CreateOrUpdate

Input

Output

ProductGroup_ListByProduct

Input

Output

ProductGroup_Delete

Input

Output

ProductGroup_CheckEntityExists

Input

Output

ProductGroup_CreateOrUpdate

Input

Output

ProductPolicy_ListByProduct

Input

Output

ProductPolicy_Delete

Input

Output

ProductPolicy_Get

Input

Output

ProductPolicy_GetEntityTag

Input

Output

ProductPolicy_CreateOrUpdate

Input

Output

ProductSubscriptions_List

Input

Output

Tag_ListByProduct

Input

Output

Tag_DetachFromProduct

Input

Output

Tag_GetByProduct

Input

Output

Tag_GetEntityStateByProduct