Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ResourceModelWithAllowedPropertySet

Package version

The resource model definition containing the full set of allowed properties for a resource. Except properties bag, there cannot be a top level property outside of this set.

Hierarchy

  • ResourceModelWithAllowedPropertySet

Index

Properties

Optional etag

etag: undefined | string

The etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.

Optional identity

Optional kind

kind: undefined | string

Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.

Optional location

location: undefined | string

The geo-location where the resource lives

Optional managedBy

managedBy: undefined | string

The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.

Optional name

name: undefined | string

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

Optional plan

Optional sku

Optional tags

tags: undefined | {}

Resource tags.

Optional type

type: undefined | string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Generated using TypeDoc