Skip to main content

WebAppPrivateEndpointConnection

Provides a WebAppPrivateEndpointConnection from the Web group

Examples​

Approves or rejects a private endpoint connection for a site.​

exports.createResources = () => [
  {
    type: "WebAppPrivateEndpointConnection",
    group: "Web",
    name: "myWebAppPrivateEndpointConnection",
    properties: () => ({
      properties: {
        privateLinkServiceConnectionState: {
          status: "Approved",
          description: "Approved by admin.",
          actionsRequired: "",
        },
      },
    }),
    dependencies: ({}) => ({
      resourceGroup: "myResourceGroup",
      name: "myWebApp",
    }),
  },
];

Dependencies​

Swagger Schema​

{
  description: 'Private Endpoint Connection Approval ARM resource.',
  type: 'object',
  allOf: [
    {
      description: 'Azure proxy only resource. This resource is not tracked by Azure Resource Manager.',
      type: 'object',
      properties: {
        id: { description: 'Resource Id.', type: 'string', readOnly: true },
        name: {
          description: 'Resource Name.',
          type: 'string',
          readOnly: true
        },
        kind: { description: 'Kind of resource.', type: 'string' },
        type: {
          description: 'Resource type.',
          type: 'string',
          readOnly: true
        }
      },
      'x-ms-azure-resource': true
    }
  ],
  properties: {
    properties: {
      description: 'Core resource properties',
      type: 'object',
      'x-ms-client-flatten': true,
      properties: {
        privateLinkServiceConnectionState: {
          description: 'The state of a private link connection',
          type: 'object',
          properties: {
            status: {
              description: 'Status of a private link connection',
              type: 'string'
            },
            description: {
              description: 'Description of a private link connection',
              type: 'string'
            },
            actionsRequired: {
              description: 'ActionsRequired for a private link connection',
              type: 'string'
            }
          }
        }
      }
    }
  }
}

Misc​

The resource version is 2022-03-01.

The Swagger schema used to generate this documentation can be found here.