{ "description": "Generator information:\n- Generated from: /apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/apimproducts.json\n- ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}", "properties": { "apiVersion": { "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources", "type": "string" }, "kind": { "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds", "type": "string" }, "metadata": { "type": "object" }, "spec": { "properties": { "approvalRequired": { "description": "ApprovalRequired: whether subscription approval is required. If false, new subscriptions will be approved automatically\nenabling developers to call the product\u2019s APIs immediately after subscribing. If true, administrators must manually\napprove the subscription before the developer can any of the product\u2019s APIs. Can be present only if\nsubscriptionRequired property is present and has a value of false.", "type": "boolean" }, "azureName": { "description": "AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it\ndoesn't have to be.", "maxLength": 256, "minLength": 1, "type": "string" }, "description": { "description": "Description: Product description. May include HTML formatting tags.", "maxLength": 1000, "minLength": 0, "type": "string" }, "displayName": { "description": "DisplayName: Product name.", "maxLength": 300, "minLength": 1, "type": "string" }, "operatorSpec": { "description": "OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not\npassed directly to Azure", "properties": { "configMapExpressions": { "description": "ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions).", "items": { "description": "DestinationExpression is a CEL expression and a destination to store the result in. The destination may\nbe a secret or a configmap. The value of the expression is stored at the specified location in\nthe destination.", "properties": { "key": { "description": "Key is the key in the ConfigMap or Secret being written to. If the CEL expression in Value returns a string\nthis is required to identify what key to write to. If the CEL expression in Value returns a map[string]string\nKey must not be set, instead the keys written will be determined dynamically based on the keys of the resulting\nmap[string]string.", "type": "string" }, "name": { "description": "Name is the name of the Kubernetes configmap or secret to write to.\nThe configmap or secret will be created in the same namespace as the resource.", "type": "string" }, "value": { "description": "Value is a CEL expression. The CEL expression may return a string or a map[string]string. For more information\non CEL in ASO see https://azure.github.io/azure-service-operator/guide/expressions/", "type": "string" } }, "required": [ "name", "value" ], "type": "object", "additionalProperties": false }, "type": "array" }, "secretExpressions": { "description": "SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions).", "items": { "description": "DestinationExpression is a CEL expression and a destination to store the result in. The destination may\nbe a secret or a configmap. The value of the expression is stored at the specified location in\nthe destination.", "properties": { "key": { "description": "Key is the key in the ConfigMap or Secret being written to. If the CEL expression in Value returns a string\nthis is required to identify what key to write to. If the CEL expression in Value returns a map[string]string\nKey must not be set, instead the keys written will be determined dynamically based on the keys of the resulting\nmap[string]string.", "type": "string" }, "name": { "description": "Name is the name of the Kubernetes configmap or secret to write to.\nThe configmap or secret will be created in the same namespace as the resource.", "type": "string" }, "value": { "description": "Value is a CEL expression. The CEL expression may return a string or a map[string]string. For more information\non CEL in ASO see https://azure.github.io/azure-service-operator/guide/expressions/", "type": "string" } }, "required": [ "name", "value" ], "type": "object", "additionalProperties": false }, "type": "array" } }, "type": "object", "additionalProperties": false }, "owner": { "description": "Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also\ncontrols the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a\nreference to a apimanagement.azure.com/Service resource", "properties": { "armId": { "pattern": "(?i)(^(/subscriptions/([^/]+)(/resourcegroups/([^/]+))?)?/providers/([^/]+)/([^/]+/[^/]+)(/([^/]+/[^/]+))*$|^/subscriptions/([^/]+)(/resourcegroups/([^/]+))?$)", "type": "string" }, "name": { "description": "This is the name of the Kubernetes resource to reference.", "type": "string" } }, "type": "object", "additionalProperties": false }, "state": { "description": "State: whether product is published or not. Published products are discoverable by users of developer portal. Non\npublished products are visible only to administrators. Default state of Product is notPublished.", "enum": [ "notPublished", "published" ], "type": "string" }, "subscriptionRequired": { "description": "SubscriptionRequired: Whether a product subscription is required for accessing APIs included in this product. If true,\nthe product is referred to as \"protected\" and a valid subscription key is required for a request to an API included in\nthe product to succeed. If false, the product is referred to as \"open\" and requests to an API included in the product\ncan be made without a subscription key. If property is omitted when creating a new product it's value is assumed to be\ntrue.", "type": "boolean" }, "subscriptionsLimit": { "description": "SubscriptionsLimit: Whether the number of subscriptions a user can have to this product at the same time. Set to null or\nomit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has\na value of false.", "type": "integer" }, "terms": { "description": "Terms: Product terms of use. Developers trying to subscribe to the product will be presented and required to accept\nthese terms before they can complete the subscription process.", "type": "string" } }, "required": [ "displayName", "owner" ], "type": "object", "additionalProperties": false }, "status": { "properties": { "approvalRequired": { "description": "ApprovalRequired: whether subscription approval is required. If false, new subscriptions will be approved automatically\nenabling developers to call the product\u2019s APIs immediately after subscribing. If true, administrators must manually\napprove the subscription before the developer can any of the product\u2019s APIs. Can be present only if\nsubscriptionRequired property is present and has a value of false.", "type": "boolean" }, "conditions": { "description": "Conditions: The observed state of the resource", "items": { "description": "Condition defines an extension to status (an observation) of a resource", "properties": { "lastTransitionTime": { "description": "LastTransitionTime is the last time the condition transitioned from one status to another.", "format": "date-time", "type": "string" }, "message": { "description": "Message is a human readable message indicating details about the transition. This field may be empty.", "type": "string" }, "observedGeneration": { "description": "ObservedGeneration is the .metadata.generation that the condition was set based upon. For instance, if\n.metadata.generation is currently 12, but the .status.condition[x].observedGeneration is 9, the condition is out of date\nwith respect to the current state of the instance.", "format": "int64", "type": "integer" }, "reason": { "description": "Reason for the condition's last transition.\nReasons are upper CamelCase (PascalCase) with no spaces. A reason is always provided, this field will not be empty.", "type": "string" }, "severity": { "description": "Severity with which to treat failures of this type of condition.\nFor conditions which have positive polarity (Status == True is their normal/healthy state), this will be omitted when Status == True\nFor conditions which have negative polarity (Status == False is their normal/healthy state), this will be omitted when Status == False.\nThis is omitted in all cases when Status == Unknown", "type": "string" }, "status": { "description": "Status of the condition, one of True, False, or Unknown.", "type": "string" }, "type": { "description": "Type of condition.", "type": "string" } }, "required": [ "lastTransitionTime", "reason", "status", "type" ], "type": "object", "additionalProperties": false }, "type": "array" }, "description": { "description": "Description: Product description. May include HTML formatting tags.", "type": "string" }, "displayName": { "description": "DisplayName: Product name.", "type": "string" }, "id": { "description": "Id: Fully qualified resource ID for the resource. Ex -\n/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}", "type": "string" }, "name": { "description": "Name: The name of the resource", "type": "string" }, "state": { "description": "State: whether product is published or not. Published products are discoverable by users of developer portal. Non\npublished products are visible only to administrators. Default state of Product is notPublished.", "type": "string" }, "subscriptionRequired": { "description": "SubscriptionRequired: Whether a product subscription is required for accessing APIs included in this product. If true,\nthe product is referred to as \"protected\" and a valid subscription key is required for a request to an API included in\nthe product to succeed. If false, the product is referred to as \"open\" and requests to an API included in the product\ncan be made without a subscription key. If property is omitted when creating a new product it's value is assumed to be\ntrue.", "type": "boolean" }, "subscriptionsLimit": { "description": "SubscriptionsLimit: Whether the number of subscriptions a user can have to this product at the same time. Set to null or\nomit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has\na value of false.", "type": "integer" }, "terms": { "description": "Terms: Product terms of use. Developers trying to subscribe to the product will be presented and required to accept\nthese terms before they can complete the subscription process.", "type": "string" }, "type": { "description": "Type: The type of the resource. E.g. \"Microsoft.Compute/virtualMachines\" or \"Microsoft.Storage/storageAccounts\"", "type": "string" } }, "type": "object", "additionalProperties": false } }, "type": "object" }