Package com.azure.resourcemanager.deviceprovisioningservices.models

Interface ProvisioningServiceDescription

public interface ProvisioningServiceDescription

An immutable client-side representation of ProvisioningServiceDescription.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ProvisioningServiceDescription.Definition	The entirety of the ProvisioningServiceDescription definition.
static interface	ProvisioningServiceDescription.DefinitionStages	The ProvisioningServiceDescription definition stages.
static interface	ProvisioningServiceDescription.Update	The template for ProvisioningServiceDescription update.
static interface	ProvisioningServiceDescription.UpdateStages	The ProvisioningServiceDescription update stages.

Method Summary

Modifier and Type	Method	Description
String	etag()	Gets the etag property: The Etag field is *not* required.
String	id()	Gets the id property: Fully qualified resource Id for the resource.
ProvisioningServiceDescriptionInner	innerModel()	Gets the inner com.azure.resourcemanager.deviceprovisioningservices.fluent.models.ProvisioningServiceDescriptionInner object.
com.azure.core.http.rest.PagedIterable<SharedAccessSignatureAuthorizationRule>	listKeys()	List the primary and secondary keys for a provisioning service.
com.azure.core.http.rest.PagedIterable<SharedAccessSignatureAuthorizationRule>	listKeys(com.azure.core.util.Context context)	List the primary and secondary keys for a provisioning service.
String	location()	Gets the location property: The geo-location where the resource lives.
String	name()	Gets the name property: The name of the resource.
IotDpsPropertiesDescription	properties()	Gets the properties property: Service specific properties for a provisioning service.
ProvisioningServiceDescription	refresh()	Refreshes the resource to sync with Azure.
ProvisioningServiceDescription	refresh(com.azure.core.util.Context context)	Refreshes the resource to sync with Azure.
com.azure.core.management.Region	region()	Gets the region of the resource.
String	regionName()	Gets the name of the resource region.
IotDpsSkuInfo	sku()	Gets the sku property: Sku info for a provisioning Service.
com.azure.core.management.SystemData	systemData()	Gets the systemData property: Metadata pertaining to creation and last modification of the resource.
Map<String,String>	tags()	Gets the tags property: Resource tags.
String	type()	Gets the type property: The type of the resource.
ProvisioningServiceDescription.Update	update()	Begins update for the ProvisioningServiceDescription resource.

Method Detail

id

String id()

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

Returns:

the id value.

name

String name()

Gets the name property: The name of the resource.

Returns:

the name value.

type

String type()

Gets the type property: The type of the resource.

Returns:

the type value.

location

String location()

Gets the location property: The geo-location where the resource lives.

Returns:

the location value.

tags

Map<String,String> tags()

Gets the tags property: Resource tags.

Returns:

the tags value.

etag

String etag()

Gets 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.

Returns:

the etag value.

properties

IotDpsPropertiesDescription properties()

Gets the properties property: Service specific properties for a provisioning service.

Returns:

the properties value.

sku

IotDpsSkuInfo sku()

Gets the sku property: Sku info for a provisioning Service.

Returns:

the sku value.

systemData

com.azure.core.management.SystemData systemData()

Gets the systemData property: Metadata pertaining to creation and last modification of the resource.

Returns:

the systemData value.

region

com.azure.core.management.Region region()

Gets the region of the resource.

Returns:

the region of the resource.

regionName

String regionName()

Gets the name of the resource region.

Returns:

the name of the resource region.

innerModel

ProvisioningServiceDescriptionInner innerModel()

Gets the inner com.azure.resourcemanager.deviceprovisioningservices.fluent.models.ProvisioningServiceDescriptionInner object.

Returns:

the inner object.

update

ProvisioningServiceDescription.Update update()

Begins update for the ProvisioningServiceDescription resource.

Returns:

the stage of resource update.

refresh

ProvisioningServiceDescription refresh()

Refreshes the resource to sync with Azure.

Returns:

the refreshed resource.

refresh

ProvisioningServiceDescription refresh(com.azure.core.util.Context context)

Refreshes the resource to sync with Azure.

Parameters:

context - The context to associate with this operation.

Returns:

the refreshed resource.

listKeys

com.azure.core.http.rest.PagedIterable<SharedAccessSignatureAuthorizationRule> listKeys()

List the primary and secondary keys for a provisioning service.

Returns:

list of shared access keys.

Throws:

ErrorDetailsException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listKeys

com.azure.core.http.rest.PagedIterable<SharedAccessSignatureAuthorizationRule> listKeys(com.azure.core.util.Context context)

List the primary and secondary keys for a provisioning service.

Parameters:

context - The context to associate with this operation.

Returns:

list of shared access keys.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ErrorDetailsException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.