openapi-directory/api/azure.com/apimanagement-apimnamedvalues.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"description":"Use these REST APIs for performing operations on NamedValue entity associated with your Azure API Management deployment. API Management policies are a powerful capability of the system that allow the publisher to change the behavior of the API through configuration. Policies are a collection of statements that are executed sequentially on the request or response of an API. Policy statements can be constructed using literal text values, policy expressions, and NamedValues. Each API Management service instance has a NamedValues collection of key/value pairs that are global to the service instance. These NamedValues can be used to manage constant string values across all API configuration and policies.","title":"ApiManagementClient","version":"2019-12-01-preview","x-apisguru-categories":["cloud"],"x-logo":{"url":"https://assets.onestore.ms/cdnfiles/onestorerolling-1606-01000/shell/v3/images/logo/microsoft.png"},"x-origin":[{"format":"swagger","url":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2019-12-01-preview/apimnamedvalues.json","version":"2.0"}],"x-providerName":"azure.com","x-serviceName":"apimanagement-apimnamedvalues","x-tags":["Azure","Microsoft"]},"security":[{"azure_auth":["user_impersonation"]}],"paths":{"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/namedValues":{"get":{"description":"Lists a collection of NamedValues defined within a service instance.","externalDocs":{"url":"https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-properties"},"operationId":"NamedValue_ListByService","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementListNamedValues":{"value":"rg1"}}},{"description":"The name of the API Management service.","in":"path","name":"serviceName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":50,"pattern":"^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$"},"examples":{"ApiManagementListNamedValues":{"value":"apimService1"}}},{"description":"|   Field     |     Usage     |     Supported operators     |     Supported functions     |</br>|-------------|-------------|-------------|-------------|</br>| tags | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith, any, all | </br>| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>","in":"query","name":"$filter","required":false,"schema":{"type":"string"}},{"description":"Number of records to return.","in":"query","name":"$top","required":false,"x-ms-parameter-location":"method","schema":{"type":"integer","format":"int32","minimum":1}},{"description":"Number of records to skip.","in":"query","name":"$skip","required":false,"x-ms-parameter-location":"method","schema":{"type":"integer","format":"int32","minimum":0}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementListNamedValues":{"value":"2019-12-01-preview"}}},{"description":"Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"ApiManagementListNamedValues":{"value":"subid"}}}],"responses":{"200":{"description":"A Collection of the NamedValue entities for the specified API Management service instance.","content":{"application/json":{"schema":{"description":"Paged NamedValue list representation.","properties":{"nextLink":{"description":"Next page link if any.","type":"string"},"value":{"description":"Page values.","items":{"allOf":[{"description":"The Resource definition.","properties":{"id":{"description":"Resource ID.","readOnly":true,"type":"string"},"name":{"description":"Resource name.","readOnly":true,"type":"string"},"type":{"description":"Resource type for API Management resource.","readOnly":true,"type":"string"}},"x-ms-azure-resource":true}],"description":"NamedValue details.","properties":{"properties":{"allOf":[{"description":"NamedValue Entity Base Parameters set.","properties":{"secret":{"description":"Determines whether the value is a secret and should be encrypted or not. Default value is false.","type":"boolean"},"tags":{"description":"Optional tags that when provided can be used to filter the NamedValue list.","items":{"type":"string"},"maxItems":32,"type":"array"}}}],"description":"NamedValue Contract properties.","properties":{"displayName":{"description":"Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters.","maxLength":256,"minLength":1,"pattern":"^[A-Za-z0-9-._]+$","type":"string"},"value":{"description":"Value of the NamedValue. Can contain policy expressions. It may not be empty or consist only of whitespace. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.","maxLength":4096,"minLength":1,"type":"string"}},"required":["displayName"]}}},"type":"array"}}},"examples":{"ApiManagementListNamedValues":{"$ref":"#/components/examples/ApiManagementListNamedValues"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Error Response.","properties":{"error":{"description":"Error Body contract.","properties":{"code":{"description":"Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.","type":"string"},"details":{"description":"The list of invalid fields send in request, in case of validation error.","items":{"description":"Error Field contract.","properties":{"code":{"description":"Property level error code.","type":"string"},"message":{"description":"Human-readable representation of property-level error.","type":"string"},"target":{"description":"Property name.","type":"string"}}},"type":"array"},"message":{"description":"Human-readable representation of the error.","type":"string"}}}}}}}}},"tags":["NamedValue"],"x-ms-odata":"./definitions.json#/definitions/NamedValueContract","x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/namedValues/{namedValueId}":{"delete":{"description":"Deletes specific NamedValue from the API Management service instance.","operationId":"NamedValue_Delete","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementDeleteNamedValue":{"value":"rg1"}}},{"description":"The name of the API Management service.","in":"path","name":"serviceName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":50,"pattern":"^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$"},"examples":{"ApiManagementDeleteNamedValue":{"value":"apimService1"}}},{"description":"Identifier of the NamedValue.","in":"path","name":"namedValueId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","maxLength":256,"pattern":"^[^*#&+:<>?]+$"},"examples":{"ApiManagementDeleteNamedValue":{"value":"testprop2"}}},{"description":"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.","in":"header","name":"If-Match","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementDeleteNamedValue":{"value":"*"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementDeleteNamedValue":{"value":"2019-12-01-preview"}}},{"description":"Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"ApiManagementDeleteNamedValue":{"value":"subid"}}}],"responses":{"200":{"description":"NamedValue was successfully deleted."},"204":{"description":"NamedValue was successfully deleted."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Error Response.","properties":{"error":{"description":"Error Body contract.","properties":{"code":{"description":"Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.","type":"string"},"details":{"description":"The list of invalid fields send in request, in case of validation error.","items":{"description":"Error Field contract.","properties":{"code":{"description":"Property level error code.","type":"string"},"message":{"description":"Human-readable representation of property-level error.","type":"string"},"target":{"description":"Property name.","type":"string"}}},"type":"array"},"message":{"description":"Human-readable representation of the error.","type":"string"}}}}}}}}},"tags":["NamedValue"]},"get":{"description":"Gets the details of the NamedValue specified by its identifier.","operationId":"NamedValue_Get","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementGetNamedValue":{"value":"rg1"}}},{"description":"The name of the API Management service.","in":"path","name":"serviceName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":50,"pattern":"^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$"},"examples":{"ApiManagementGetNamedValue":{"value":"apimService1"}}},{"description":"Identifier of the NamedValue.","in":"path","name":"namedValueId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","maxLength":256,"pattern":"^[^*#&+:<>?]+$"},"examples":{"ApiManagementGetNamedValue":{"value":"testarmTemplateproperties2"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementGetNamedValue":{"value":"2019-12-01-preview"}}},{"description":"Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"ApiManagementGetNamedValue":{"value":"subid"}}}],"responses":{"200":{"description":"The response body contains the specified NamedValue entity.","headers":{"ETag":{"description":"Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"allOf":[{"description":"The Resource definition.","properties":{"id":{"description":"Resource ID.","readOnly":true,"type":"string"},"name":{"description":"Resource name.","readOnly":true,"type":"string"},"type":{"description":"Resource type for API Management resource.","readOnly":true,"type":"string"}},"x-ms-azure-resource":true}],"description":"NamedValue details.","properties":{"properties":{"allOf":[{"description":"NamedValue Entity Base Parameters set.","properties":{"secret":{"description":"Determines whether the value is a secret and should be encrypted or not. Default value is false.","type":"boolean"},"tags":{"description":"Optional tags that when provided can be used to filter the NamedValue list.","items":{"type":"string"},"maxItems":32,"type":"array"}}}],"description":"NamedValue Contract properties.","properties":{"displayName":{"description":"Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters.","maxLength":256,"minLength":1,"pattern":"^[A-Za-z0-9-._]+$","type":"string"},"value":{"description":"Value of the NamedValue. Can contain policy expressions. It may not be empty or consist only of whitespace. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.","maxLength":4096,"minLength":1,"type":"string"}},"required":["displayName"]}}},"examples":{"ApiManagementGetNamedValue":{"$ref":"#/components/examples/ApiManagementGetNamedValue"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Error Response.","properties":{"error":{"description":"Error Body contract.","properties":{"code":{"description":"Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.","type":"string"},"details":{"description":"The list of invalid fields send in request, in case of validation error.","items":{"description":"Error Field contract.","properties":{"code":{"description":"Property level error code.","type":"string"},"message":{"description":"Human-readable representation of property-level error.","type":"string"},"target":{"description":"Property name.","type":"string"}}},"type":"array"},"message":{"description":"Human-readable representation of the error.","type":"string"}}}}}}}}},"tags":["NamedValue"]},"head":{"description":"Gets the entity state (Etag) version of the NamedValue specified by its identifier.","operationId":"NamedValue_GetEntityTag","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementHeadNamedValue":{"value":"rg1"}}},{"description":"The name of the API Management service.","in":"path","name":"serviceName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":50,"pattern":"^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$"},"examples":{"ApiManagementHeadNamedValue":{"value":"apimService1"}}},{"description":"Identifier of the NamedValue.","in":"path","name":"namedValueId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","maxLength":256,"pattern":"^[^*#&+:<>?]+$"},"examples":{"ApiManagementHeadNamedValue":{"value":"testarmTemplateproperties2"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementHeadNamedValue":{"value":"2019-12-01-preview"}}},{"description":"Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"ApiManagementHeadNamedValue":{"value":"subid"}}}],"responses":{"200":{"description":"Specified NamedValue entity exists and current entity state version is present in the ETag header.","headers":{"ETag":{"description":"Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.","schema":{"type":"string"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Error Response.","properties":{"error":{"description":"Error Body contract.","properties":{"code":{"description":"Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.","type":"string"},"details":{"description":"The list of invalid fields send in request, in case of validation error.","items":{"description":"Error Field contract.","properties":{"code":{"description":"Property level error code.","type":"string"},"message":{"description":"Human-readable representation of property-level error.","type":"string"},"target":{"description":"Property name.","type":"string"}}},"type":"array"},"message":{"description":"Human-readable representation of the error.","type":"string"}}}}}}}}},"tags":["NamedValue"]},"patch":{"description":"Updates the specific NamedValue.","operationId":"NamedValue_Update","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementUpdateNamedValue":{"value":"rg1"}}},{"description":"The name of the API Management service.","in":"path","name":"serviceName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":50,"pattern":"^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$"},"examples":{"ApiManagementUpdateNamedValue":{"value":"apimService1"}}},{"description":"Identifier of the NamedValue.","in":"path","name":"namedValueId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","maxLength":256,"pattern":"^[^*#&+:<>?]+$"},"examples":{"ApiManagementUpdateNamedValue":{"value":"testprop2"}}},{"description":"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.","in":"header","name":"If-Match","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementUpdateNamedValue":{"value":"*"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementUpdateNamedValue":{"value":"2019-12-01-preview"}}},{"description":"Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"ApiManagementUpdateNamedValue":{"value":"subid"}}}],"requestBody":{"content":{"application/json":{"schema":{"description":"NamedValue update Parameters.","properties":{"properties":{"allOf":[{"description":"NamedValue Entity Base Parameters set.","properties":{"secret":{"description":"Determines whether the value is a secret and should be encrypted or not. Default value is false.","type":"boolean"},"tags":{"description":"Optional tags that when provided can be used to filter the NamedValue list.","items":{"type":"string"},"maxItems":32,"type":"array"}}}],"description":"NamedValue Contract properties.","properties":{"displayName":{"description":"Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters.","maxLength":256,"minLength":1,"pattern":"^[A-Za-z0-9-._]+$","type":"string"},"value":{"description":"Value of the NamedValue. Can contain policy expressions. It may not be empty or consist only of whitespace.","maxLength":4096,"minLength":1,"type":"string"}}}}}}},"description":"Update parameters.","required":true},"responses":{"200":{"description":"NamedValue was successfully updated.","headers":{"ETag":{"description":"Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"allOf":[{"description":"The Resource definition.","properties":{"id":{"description":"Resource ID.","readOnly":true,"type":"string"},"name":{"description":"Resource name.","readOnly":true,"type":"string"},"type":{"description":"Resource type for API Management resource.","readOnly":true,"type":"string"}},"x-ms-azure-resource":true}],"description":"NamedValue details.","properties":{"properties":{"allOf":[{"description":"NamedValue Entity Base Parameters set.","properties":{"secret":{"description":"Determines whether the value is a secret and should be encrypted or not. Default value is false.","type":"boolean"},"tags":{"description":"Optional tags that when provided can be used to filter the NamedValue list.","items":{"type":"string"},"maxItems":32,"type":"array"}}}],"description":"NamedValue Contract properties.","properties":{"displayName":{"description":"Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters.","maxLength":256,"minLength":1,"pattern":"^[A-Za-z0-9-._]+$","type":"string"},"value":{"description":"Value of the NamedValue. Can contain policy expressions. It may not be empty or consist only of whitespace. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.","maxLength":4096,"minLength":1,"type":"string"}},"required":["displayName"]}}},"examples":{"ApiManagementUpdateNamedValue":{"$ref":"#/components/examples/ApiManagementUpdateNamedValue"}}}}},"202":{"description":"Request to update NamedValue was accepted. Location header contains the URL where the status of the long running operation can be checked."},"204":{"description":"NamedValue was successfully updated."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Error Response.","properties":{"error":{"description":"Error Body contract.","properties":{"code":{"description":"Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.","type":"string"},"details":{"description":"The list of invalid fields send in request, in case of validation error.","items":{"description":"Error Field contract.","properties":{"code":{"description":"Property level error code.","type":"string"},"message":{"description":"Human-readable representation of property-level error.","type":"string"},"target":{"description":"Property name.","type":"string"}}},"type":"array"},"message":{"description":"Human-readable representation of the error.","type":"string"}}}}}}}}},"tags":["NamedValue"],"x-ms-long-running-operation":true,"x-ms-long-running-operation-options":{"final-state-via":"location"}},"put":{"description":"Creates or updates a NamedValue.","operationId":"NamedValue_CreateOrUpdate","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementCreateNamedValue":{"value":"rg1"}}},{"description":"The name of the API Management service.","in":"path","name":"serviceName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":50,"pattern":"^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$"},"examples":{"ApiManagementCreateNamedValue":{"value":"apimService1"}}},{"description":"Identifier of the NamedValue.","in":"path","name":"namedValueId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","maxLength":256,"pattern":"^[^*#&+:<>?]+$"},"examples":{"ApiManagementCreateNamedValue":{"value":"testprop2"}}},{"description":"ETag of the Entity. Not required when creating an entity, but required when updating an entity.","in":"header","name":"If-Match","required":false,"x-ms-parameter-location":"method","schema":{"type":"string"}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementCreateNamedValue":{"value":"2019-12-01-preview"}}},{"description":"Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"ApiManagementCreateNamedValue":{"value":"subid"}}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"description":"The Resource definition.","properties":{"id":{"description":"Resource ID.","readOnly":true,"type":"string"},"name":{"description":"Resource name.","readOnly":true,"type":"string"},"type":{"description":"Resource type for API Management resource.","readOnly":true,"type":"string"}},"x-ms-azure-resource":true}],"description":"NamedValue details.","properties":{"properties":{"allOf":[{"description":"NamedValue Entity Base Parameters set.","properties":{"secret":{"description":"Determines whether the value is a secret and should be encrypted or not. Default value is false.","type":"boolean"},"tags":{"description":"Optional tags that when provided can be used to filter the NamedValue list.","items":{"type":"string"},"maxItems":32,"type":"array"}}}],"description":"NamedValue Contract properties.","properties":{"displayName":{"description":"Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters.","maxLength":256,"minLength":1,"pattern":"^[A-Za-z0-9-._]+$","type":"string"},"value":{"description":"Value of the NamedValue. Can contain policy expressions. It may not be empty or consist only of whitespace. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.","maxLength":4096,"minLength":1,"type":"string"}},"required":["displayName","value"]}}}}},"description":"Create parameters.","required":true},"responses":{"200":{"description":"NamedValue was successfully updated.","headers":{"ETag":{"description":"Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"allOf":[{"description":"The Resource definition.","properties":{"id":{"description":"Resource ID.","readOnly":true,"type":"string"},"name":{"description":"Resource name.","readOnly":true,"type":"string"},"type":{"description":"Resource type for API Management resource.","readOnly":true,"type":"string"}},"x-ms-azure-resource":true}],"description":"NamedValue details.","properties":{"properties":{"allOf":[{"description":"NamedValue Entity Base Parameters set.","properties":{"secret":{"description":"Determines whether the value is a secret and should be encrypted or not. Default value is false.","type":"boolean"},"tags":{"description":"Optional tags that when provided can be used to filter the NamedValue list.","items":{"type":"string"},"maxItems":32,"type":"array"}}}],"description":"NamedValue Contract properties.","properties":{"displayName":{"description":"Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters.","maxLength":256,"minLength":1,"pattern":"^[A-Za-z0-9-._]+$","type":"string"},"value":{"description":"Value of the NamedValue. Can contain policy expressions. It may not be empty or consist only of whitespace. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.","maxLength":4096,"minLength":1,"type":"string"}},"required":["displayName"]}}},"examples":{"ApiManagementCreateNamedValue":{"$ref":"#/components/examples/ApiManagementCreateNamedValue"}}}}},"201":{"description":"NamedValue was successfully created.","headers":{"ETag":{"description":"Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"allOf":[{"description":"The Resource definition.","properties":{"id":{"description":"Resource ID.","readOnly":true,"type":"string"},"name":{"description":"Resource name.","readOnly":true,"type":"string"},"type":{"description":"Resource type for API Management resource.","readOnly":true,"type":"string"}},"x-ms-azure-resource":true}],"description":"NamedValue details.","properties":{"properties":{"allOf":[{"description":"NamedValue Entity Base Parameters set.","properties":{"secret":{"description":"Determines whether the value is a secret and should be encrypted or not. Default value is false.","type":"boolean"},"tags":{"description":"Optional tags that when provided can be used to filter the NamedValue list.","items":{"type":"string"},"maxItems":32,"type":"array"}}}],"description":"NamedValue Contract properties.","properties":{"displayName":{"description":"Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters.","maxLength":256,"minLength":1,"pattern":"^[A-Za-z0-9-._]+$","type":"string"},"value":{"description":"Value of the NamedValue. Can contain policy expressions. It may not be empty or consist only of whitespace. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.","maxLength":4096,"minLength":1,"type":"string"}},"required":["displayName"]}}},"examples":{"ApiManagementCreateNamedValue":{"$ref":"#/components/examples/ApiManagementCreateNamedValue"}}}}},"202":{"description":"Request to create or update NamedValue was accepted. Location header contains the URL where the status of the long running operation can be checked."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Error Response.","properties":{"error":{"description":"Error Body contract.","properties":{"code":{"description":"Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.","type":"string"},"details":{"description":"The list of invalid fields send in request, in case of validation error.","items":{"description":"Error Field contract.","properties":{"code":{"description":"Property level error code.","type":"string"},"message":{"description":"Human-readable representation of property-level error.","type":"string"},"target":{"description":"Property name.","type":"string"}}},"type":"array"},"message":{"description":"Human-readable representation of the error.","type":"string"}}}}}}}}},"tags":["NamedValue"],"x-ms-long-running-operation":true,"x-ms-long-running-operation-options":{"final-state-via":"location"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/namedValues/{namedValueId}/listValue":{"post":{"description":"Gets the secret value of the NamedValue.","operationId":"NamedValue_ListValue","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementListSecretsSubscription":{"value":"rg1"}}},{"description":"The name of the API Management service.","in":"path","name":"serviceName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":50,"pattern":"^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$"},"examples":{"ApiManagementListSecretsSubscription":{"value":"apimService1"}}},{"description":"Identifier of the NamedValue.","in":"path","name":"namedValueId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","maxLength":256,"pattern":"^[^*#&+:<>?]+$"},"examples":{"ApiManagementListSecretsSubscription":{"value":"testarmTemplateproperties2"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementListSecretsSubscription":{"value":"2019-12-01-preview"}}},{"description":"Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"ApiManagementListSecretsSubscription":{"value":"subid"}}}],"responses":{"200":{"description":"The response body contains secret value.","content":{"application/json":{"schema":{"description":"Client or app secret used in IdentityProviders, Aad, OpenID or OAuth.","properties":{"value":{"description":"This is secret value of the NamedValue entity.","type":"string"}}},"examples":{"ApiManagementListSecretsSubscription":{"$ref":"#/components/examples/ApiManagementListSecretsSubscription"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Error Response.","properties":{"error":{"description":"Error Body contract.","properties":{"code":{"description":"Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.","type":"string"},"details":{"description":"The list of invalid fields send in request, in case of validation error.","items":{"description":"Error Field contract.","properties":{"code":{"description":"Property level error code.","type":"string"},"message":{"description":"Human-readable representation of property-level error.","type":"string"},"target":{"description":"Property name.","type":"string"}}},"type":"array"},"message":{"description":"Human-readable representation of the error.","type":"string"}}}}}}}}},"tags":["NamedValue"]}}},"servers":[{"url":"https://management.azure.com"}],"components":{"examples":{"ApiManagementListNamedValues":{"value":{"nextLink":"","value":[{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/592f1174cc83890dc4f32686","name":"592f1174cc83890dc4f32686","properties":{"displayName":"Logger-Credentials-592f1174cc83890dc4f32687","secret":false,"value":"propValue"},"type":"Microsoft.ApiManagement/service/namedValues"},{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testarmTemplateproperties2","name":"testarmTemplateproperties2","properties":{"displayName":"propName","secret":true,"tags":["foo","bar"]},"type":"Microsoft.ApiManagement/service/namedValues"}]}},"ApiManagementGetNamedValue":{"value":{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testarmTemplateproperties2","name":"testarmTemplateproperties2","properties":{"displayName":"propName","secret":false,"tags":["foo","bar"],"value":"propValue"},"type":"Microsoft.ApiManagement/service/namedValues"}},"ApiManagementUpdateNamedValue":{"value":{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop2","properties":{"displayName":"prop3name","secret":false,"tags":["foo","bar2"],"value":"propValue"},"type":"Microsoft.ApiManagement/service/namedValues"}},"ApiManagementCreateNamedValue":{"value":{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop2","name":"testprop2","properties":{"displayName":"prop3name","secret":false,"tags":["foo","bar"],"value":"propValue"},"type":"Microsoft.ApiManagement/service/namedValues"}},"ApiManagementListSecretsSubscription":{"value":{"value":"propValue"}}},"securitySchemes":{"azure_auth":{"description":"Azure Active Directory OAuth2 Flow.","type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://login.microsoftonline.com/common/oauth2/authorize","scopes":{"user_impersonation":"impersonate your user account"}}}}}}}