139 строки
13 KiB
YAML
139 строки
13 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.resourcemanager.batch.models.CertificateReference"
|
|
fullName: "com.azure.resourcemanager.batch.models.CertificateReference"
|
|
name: "CertificateReference"
|
|
nameWithType: "CertificateReference"
|
|
summary: "A reference to a certificate to be installed on compute nodes in a pool."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
|
methodsRef:
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
|
syntax: "public final class **CertificateReference**"
|
|
constructors:
|
|
- uid: "com.azure.resourcemanager.batch.models.CertificateReference.CertificateReference()"
|
|
fullName: "com.azure.resourcemanager.batch.models.CertificateReference.CertificateReference()"
|
|
name: "CertificateReference()"
|
|
nameWithType: "CertificateReference.CertificateReference()"
|
|
syntax: "public CertificateReference()"
|
|
methods:
|
|
- uid: "com.azure.resourcemanager.batch.models.CertificateReference.id()"
|
|
fullName: "com.azure.resourcemanager.batch.models.CertificateReference.id()"
|
|
name: "id()"
|
|
nameWithType: "CertificateReference.id()"
|
|
summary: "Get the id property: The fully qualified ID of the certificate to install on the pool."
|
|
syntax: "public String id()"
|
|
desc: "Get the id property: The fully qualified ID of the certificate to install on the pool. This must be inside the same batch account as the pool."
|
|
returns:
|
|
description: "the id value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.resourcemanager.batch.models.CertificateReference.storeLocation()"
|
|
fullName: "com.azure.resourcemanager.batch.models.CertificateReference.storeLocation()"
|
|
name: "storeLocation()"
|
|
nameWithType: "CertificateReference.storeLocation()"
|
|
summary: "Get the store<wbr>Location property: The location of the certificate store on the compute node into which to install the certificate."
|
|
syntax: "public CertificateStoreLocation storeLocation()"
|
|
desc: "Get the storeLocation property: The location of the certificate store on the compute node into which to install the certificate. The default value is currentUser. This property is applicable only for pools configured with Windows nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows image reference). For Linux compute nodes, the certificates are stored in a directory inside the task working directory and an environment variable AZ\\_BATCH\\_CERTIFICATES\\_DIR is supplied to the task to query for this location. For certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/\\{user-name\\}/certs) and certificates are placed in that directory."
|
|
returns:
|
|
description: "the storeLocation value."
|
|
type: "<xref href=\"com.azure.resourcemanager.batch.models.CertificateStoreLocation?alt=com.azure.resourcemanager.batch.models.CertificateStoreLocation&text=CertificateStoreLocation\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.batch.models.CertificateReference.storeName()"
|
|
fullName: "com.azure.resourcemanager.batch.models.CertificateReference.storeName()"
|
|
name: "storeName()"
|
|
nameWithType: "CertificateReference.storeName()"
|
|
summary: "Get the store<wbr>Name property: The name of the certificate store on the compute node into which to install the certificate."
|
|
syntax: "public String storeName()"
|
|
desc: "Get the storeName property: The name of the certificate store on the compute node into which to install the certificate. This property is applicable only for pools configured with Windows nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows image reference). Common store names include: My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, but any custom store name can also be used. The default value is My."
|
|
returns:
|
|
description: "the storeName value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.resourcemanager.batch.models.CertificateReference.validate()"
|
|
fullName: "com.azure.resourcemanager.batch.models.CertificateReference.validate()"
|
|
name: "validate()"
|
|
nameWithType: "CertificateReference.validate()"
|
|
summary: "Validates the instance."
|
|
syntax: "public void validate()"
|
|
desc: "Validates the instance."
|
|
- uid: "com.azure.resourcemanager.batch.models.CertificateReference.visibility()"
|
|
fullName: "com.azure.resourcemanager.batch.models.CertificateReference.visibility()"
|
|
name: "visibility()"
|
|
nameWithType: "CertificateReference.visibility()"
|
|
summary: "Get the visibility property: Which user accounts on the compute node should have access to the private data of the certificate."
|
|
syntax: "public List<CertificateVisibility> visibility()"
|
|
desc: "Get the visibility property: Which user accounts on the compute node should have access to the private data of the certificate."
|
|
returns:
|
|
description: "the visibility value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.resourcemanager.batch.models.CertificateVisibility?alt=com.azure.resourcemanager.batch.models.CertificateVisibility&text=CertificateVisibility\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.resourcemanager.batch.models.CertificateReference.withId(java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.batch.models.CertificateReference.withId(String id)"
|
|
name: "withId(String id)"
|
|
nameWithType: "CertificateReference.withId(String id)"
|
|
summary: "Set the id property: The fully qualified ID of the certificate to install on the pool."
|
|
parameters:
|
|
- description: "the id value to set."
|
|
name: "id"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public CertificateReference withId(String id)"
|
|
desc: "Set the id property: The fully qualified ID of the certificate to install on the pool. This must be inside the same batch account as the pool."
|
|
returns:
|
|
description: "the CertificateReference object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.batch.models.CertificateReference?alt=com.azure.resourcemanager.batch.models.CertificateReference&text=CertificateReference\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.batch.models.CertificateReference.withStoreLocation(com.azure.resourcemanager.batch.models.CertificateStoreLocation)"
|
|
fullName: "com.azure.resourcemanager.batch.models.CertificateReference.withStoreLocation(CertificateStoreLocation storeLocation)"
|
|
name: "withStoreLocation(CertificateStoreLocation storeLocation)"
|
|
nameWithType: "CertificateReference.withStoreLocation(CertificateStoreLocation storeLocation)"
|
|
summary: "Set the store<wbr>Location property: The location of the certificate store on the compute node into which to install the certificate."
|
|
parameters:
|
|
- description: "the storeLocation value to set."
|
|
name: "storeLocation"
|
|
type: "<xref href=\"com.azure.resourcemanager.batch.models.CertificateStoreLocation?alt=com.azure.resourcemanager.batch.models.CertificateStoreLocation&text=CertificateStoreLocation\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public CertificateReference withStoreLocation(CertificateStoreLocation storeLocation)"
|
|
desc: "Set the storeLocation property: The location of the certificate store on the compute node into which to install the certificate. The default value is currentUser. This property is applicable only for pools configured with Windows nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows image reference). For Linux compute nodes, the certificates are stored in a directory inside the task working directory and an environment variable AZ\\_BATCH\\_CERTIFICATES\\_DIR is supplied to the task to query for this location. For certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/\\{user-name\\}/certs) and certificates are placed in that directory."
|
|
returns:
|
|
description: "the CertificateReference object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.batch.models.CertificateReference?alt=com.azure.resourcemanager.batch.models.CertificateReference&text=CertificateReference\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.batch.models.CertificateReference.withStoreName(java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.batch.models.CertificateReference.withStoreName(String storeName)"
|
|
name: "withStoreName(String storeName)"
|
|
nameWithType: "CertificateReference.withStoreName(String storeName)"
|
|
summary: "Set the store<wbr>Name property: The name of the certificate store on the compute node into which to install the certificate."
|
|
parameters:
|
|
- description: "the storeName value to set."
|
|
name: "storeName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public CertificateReference withStoreName(String storeName)"
|
|
desc: "Set the storeName property: The name of the certificate store on the compute node into which to install the certificate. This property is applicable only for pools configured with Windows nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows image reference). Common store names include: My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, but any custom store name can also be used. The default value is My."
|
|
returns:
|
|
description: "the CertificateReference object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.batch.models.CertificateReference?alt=com.azure.resourcemanager.batch.models.CertificateReference&text=CertificateReference\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.batch.models.CertificateReference.withVisibility(java.util.List<com.azure.resourcemanager.batch.models.CertificateVisibility>)"
|
|
fullName: "com.azure.resourcemanager.batch.models.CertificateReference.withVisibility(List<CertificateVisibility> visibility)"
|
|
name: "withVisibility(List<CertificateVisibility> visibility)"
|
|
nameWithType: "CertificateReference.withVisibility(List<CertificateVisibility> visibility)"
|
|
summary: "Set the visibility property: Which user accounts on the compute node should have access to the private data of the certificate."
|
|
parameters:
|
|
- description: "the visibility value to set."
|
|
name: "visibility"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.resourcemanager.batch.models.CertificateVisibility?alt=com.azure.resourcemanager.batch.models.CertificateVisibility&text=CertificateVisibility\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "public CertificateReference withVisibility(List<CertificateVisibility> visibility)"
|
|
desc: "Set the visibility property: Which user accounts on the compute node should have access to the private data of the certificate."
|
|
returns:
|
|
description: "the CertificateReference object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.batch.models.CertificateReference?alt=com.azure.resourcemanager.batch.models.CertificateReference&text=CertificateReference\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "A reference to a certificate to be installed on compute nodes in a pool. This must exist inside the same account as the pool."
|
|
metadata: {}
|
|
package: "com.azure.resourcemanager.batch.models"
|
|
artifact: com.azure.resourcemanager:azure-resourcemanager-batch:1.0.0
|