Microsoft.ApiManagement service/apis/operations 2016-07-07

• Latest
• 2024-06-01-preview
• 2024-05-01
• 2023-09-01-preview
• 2023-05-01-preview
• 2023-03-01-preview
• 2022-09-01-preview
• 2022-08-01
• 2022-04-01-preview
• 2021-12-01-preview
• 2021-08-01
• 2021-04-01-preview
• 2021-01-01-preview
• 2020-12-01
• 2020-06-01-preview
• 2019-12-01
• 2019-12-01-preview
• 2019-01-01
• 2018-06-01-preview
• 2018-01-01
• 2017-03-01
• 2016-10-10
• 2016-07-07

Bicep resource definition

The service/apis/operations resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.ApiManagement/service/apis/operations resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.ApiManagement/service/apis/operations@2016-07-07' = {
  parent: resourceSymbolicName
  description: 'string'
  method: 'string'
  name: 'string'
  request: {
    description: 'string'
    headers: [
      {
        defaultValue: 'string'
        description: 'string'
        name: 'string'
        required: bool
        type: 'string'
        values: [
          'string'
        ]
      }
    ]
    queryParameters: [
      {
        defaultValue: 'string'
        description: 'string'
        name: 'string'
        required: bool
        type: 'string'
        values: [
          'string'
        ]
      }
    ]
    representations: [
      {
        contentType: 'string'
        sample: 'string'
      }
    ]
  }
  responses: [
    {
      description: 'string'
      representations: [
        {
          contentType: 'string'
          sample: 'string'
        }
      ]
      statusCode: int
    }
  ]
  templateParameters: [
    {
      defaultValue: 'string'
      description: 'string'
      name: 'string'
      required: bool
      type: 'string'
      values: [
        'string'
      ]
    }
  ]
  urlTemplate: 'string'
}

Property values

Microsoft.ApiManagement/service/apis/operations

Name	Description	Value
description	Description of the operation. May include HTML formatting tags.	string Constraints: Max length =
method	A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.	string (required)
name	The resource name	string Constraints: Min length = 1 Max length = 1 Pattern = ^[^*#&+:<>?]+$ (required)
parent	In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource.	Symbolic name for resource of type: service/apis
request	An entity containing request details.	RequestContract
responses	Array of Operation responses.	ResultContract[]
templateParameters	Collection of URL template parameters.	ParameterContract[]
urlTemplate	Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}	string Constraints: Min length = 1 Max length = 1 (required)

ParameterContract

Name	Description	Value
defaultValue	Default parameter value.	string
description	Parameter description.	string
name	Parameter name.	string (required)
required	whether parameter is required or not.	bool
type	Parameter type.	string (required)
values	Parameter values.	string[]

RepresentationContract

Name	Description	Value
contentType	Specifies a registered or custom content type for this representation, e.g. application/xml.	string (required)
sample	An example of the representation.	string

RequestContract

Name	Description	Value
description	Operation request description.	string
headers	Collection of operation request headers.	ParameterContract[]
queryParameters	Collection of operation request query parameters.	ParameterContract[]
representations	Collection of operation request representations.	RepresentationContract[]

ResultContract

Name	Description	Value
description	Operation response description.	string
representations	Collection of operation response representations.	RepresentationContract[]
statusCode	Operation response HTTP status code.	int Constraints: Min value = 100 Max value = 599 (required)

ARM template resource definition

The service/apis/operations resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.ApiManagement/service/apis/operations resource, add the following JSON to your template.

{
  "type": "Microsoft.ApiManagement/service/apis/operations",
  "apiVersion": "2016-07-07",
  "name": "string",
  "description": "string",
  "method": "string",
  "request": {
    "description": "string",
    "headers": [
      {
        "defaultValue": "string",
        "description": "string",
        "name": "string",
        "required": "bool",
        "type": "string",
        "values": [ "string" ]
      }
    ],
    "queryParameters": [
      {
        "defaultValue": "string",
        "description": "string",
        "name": "string",
        "required": "bool",
        "type": "string",
        "values": [ "string" ]
      }
    ],
    "representations": [
      {
        "contentType": "string",
        "sample": "string"
      }
    ]
  },
  "responses": [
    {
      "description": "string",
      "representations": [
        {
          "contentType": "string",
          "sample": "string"
        }
      ],
      "statusCode": "int"
    }
  ],
  "templateParameters": [
    {
      "defaultValue": "string",
      "description": "string",
      "name": "string",
      "required": "bool",
      "type": "string",
      "values": [ "string" ]
    }
  ],
  "urlTemplate": "string"
}

Property values

Microsoft.ApiManagement/service/apis/operations

Name	Description	Value
apiVersion	The api version	'2016-07-07'
description	Description of the operation. May include HTML formatting tags.	string Constraints: Max length =
method	A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.	string (required)
name	The resource name	string Constraints: Min length = 1 Max length = 1 Pattern = ^[^*#&+:<>?]+$ (required)
request	An entity containing request details.	RequestContract
responses	Array of Operation responses.	ResultContract[]
templateParameters	Collection of URL template parameters.	ParameterContract[]
type	The resource type	'Microsoft.ApiManagement/service/apis/operations'
urlTemplate	Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}	string Constraints: Min length = 1 Max length = 1 (required)

ParameterContract

Name	Description	Value
defaultValue	Default parameter value.	string
description	Parameter description.	string
name	Parameter name.	string (required)
required	whether parameter is required or not.	bool
type	Parameter type.	string (required)
values	Parameter values.	string[]

RepresentationContract

Name	Description	Value
contentType	Specifies a registered or custom content type for this representation, e.g. application/xml.	string (required)
sample	An example of the representation.	string

RequestContract

Name	Description	Value
description	Operation request description.	string
headers	Collection of operation request headers.	ParameterContract[]
queryParameters	Collection of operation request query parameters.	ParameterContract[]
representations	Collection of operation request representations.	RepresentationContract[]

ResultContract

Name	Description	Value
description	Operation response description.	string
representations	Collection of operation response representations.	RepresentationContract[]
statusCode	Operation response HTTP status code.	int Constraints: Min value = 100 Max value = 599 (required)

Terraform (AzAPI provider) resource definition

The service/apis/operations resource type can be deployed with operations that target:

• Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.ApiManagement/service/apis/operations resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/apis/operations@2016-07-07"
  name = "string"
  description = "string"
  method = "string"
  request = {
    description = "string"
    headers = [
      {
        defaultValue = "string"
        description = "string"
        name = "string"
        required = bool
        type = "string"
        values = [
          "string"
        ]
      }
    ]
    queryParameters = [
      {
        defaultValue = "string"
        description = "string"
        name = "string"
        required = bool
        type = "string"
        values = [
          "string"
        ]
      }
    ]
    representations = [
      {
        contentType = "string"
        sample = "string"
      }
    ]
  }
  responses = [
    {
      description = "string"
      representations = [
        {
          contentType = "string"
          sample = "string"
        }
      ]
      statusCode = int
    }
  ]
  templateParameters = [
    {
      defaultValue = "string"
      description = "string"
      name = "string"
      required = bool
      type = "string"
      values = [
        "string"
      ]
    }
  ]
  urlTemplate = "string"
}

Property values

Microsoft.ApiManagement/service/apis/operations

Name	Description	Value
description	Description of the operation. May include HTML formatting tags.	string Constraints: Max length =
method	A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.	string (required)
name	The resource name	string Constraints: Min length = 1 Max length = 1 Pattern = ^[^*#&+:<>?]+$ (required)
parent_id	The ID of the resource that is the parent for this resource.	ID for resource of type: service/apis
request	An entity containing request details.	RequestContract
responses	Array of Operation responses.	ResultContract[]
templateParameters	Collection of URL template parameters.	ParameterContract[]
type	The resource type	"Microsoft.ApiManagement/service/apis/operations@2016-07-07"
urlTemplate	Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}	string Constraints: Min length = 1 Max length = 1 (required)

ParameterContract

Name	Description	Value
defaultValue	Default parameter value.	string
description	Parameter description.	string
name	Parameter name.	string (required)
required	whether parameter is required or not.	bool
type	Parameter type.	string (required)
values	Parameter values.	string[]

RepresentationContract

Name	Description	Value
contentType	Specifies a registered or custom content type for this representation, e.g. application/xml.	string (required)
sample	An example of the representation.	string

RequestContract

Name	Description	Value
description	Operation request description.	string
headers	Collection of operation request headers.	ParameterContract[]
queryParameters	Collection of operation request query parameters.	ParameterContract[]
representations	Collection of operation request representations.	RepresentationContract[]

ResultContract

Name	Description	Value
description	Operation response description.	string
representations	Collection of operation response representations.	RepresentationContract[]
statusCode	Operation response HTTP status code.	int Constraints: Min value = 100 Max value = 599 (required)