ResourceModelWithAllowedPropertySet Class

public class ResourceModelWithAllowedPropertySet
extends Resource

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.

Constructor Summary

Constructor Description
ResourceModelWithAllowedPropertySet()

Creates an instance of ResourceModelWithAllowedPropertySet class.

Method Summary

Modifier and Type Method and Description
String etag()

Get the etag property: The etag field is *not* required.

static ResourceModelWithAllowedPropertySet fromJson(JsonReader jsonReader)

Reads an instance of ResourceModelWithAllowedPropertySet from the JsonReader.

String id()

Get the id property: Fully qualified resource Id for the resource.

ResourceModelWithAllowedPropertySetIdentity identity()

Get the identity property: The identity property.

String kind()

Get the kind property: Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.

String managedBy()

Get the managedBy property: The fully qualified resource ID of the resource that manages this resource.

String name()

Get the name property: The name of the resource.

ResourceModelWithAllowedPropertySetPlan plan()

Get the plan property: The plan property.

ResourceModelWithAllowedPropertySetSku sku()

Get the sku property: The sku property.

SystemData systemData()

Get the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.

JsonWriter toJson(JsonWriter jsonWriter)
String type()

Get the type property: The type of the resource.

void validate()

Validates the instance.

ResourceModelWithAllowedPropertySet withIdentity(ResourceModelWithAllowedPropertySetIdentity identity)

Set the identity property: The identity property.

ResourceModelWithAllowedPropertySet withKind(String kind)

Set the kind property: Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.

ResourceModelWithAllowedPropertySet withLocation(String location)
ResourceModelWithAllowedPropertySet withManagedBy(String managedBy)

Set the managedBy property: The fully qualified resource ID of the resource that manages this resource.

ResourceModelWithAllowedPropertySet withPlan(ResourceModelWithAllowedPropertySetPlan plan)

Set the plan property: The plan property.

ResourceModelWithAllowedPropertySet withSku(ResourceModelWithAllowedPropertySetSku sku)

Set the sku property: The sku property.

ResourceModelWithAllowedPropertySet withTags(Map<String,String> tags)

Methods inherited from ProxyResource

Methods inherited from Resource

Methods inherited from java.lang.Object

Constructor Details

ResourceModelWithAllowedPropertySet

public ResourceModelWithAllowedPropertySet()

Creates an instance of ResourceModelWithAllowedPropertySet class.

Method Details

etag

public String etag()

Get the etag property: 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.

Returns:

the etag value.

fromJson

public static ResourceModelWithAllowedPropertySet fromJson(JsonReader jsonReader)

Reads an instance of ResourceModelWithAllowedPropertySet from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of ResourceModelWithAllowedPropertySet if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If the deserialized JSON object was missing any required properties.

id

public String id()

Get the id property: Fully qualified resource Id for the resource.

Overrides:

ResourceModelWithAllowedPropertySet.id()

Returns:

the id value.

identity

public ResourceModelWithAllowedPropertySetIdentity identity()

Get the identity property: The identity property.

Returns:

the identity value.

kind

public String kind()

Get the kind property: 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.

Returns:

the kind value.

managedBy

public String managedBy()

Get the managedBy property: 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.

Returns:

the managedBy value.

name

public String name()

Get the name property: The name of the resource.

Overrides:

ResourceModelWithAllowedPropertySet.name()

Returns:

the name value.

plan

public ResourceModelWithAllowedPropertySetPlan plan()

Get the plan property: The plan property.

Returns:

the plan value.

sku

public ResourceModelWithAllowedPropertySetSku sku()

Get the sku property: The sku property.

Returns:

the sku value.

systemData

public SystemData systemData()

Get the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.

Returns:

the systemData value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

ResourceModelWithAllowedPropertySet.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

type

public String type()

Get the type property: The type of the resource.

Overrides:

ResourceModelWithAllowedPropertySet.type()

Returns:

the type value.

validate

public void validate()

Validates the instance.

withIdentity

public ResourceModelWithAllowedPropertySet withIdentity(ResourceModelWithAllowedPropertySetIdentity identity)

Set the identity property: The identity property.

Parameters:

identity - the identity value to set.

Returns:

the ResourceModelWithAllowedPropertySet object itself.

withKind

public ResourceModelWithAllowedPropertySet withKind(String kind)

Set the kind property: 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.

Parameters:

kind - the kind value to set.

Returns:

the ResourceModelWithAllowedPropertySet object itself.

withLocation

public ResourceModelWithAllowedPropertySet withLocation(String location)

Overrides:

ResourceModelWithAllowedPropertySet.withLocation(String location)

Parameters:

location

withManagedBy

public ResourceModelWithAllowedPropertySet withManagedBy(String managedBy)

Set the managedBy property: 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.

Parameters:

managedBy - the managedBy value to set.

Returns:

the ResourceModelWithAllowedPropertySet object itself.

withPlan

public ResourceModelWithAllowedPropertySet withPlan(ResourceModelWithAllowedPropertySetPlan plan)

Set the plan property: The plan property.

Parameters:

plan - the plan value to set.

Returns:

the ResourceModelWithAllowedPropertySet object itself.

withSku

public ResourceModelWithAllowedPropertySet withSku(ResourceModelWithAllowedPropertySetSku sku)

Set the sku property: The sku property.

Parameters:

sku - the sku value to set.

Returns:

the ResourceModelWithAllowedPropertySet object itself.

withTags

public ResourceModelWithAllowedPropertySet withTags(Map<String,String> tags)

Overrides:

ResourceModelWithAllowedPropertySet.withTags(Map<String,String> tags)

Parameters:

tags

Applies to