### YamlMime:JavaType
uid: "com.azure.resourcemanager.compute.models.Plan"
fullName: "com.azure.resourcemanager.compute.models.Plan"
name: "Plan"
nameWithType: "Plan"
summary: "Specifies information about the marketplace image used to create the virtual machine."
inheritances:
- ""
inheritedClassMethods:
- classRef: "java.lang.Object"
methodsRef:
- "clone"
- "equals"
- "finalize"
- "getClass"
- "hashCode"
- "notify"
- "notifyAll"
- "toString"
- "wait"
- "wait"
- "wait"
syntax: "public final class **Plan** implements <>"
constructors:
- uid: "com.azure.resourcemanager.compute.models.Plan.Plan()"
fullName: "com.azure.resourcemanager.compute.models.Plan.Plan()"
name: "Plan()"
nameWithType: "Plan.Plan()"
summary: "Creates an instance of Plan class."
syntax: "public Plan()"
desc: "Creates an instance of Plan class."
methods:
- uid: "com.azure.resourcemanager.compute.models.Plan.fromJson(com.azure.json.JsonReader)"
fullName: "com.azure.resourcemanager.compute.models.Plan.fromJson(JsonReader jsonReader)"
name: "fromJson(JsonReader jsonReader)"
nameWithType: "Plan.fromJson(JsonReader jsonReader)"
summary: "Reads an instance of Plan from the JsonReader."
modifiers:
- "static"
parameters:
- description: "The JsonReader being read."
name: "jsonReader"
type: ""
syntax: "public static Plan fromJson(JsonReader jsonReader)"
exceptions:
- description: "If an error occurs while reading the Plan."
type: "IOException"
desc: "Reads an instance of Plan from the JsonReader."
returns:
description: "An instance of Plan if the JsonReader was pointing to an instance of it, or null if it was pointing to\n JSON null."
type: ""
- uid: "com.azure.resourcemanager.compute.models.Plan.name()"
fullName: "com.azure.resourcemanager.compute.models.Plan.name()"
name: "name()"
nameWithType: "Plan.name()"
summary: "Get the name property: The plan ID."
syntax: "public String name()"
desc: "Get the name property: The plan ID."
returns:
description: "the name value."
type: "String"
- uid: "com.azure.resourcemanager.compute.models.Plan.product()"
fullName: "com.azure.resourcemanager.compute.models.Plan.product()"
name: "product()"
nameWithType: "Plan.product()"
summary: "Get the product property: Specifies the product of the image from the marketplace."
syntax: "public String product()"
desc: "Get the product property: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element."
returns:
description: "the product value."
type: "String"
- uid: "com.azure.resourcemanager.compute.models.Plan.promotionCode()"
fullName: "com.azure.resourcemanager.compute.models.Plan.promotionCode()"
name: "promotionCode()"
nameWithType: "Plan.promotionCode()"
summary: "Get the promotionCode property: The promotion code."
syntax: "public String promotionCode()"
desc: "Get the promotionCode property: The promotion code."
returns:
description: "the promotionCode value."
type: "String"
- uid: "com.azure.resourcemanager.compute.models.Plan.publisher()"
fullName: "com.azure.resourcemanager.compute.models.Plan.publisher()"
name: "publisher()"
nameWithType: "Plan.publisher()"
summary: "Get the publisher property: The publisher ID."
syntax: "public String publisher()"
desc: "Get the publisher property: The publisher ID."
returns:
description: "the publisher value."
type: "String"
- uid: "com.azure.resourcemanager.compute.models.Plan.toJson(com.azure.json.JsonWriter)"
fullName: "com.azure.resourcemanager.compute.models.Plan.toJson(JsonWriter jsonWriter)"
name: "toJson(JsonWriter jsonWriter)"
nameWithType: "Plan.toJson(JsonWriter jsonWriter)"
parameters:
- name: "jsonWriter"
type: ""
syntax: "public JsonWriter toJson(JsonWriter jsonWriter)"
exceptions:
- type: "IOException"
returns:
type: ""
- uid: "com.azure.resourcemanager.compute.models.Plan.validate()"
fullName: "com.azure.resourcemanager.compute.models.Plan.validate()"
name: "validate()"
nameWithType: "Plan.validate()"
summary: "Validates the instance."
syntax: "public void validate()"
desc: "Validates the instance."
- uid: "com.azure.resourcemanager.compute.models.Plan.withName(java.lang.String)"
fullName: "com.azure.resourcemanager.compute.models.Plan.withName(String name)"
name: "withName(String name)"
nameWithType: "Plan.withName(String name)"
summary: "Set the name property: The plan ID."
parameters:
- description: "the name value to set."
name: "name"
type: "String"
syntax: "public Plan withName(String name)"
desc: "Set the name property: The plan ID."
returns:
description: "the Plan object itself."
type: ""
- uid: "com.azure.resourcemanager.compute.models.Plan.withProduct(java.lang.String)"
fullName: "com.azure.resourcemanager.compute.models.Plan.withProduct(String product)"
name: "withProduct(String product)"
nameWithType: "Plan.withProduct(String product)"
summary: "Set the product property: Specifies the product of the image from the marketplace."
parameters:
- description: "the product value to set."
name: "product"
type: "String"
syntax: "public Plan withProduct(String product)"
desc: "Set the product property: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element."
returns:
description: "the Plan object itself."
type: ""
- uid: "com.azure.resourcemanager.compute.models.Plan.withPromotionCode(java.lang.String)"
fullName: "com.azure.resourcemanager.compute.models.Plan.withPromotionCode(String promotionCode)"
name: "withPromotionCode(String promotionCode)"
nameWithType: "Plan.withPromotionCode(String promotionCode)"
summary: "Set the promotionCode property: The promotion code."
parameters:
- description: "the promotionCode value to set."
name: "promotionCode"
type: "String"
syntax: "public Plan withPromotionCode(String promotionCode)"
desc: "Set the promotionCode property: The promotion code."
returns:
description: "the Plan object itself."
type: ""
- uid: "com.azure.resourcemanager.compute.models.Plan.withPublisher(java.lang.String)"
fullName: "com.azure.resourcemanager.compute.models.Plan.withPublisher(String publisher)"
name: "withPublisher(String publisher)"
nameWithType: "Plan.withPublisher(String publisher)"
summary: "Set the publisher property: The publisher ID."
parameters:
- description: "the publisher value to set."
name: "publisher"
type: "String"
syntax: "public Plan withPublisher(String publisher)"
desc: "Set the publisher property: The publisher ID."
returns:
description: "the Plan object itself."
type: ""
type: "class"
desc: "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click \\*\\*Want to deploy programmatically, Get Started ->\\*\\*. Enter any required information and then click \\*\\*Save\\*\\*."
implements:
- "<>"
metadata: {}
package: "com.azure.resourcemanager.compute.models"
artifact: com.azure.resourcemanager:azure-resourcemanager-compute:2.44.0